This product is not supported for your selected Datadog site. ().

gcp_apigee_organization

addons_config

Type: STRUCT
Provider name: addonsConfig
Description: Optional. Addon configurations of the Apigee organization.

  • advanced_api_ops_config
    Type: STRUCT
    Provider name: advancedApiOpsConfig
    Description: Configuration for the Advanced API Ops add-on.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: Flag that specifies whether the Advanced API Ops add-on is enabled.
  • analytics_config
    Type: STRUCT
    Provider name: analyticsConfig
    Description: Configuration for the Analytics add-on. Only used in organizations.environments.addonsConfig.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: Whether the Analytics add-on is enabled.
    • expire_time_millis
      Type: INT64
      Provider name: expireTimeMillis
      Description: Output only. Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
    • state
      Type: STRING
      Provider name: state
      Description: Output only. The state of the Analytics add-on.
      Possible values:
      • ADDON_STATE_UNSPECIFIED - Default value.
      • ENABLING - Add-on is in progress of enabling.
      • ENABLED - Add-on is fully enabled and ready to use.
      • DISABLING - Add-on is in progress of disabling.
      • DISABLED - Add-on is fully disabled.
    • update_time
      Type: TIMESTAMP
      Provider name: updateTime
      Description: Output only. The latest update time.
  • api_security_config
    Type: STRUCT
    Provider name: apiSecurityConfig
    Description: Configuration for the API Security add-on.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: Flag that specifies whether the API security add-on is enabled.
    • expires_at
      Type: INT64
      Provider name: expiresAt
      Description: Output only. Time at which the API Security add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
  • connectors_platform_config
    Type: STRUCT
    Provider name: connectorsPlatformConfig
    Description: Configuration for the Connectors Platform add-on.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: Flag that specifies whether the Connectors Platform add-on is enabled.
    • expires_at
      Type: INT64
      Provider name: expiresAt
      Description: Output only. Time at which the Connectors Platform add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
  • integration_config
    Type: STRUCT
    Provider name: integrationConfig
    Description: Configuration for the Integration add-on.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: Flag that specifies whether the Integration add-on is enabled.
  • monetization_config
    Type: STRUCT
    Provider name: monetizationConfig
    Description: Configuration for the Monetization add-on.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: Flag that specifies whether the Monetization add-on is enabled.

analytics_region

Type: STRING
Provider name: analyticsRegion
Description: Required. DEPRECATED: This field will eventually be deprecated and replaced with a differently-named field. Primary Google Cloud region for analytics data storage. For valid values, see Create an Apigee organization.

ancestors

Type: UNORDERED_LIST_STRING

api_consumer_data_encryption_key_name

Type: STRING
Provider name: apiConsumerDataEncryptionKeyName
Description: Optional. Cloud KMS key name used for encrypting API consumer data. If not specified or BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

api_consumer_data_location

Type: STRING
Provider name: apiConsumerDataLocation
Description: Optional. This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: “us-west1” when control plane is in US or “europe-west2” when control plane is in EU.

apigee_project_id

Type: STRING
Provider name: apigeeProjectId
Description: Output only. Apigee Project ID associated with the organization. Use this project to allowlist Apigee in the Service Attachment when using private service connect with Apigee.

attributes

Type: UNORDERED_LIST_STRING
Provider name: attributes
Description: Not used by Apigee.

authorized_network

Type: STRING
Provider name: authorizedNetwork
Description: Optional. Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See Getting started with the Service Networking API. Valid only when RuntimeType is set to CLOUD. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: default. When changing authorizedNetwork, you must reconfigure VPC peering. After VPC peering with previous network is deleted, run the following command: gcloud services vpc-peerings delete --network=NETWORK, where NETWORK is the name of the previous network. This will delete the previous Service Networking. Otherwise, you will get the following error: The resource 'projects/...-tp' is already linked to another shared VPC host 'projects/...-tp. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See Shared VPC overview. To use a shared VPC network, use the following format: projects/{host-project-id}/{region}/networks/{network-name}. For example: projects/my-sharedvpc-host/global/networks/mynetwork Note: Not supported for Apigee hybrid.

billing_type

Type: STRING
Provider name: billingType
Description: Optional. Billing type of the Apigee organization. See Apigee pricing.
Possible values:

  • BILLING_TYPE_UNSPECIFIED - Billing type not specified.
  • SUBSCRIPTION - A pre-paid subscription to Apigee.
  • EVALUATION - Free and limited access to Apigee for evaluation purposes only.
  • PAYG - Access to Apigee using a Pay-As-You-Go plan.

control_plane_encryption_key_name

Type: STRING
Provider name: controlPlaneEncryptionKeyName
Description: Optional. Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region “US” or “EU”. If not specified or BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

created_at

Type: INT64
Provider name: createdAt
Description: Output only. Time that the Apigee organization was created in milliseconds since epoch.

customer_name

Type: STRING
Provider name: customerName
Description: Not used by Apigee.

description

Type: STRING
Provider name: description
Description: Optional. Description of the Apigee organization.

disable_vpc_peering

Type: BOOLEAN
Provider name: disableVpcPeering
Description: Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. Note: Apigee will be deprecating the vpc peering model that requires you to provide ‘authorizedNetwork’, by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid.

environments

Type: UNORDERED_LIST_STRING
Provider name: environments
Description: Output only. List of environments in the Apigee organization.

expires_at

Type: INT64
Provider name: expiresAt
Description: Output only. Time that the Apigee organization is scheduled for deletion.

gcp_display_name

Type: STRING
Provider name: displayName
Description: Optional. Display name for the Apigee organization. Unused, but reserved for future use.

labels

Type: UNORDERED_LIST_STRING

last_modified_at

Type: INT64
Provider name: lastModifiedAt
Description: Output only. Time that the Apigee organization was last modified in milliseconds since epoch.

name

Type: STRING
Provider name: name
Description: Output only. Name of the Apigee organization.

network_egress_restricted

Type: BOOLEAN
Provider name: networkEgressRestricted
Description: Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is CLOUD and disable_vpc_peering is true.

organization_id

Type: STRING

parent

Type: STRING

portal_disabled

Type: BOOLEAN
Provider name: portalDisabled
Description: Optional. Configuration for the Portals settings.

project_id

Type: STRING

project_number

Type: STRING

properties

Type: STRUCT
Provider name: properties
Description: Optional. Properties defined in the Apigee organization profile.

  • property
    Type: UNORDERED_LIST_STRUCT
    Provider name: property
    Description: List of all properties in the object
    • name
      Type: STRING
      Provider name: name
      Description: The property key
    • value
      Type: STRING
      Provider name: value
      Description: The property value

resource_name

Type: STRING

runtime_database_encryption_key_name

Type: STRING
Provider name: runtimeDatabaseEncryptionKeyName
Description: Optional. Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. If not specified or RuntimeType is TRIAL, a Google-Managed encryption key will be used. For example: “projects/foo/locations/us/keyRings/bar/cryptoKeys/baz”. Note: Not supported for Apigee hybrid.

runtime_type

Type: STRING
Provider name: runtimeType
Description: Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.
Possible values:

  • RUNTIME_TYPE_UNSPECIFIED - Runtime type not specified.
  • CLOUD - Google-managed Apigee runtime.
  • HYBRID - User-managed Apigee hybrid runtime.

state

Type: STRING
Provider name: state
Description: Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use.
Possible values:

  • STATE_UNSPECIFIED - Resource is in an unspecified state.
  • CREATING - Resource is being created.
  • ACTIVE - Resource is provisioned and ready to use.
  • DELETING - The resource is being deleted.
  • UPDATING - The resource is being updated.

subscription_plan

Type: STRING
Provider name: subscriptionPlan
Description: Output only. Subscription plan that the customer has purchased. Output only.
Possible values:

  • SUBSCRIPTION_PLAN_UNSPECIFIED - Subscription plan not specified.
  • SUBSCRIPTION_2021 - Traditional subscription plan.
  • SUBSCRIPTION_2024 - New subscription plan that provides standard proxy and scaled proxy implementation.

subscription_type

Type: STRING
Provider name: subscriptionType
Description: Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See Apigee pricing.
Possible values:

  • SUBSCRIPTION_TYPE_UNSPECIFIED - Subscription type not specified.
  • PAID - Full subscription to Apigee has been purchased.
  • TRIAL - Subscription to Apigee is free, limited, and used for evaluation purposes only.

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: type
Description: Not used by Apigee.
Possible values:

  • TYPE_UNSPECIFIED - Subscription type not specified.
  • TYPE_TRIAL - Subscription to Apigee is free, limited, and used for evaluation purposes only.
  • TYPE_PAID - Full subscription to Apigee has been purchased. See Apigee pricing.
  • TYPE_INTERNAL - For internal users only.