Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.apigee/v1.getOrganization
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets the profile for an Apigee organization. See Understanding organizations.
Using getOrganization
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getOrganization(args: GetOrganizationArgs, opts?: InvokeOptions): Promise<GetOrganizationResult>
function getOrganizationOutput(args: GetOrganizationOutputArgs, opts?: InvokeOptions): Output<GetOrganizationResult>def get_organization(organization_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOrganizationResult
def get_organization_output(organization_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationResult]func LookupOrganization(ctx *Context, args *LookupOrganizationArgs, opts ...InvokeOption) (*LookupOrganizationResult, error)
func LookupOrganizationOutput(ctx *Context, args *LookupOrganizationOutputArgs, opts ...InvokeOption) LookupOrganizationResultOutput> Note: This function is named LookupOrganization in the Go SDK.
public static class GetOrganization 
{
    public static Task<GetOrganizationResult> InvokeAsync(GetOrganizationArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationResult> Invoke(GetOrganizationInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)
public static Output<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)
fn::invoke:
  function: google-native:apigee/v1:getOrganization
  arguments:
    # arguments dictionaryThe following arguments are supported:
- OrganizationId string
- OrganizationId string
- organizationId String
- organizationId string
- organization_id str
- organizationId String
getOrganization Result
The following output properties are available:
- AddonsConfig Pulumi.Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Addons Config Response 
- Addon configurations of the Apigee organization.
- AnalyticsRegion string
- 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.
- ApiConsumer stringData Encryption Key Name 
- Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType isEVALUATIONor the region is not US/EU, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- ApiConsumer stringData Location 
- This field is needed only for customers with control plane in US or EU. 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.
- ApigeeProject stringId 
- 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 List<string>
- Not used by Apigee.
- string
- 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. 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/mynetworkNote: Not supported for Apigee hybrid.
- BillingType string
- Billing type of the Apigee organization. See Apigee pricing.
- CaCertificate string
- Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.
- ControlPlane stringEncryption Key Name 
- Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType isEVALUATION, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- CreatedAt string
- Time that the Apigee organization was created in milliseconds since epoch.
- CustomerName string
- Not used by Apigee.
- Description string
- Description of the Apigee organization.
- DisableVpc boolPeering 
- 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.
- DisplayName string
- Display name for the Apigee organization. Unused, but reserved for future use.
- Environments List<string>
- List of environments in the Apigee organization.
- ExpiresAt string
- Time that the Apigee organization is scheduled for deletion.
- LastModified stringAt 
- Time that the Apigee organization was last modified in milliseconds since epoch.
- Name string
- Name of the Apigee organization.
- PortalDisabled bool
- Configuration for the Portals settings.
- Project string
- Project ID associated with the Apigee organization.
- Properties
Pulumi.Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Properties Response 
- Properties defined in the Apigee organization profile.
- RuntimeDatabase stringEncryption Key Name 
- 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. Required when RuntimeType is CLOUD. If not specified when RuntimeType isTRIAL, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid.
- RuntimeType string
- Runtime type of the Apigee organization based on the Apigee subscription purchased.
- State string
- State of the organization. Values other than ACTIVE means the resource is not ready to use.
- SubscriptionPlan string
- Subscription plan that the customer has purchased. Output only.
- SubscriptionType string
- 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.
- Type string
- Not used by Apigee.
- AddonsConfig GoogleCloud Apigee V1Addons Config Response 
- Addon configurations of the Apigee organization.
- AnalyticsRegion string
- 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.
- ApiConsumer stringData Encryption Key Name 
- Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType isEVALUATIONor the region is not US/EU, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- ApiConsumer stringData Location 
- This field is needed only for customers with control plane in US or EU. 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.
- ApigeeProject stringId 
- 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 []string
- Not used by Apigee.
- string
- 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. 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/mynetworkNote: Not supported for Apigee hybrid.
- BillingType string
- Billing type of the Apigee organization. See Apigee pricing.
- CaCertificate string
- Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.
- ControlPlane stringEncryption Key Name 
- Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType isEVALUATION, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- CreatedAt string
- Time that the Apigee organization was created in milliseconds since epoch.
- CustomerName string
- Not used by Apigee.
- Description string
- Description of the Apigee organization.
- DisableVpc boolPeering 
- 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.
- DisplayName string
- Display name for the Apigee organization. Unused, but reserved for future use.
- Environments []string
- List of environments in the Apigee organization.
- ExpiresAt string
- Time that the Apigee organization is scheduled for deletion.
- LastModified stringAt 
- Time that the Apigee organization was last modified in milliseconds since epoch.
- Name string
- Name of the Apigee organization.
- PortalDisabled bool
- Configuration for the Portals settings.
- Project string
- Project ID associated with the Apigee organization.
- Properties
GoogleCloud Apigee V1Properties Response 
- Properties defined in the Apigee organization profile.
- RuntimeDatabase stringEncryption Key Name 
- 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. Required when RuntimeType is CLOUD. If not specified when RuntimeType isTRIAL, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid.
- RuntimeType string
- Runtime type of the Apigee organization based on the Apigee subscription purchased.
- State string
- State of the organization. Values other than ACTIVE means the resource is not ready to use.
- SubscriptionPlan string
- Subscription plan that the customer has purchased. Output only.
- SubscriptionType string
- 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.
- Type string
- Not used by Apigee.
- addonsConfig GoogleCloud Apigee V1Addons Config Response 
- Addon configurations of the Apigee organization.
- analyticsRegion String
- 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.
- apiConsumer StringData Encryption Key Name 
- Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType isEVALUATIONor the region is not US/EU, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- apiConsumer StringData Location 
- This field is needed only for customers with control plane in US or EU. 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.
- apigeeProject StringId 
- 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 List<String>
- Not used by Apigee.
- String
- 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. 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/mynetworkNote: Not supported for Apigee hybrid.
- billingType String
- Billing type of the Apigee organization. See Apigee pricing.
- caCertificate String
- Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.
- controlPlane StringEncryption Key Name 
- Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType isEVALUATION, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- createdAt String
- Time that the Apigee organization was created in milliseconds since epoch.
- customerName String
- Not used by Apigee.
- description String
- Description of the Apigee organization.
- disableVpc BooleanPeering 
- 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.
- displayName String
- Display name for the Apigee organization. Unused, but reserved for future use.
- environments List<String>
- List of environments in the Apigee organization.
- expiresAt String
- Time that the Apigee organization is scheduled for deletion.
- lastModified StringAt 
- Time that the Apigee organization was last modified in milliseconds since epoch.
- name String
- Name of the Apigee organization.
- portalDisabled Boolean
- Configuration for the Portals settings.
- project String
- Project ID associated with the Apigee organization.
- properties
GoogleCloud Apigee V1Properties Response 
- Properties defined in the Apigee organization profile.
- runtimeDatabase StringEncryption Key Name 
- 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. Required when RuntimeType is CLOUD. If not specified when RuntimeType isTRIAL, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid.
- runtimeType String
- Runtime type of the Apigee organization based on the Apigee subscription purchased.
- state String
- State of the organization. Values other than ACTIVE means the resource is not ready to use.
- subscriptionPlan String
- Subscription plan that the customer has purchased. Output only.
- subscriptionType String
- 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.
- type String
- Not used by Apigee.
- addonsConfig GoogleCloud Apigee V1Addons Config Response 
- Addon configurations of the Apigee organization.
- analyticsRegion string
- 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.
- apiConsumer stringData Encryption Key Name 
- Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType isEVALUATIONor the region is not US/EU, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- apiConsumer stringData Location 
- This field is needed only for customers with control plane in US or EU. 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.
- apigeeProject stringId 
- 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 string[]
- Not used by Apigee.
- string
- 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. 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/mynetworkNote: Not supported for Apigee hybrid.
- billingType string
- Billing type of the Apigee organization. See Apigee pricing.
- caCertificate string
- Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.
- controlPlane stringEncryption Key Name 
- Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType isEVALUATION, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- createdAt string
- Time that the Apigee organization was created in milliseconds since epoch.
- customerName string
- Not used by Apigee.
- description string
- Description of the Apigee organization.
- disableVpc booleanPeering 
- 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.
- displayName string
- Display name for the Apigee organization. Unused, but reserved for future use.
- environments string[]
- List of environments in the Apigee organization.
- expiresAt string
- Time that the Apigee organization is scheduled for deletion.
- lastModified stringAt 
- Time that the Apigee organization was last modified in milliseconds since epoch.
- name string
- Name of the Apigee organization.
- portalDisabled boolean
- Configuration for the Portals settings.
- project string
- Project ID associated with the Apigee organization.
- properties
GoogleCloud Apigee V1Properties Response 
- Properties defined in the Apigee organization profile.
- runtimeDatabase stringEncryption Key Name 
- 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. Required when RuntimeType is CLOUD. If not specified when RuntimeType isTRIAL, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid.
- runtimeType string
- Runtime type of the Apigee organization based on the Apigee subscription purchased.
- state string
- State of the organization. Values other than ACTIVE means the resource is not ready to use.
- subscriptionPlan string
- Subscription plan that the customer has purchased. Output only.
- subscriptionType string
- 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.
- type string
- Not used by Apigee.
- addons_config GoogleCloud Apigee V1Addons Config Response 
- Addon configurations of the Apigee organization.
- analytics_region str
- 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.
- api_consumer_ strdata_ encryption_ key_ name 
- Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType isEVALUATIONor the region is not US/EU, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- api_consumer_ strdata_ location 
- This field is needed only for customers with control plane in US or EU. 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_ strid 
- 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 Sequence[str]
- Not used by Apigee.
- str
- 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. 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/mynetworkNote: Not supported for Apigee hybrid.
- billing_type str
- Billing type of the Apigee organization. See Apigee pricing.
- ca_certificate str
- Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.
- control_plane_ strencryption_ key_ name 
- Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType isEVALUATION, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- created_at str
- Time that the Apigee organization was created in milliseconds since epoch.
- customer_name str
- Not used by Apigee.
- description str
- Description of the Apigee organization.
- disable_vpc_ boolpeering 
- 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.
- display_name str
- Display name for the Apigee organization. Unused, but reserved for future use.
- environments Sequence[str]
- List of environments in the Apigee organization.
- expires_at str
- Time that the Apigee organization is scheduled for deletion.
- last_modified_ strat 
- Time that the Apigee organization was last modified in milliseconds since epoch.
- name str
- Name of the Apigee organization.
- portal_disabled bool
- Configuration for the Portals settings.
- project str
- Project ID associated with the Apigee organization.
- properties
GoogleCloud Apigee V1Properties Response 
- Properties defined in the Apigee organization profile.
- runtime_database_ strencryption_ key_ name 
- 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. Required when RuntimeType is CLOUD. If not specified when RuntimeType isTRIAL, 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 str
- Runtime type of the Apigee organization based on the Apigee subscription purchased.
- state str
- State of the organization. Values other than ACTIVE means the resource is not ready to use.
- subscription_plan str
- Subscription plan that the customer has purchased. Output only.
- subscription_type str
- 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.
- type str
- Not used by Apigee.
- addonsConfig Property Map
- Addon configurations of the Apigee organization.
- analyticsRegion String
- 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.
- apiConsumer StringData Encryption Key Name 
- Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType isEVALUATIONor the region is not US/EU, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- apiConsumer StringData Location 
- This field is needed only for customers with control plane in US or EU. 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.
- apigeeProject StringId 
- 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 List<String>
- Not used by Apigee.
- String
- 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. 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/mynetworkNote: Not supported for Apigee hybrid.
- billingType String
- Billing type of the Apigee organization. See Apigee pricing.
- caCertificate String
- Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.
- controlPlane StringEncryption Key Name 
- Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType isEVALUATION, a Google-Managed encryption key will be used. Format:projects/*/locations/*/keyRings/*/cryptoKeys/*
- createdAt String
- Time that the Apigee organization was created in milliseconds since epoch.
- customerName String
- Not used by Apigee.
- description String
- Description of the Apigee organization.
- disableVpc BooleanPeering 
- 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.
- displayName String
- Display name for the Apigee organization. Unused, but reserved for future use.
- environments List<String>
- List of environments in the Apigee organization.
- expiresAt String
- Time that the Apigee organization is scheduled for deletion.
- lastModified StringAt 
- Time that the Apigee organization was last modified in milliseconds since epoch.
- name String
- Name of the Apigee organization.
- portalDisabled Boolean
- Configuration for the Portals settings.
- project String
- Project ID associated with the Apigee organization.
- properties Property Map
- Properties defined in the Apigee organization profile.
- runtimeDatabase StringEncryption Key Name 
- 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. Required when RuntimeType is CLOUD. If not specified when RuntimeType isTRIAL, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid.
- runtimeType String
- Runtime type of the Apigee organization based on the Apigee subscription purchased.
- state String
- State of the organization. Values other than ACTIVE means the resource is not ready to use.
- subscriptionPlan String
- Subscription plan that the customer has purchased. Output only.
- subscriptionType String
- 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.
- type String
- Not used by Apigee.
Supporting Types
GoogleCloudApigeeV1AddonsConfigResponse     
- AdvancedApi Pulumi.Ops Config Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Advanced Api Ops Config Response 
- Configuration for the Advanced API Ops add-on.
- AnalyticsConfig Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Analytics Config Response 
- Configuration for the Analytics add-on.
- ApiSecurity Pulumi.Config Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Api Security Config Response 
- Configuration for the API Security add-on.
- ConnectorsPlatform Pulumi.Config Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Connectors Platform Config Response 
- Configuration for the Connectors Platform add-on.
- IntegrationConfig Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Integration Config Response 
- Configuration for the Integration add-on.
- MonetizationConfig Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Monetization Config Response 
- Configuration for the Monetization add-on.
- AdvancedApi GoogleOps Config Cloud Apigee V1Advanced Api Ops Config Response 
- Configuration for the Advanced API Ops add-on.
- AnalyticsConfig GoogleCloud Apigee V1Analytics Config Response 
- Configuration for the Analytics add-on.
- ApiSecurity GoogleConfig Cloud Apigee V1Api Security Config Response 
- Configuration for the API Security add-on.
- ConnectorsPlatform GoogleConfig Cloud Apigee V1Connectors Platform Config Response 
- Configuration for the Connectors Platform add-on.
- IntegrationConfig GoogleCloud Apigee V1Integration Config Response 
- Configuration for the Integration add-on.
- MonetizationConfig GoogleCloud Apigee V1Monetization Config Response 
- Configuration for the Monetization add-on.
- advancedApi GoogleOps Config Cloud Apigee V1Advanced Api Ops Config Response 
- Configuration for the Advanced API Ops add-on.
- analyticsConfig GoogleCloud Apigee V1Analytics Config Response 
- Configuration for the Analytics add-on.
- apiSecurity GoogleConfig Cloud Apigee V1Api Security Config Response 
- Configuration for the API Security add-on.
- connectorsPlatform GoogleConfig Cloud Apigee V1Connectors Platform Config Response 
- Configuration for the Connectors Platform add-on.
- integrationConfig GoogleCloud Apigee V1Integration Config Response 
- Configuration for the Integration add-on.
- monetizationConfig GoogleCloud Apigee V1Monetization Config Response 
- Configuration for the Monetization add-on.
- advancedApi GoogleOps Config Cloud Apigee V1Advanced Api Ops Config Response 
- Configuration for the Advanced API Ops add-on.
- analyticsConfig GoogleCloud Apigee V1Analytics Config Response 
- Configuration for the Analytics add-on.
- apiSecurity GoogleConfig Cloud Apigee V1Api Security Config Response 
- Configuration for the API Security add-on.
- connectorsPlatform GoogleConfig Cloud Apigee V1Connectors Platform Config Response 
- Configuration for the Connectors Platform add-on.
- integrationConfig GoogleCloud Apigee V1Integration Config Response 
- Configuration for the Integration add-on.
- monetizationConfig GoogleCloud Apigee V1Monetization Config Response 
- Configuration for the Monetization add-on.
- advanced_api_ Googleops_ config Cloud Apigee V1Advanced Api Ops Config Response 
- Configuration for the Advanced API Ops add-on.
- analytics_config GoogleCloud Apigee V1Analytics Config Response 
- Configuration for the Analytics add-on.
- api_security_ Googleconfig Cloud Apigee V1Api Security Config Response 
- Configuration for the API Security add-on.
- connectors_platform_ Googleconfig Cloud Apigee V1Connectors Platform Config Response 
- Configuration for the Connectors Platform add-on.
- integration_config GoogleCloud Apigee V1Integration Config Response 
- Configuration for the Integration add-on.
- monetization_config GoogleCloud Apigee V1Monetization Config Response 
- Configuration for the Monetization add-on.
- advancedApi Property MapOps Config 
- Configuration for the Advanced API Ops add-on.
- analyticsConfig Property Map
- Configuration for the Analytics add-on.
- apiSecurity Property MapConfig 
- Configuration for the API Security add-on.
- connectorsPlatform Property MapConfig 
- Configuration for the Connectors Platform add-on.
- integrationConfig Property Map
- Configuration for the Integration add-on.
- monetizationConfig Property Map
- Configuration for the Monetization add-on.
GoogleCloudApigeeV1AdvancedApiOpsConfigResponse       
- Enabled bool
- Flag that specifies whether the Advanced API Ops add-on is enabled.
- Enabled bool
- Flag that specifies whether the Advanced API Ops add-on is enabled.
- enabled Boolean
- Flag that specifies whether the Advanced API Ops add-on is enabled.
- enabled boolean
- Flag that specifies whether the Advanced API Ops add-on is enabled.
- enabled bool
- Flag that specifies whether the Advanced API Ops add-on is enabled.
- enabled Boolean
- Flag that specifies whether the Advanced API Ops add-on is enabled.
GoogleCloudApigeeV1AnalyticsConfigResponse     
- Enabled bool
- Whether the Analytics add-on is enabled.
- ExpireTime stringMillis 
- Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
- State string
- The state of the Analytics add-on.
- UpdateTime string
- The latest update time.
- Enabled bool
- Whether the Analytics add-on is enabled.
- ExpireTime stringMillis 
- Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
- State string
- The state of the Analytics add-on.
- UpdateTime string
- The latest update time.
- enabled Boolean
- Whether the Analytics add-on is enabled.
- expireTime StringMillis 
- Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
- state String
- The state of the Analytics add-on.
- updateTime String
- The latest update time.
- enabled boolean
- Whether the Analytics add-on is enabled.
- expireTime stringMillis 
- Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
- state string
- The state of the Analytics add-on.
- updateTime string
- The latest update time.
- enabled bool
- Whether the Analytics add-on is enabled.
- expire_time_ strmillis 
- Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
- state str
- The state of the Analytics add-on.
- update_time str
- The latest update time.
- enabled Boolean
- Whether the Analytics add-on is enabled.
- expireTime StringMillis 
- Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
- state String
- The state of the Analytics add-on.
- updateTime String
- The latest update time.
GoogleCloudApigeeV1ApiSecurityConfigResponse      
- enabled bool
- Flag that specifies whether the API security add-on is enabled.
- expires_at str
- Time at which the API Security add-on expires in in milliseconds since epoch. If unspecified, the add-on will never expire.
GoogleCloudApigeeV1ConnectorsPlatformConfigResponse      
- enabled bool
- Flag that specifies whether the Connectors Platform add-on is enabled.
- expires_at str
- Time at which the Connectors Platform add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
GoogleCloudApigeeV1IntegrationConfigResponse     
- Enabled bool
- Flag that specifies whether the Integration add-on is enabled.
- Enabled bool
- Flag that specifies whether the Integration add-on is enabled.
- enabled Boolean
- Flag that specifies whether the Integration add-on is enabled.
- enabled boolean
- Flag that specifies whether the Integration add-on is enabled.
- enabled bool
- Flag that specifies whether the Integration add-on is enabled.
- enabled Boolean
- Flag that specifies whether the Integration add-on is enabled.
GoogleCloudApigeeV1MonetizationConfigResponse     
- Enabled bool
- Flag that specifies whether the Monetization add-on is enabled.
- Enabled bool
- Flag that specifies whether the Monetization add-on is enabled.
- enabled Boolean
- Flag that specifies whether the Monetization add-on is enabled.
- enabled boolean
- Flag that specifies whether the Monetization add-on is enabled.
- enabled bool
- Flag that specifies whether the Monetization add-on is enabled.
- enabled Boolean
- Flag that specifies whether the Monetization add-on is enabled.
GoogleCloudApigeeV1PropertiesResponse    
- Property
List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Property Response> 
- List of all properties in the object
- Property
[]GoogleCloud Apigee V1Property Response 
- List of all properties in the object
- property
List<GoogleCloud Apigee V1Property Response> 
- List of all properties in the object
- property
GoogleCloud Apigee V1Property Response[] 
- List of all properties in the object
- property
Sequence[GoogleCloud Apigee V1Property Response] 
- List of all properties in the object
- property List<Property Map>
- List of all properties in the object
GoogleCloudApigeeV1PropertyResponse    
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi