Package com.hashicorp.cdktf.providers.google.apigee_organization

Interface ApigeeOrganizationConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    ApigeeOrganizationConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:17.390Z")
@Stability(Stable)
public interface ApigeeOrganizationConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getProjectId

        @Stability(Stable)
@NotNull
String getProjectId()
        The project ID associated with the Apigee organization.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#project_id ApigeeOrganization#project_id}

      • getAnalyticsRegion

        @Stability(Stable)
@Nullable
default String getAnalyticsRegion()
        Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#analytics_region ApigeeOrganization#analytics_region}

      • getApiConsumerDataEncryptionKeyName

        @Stability(Stable)
@Nullable
default String getApiConsumerDataEncryptionKeyName()
        Cloud KMS key name used for encrypting API consumer data.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#api_consumer_data_encryption_key_name ApigeeOrganization#api_consumer_data_encryption_key_name}

      • getApiConsumerDataLocation

        @Stability(Stable)
@Nullable
default String getApiConsumerDataLocation()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#api_consumer_data_location ApigeeOrganization#api_consumer_data_location}

      • getAuthorizedNetwork

        @Stability(Stable)
@Nullable
default String getAuthorizedNetwork()
        Compute Engine network used for Service Networking to be peered with Apigee runtime instances.

        See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when 'RuntimeType' is set to CLOUD. The value can be updated only when there are no runtime instances. For example: "default". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#authorized_network ApigeeOrganization#authorized_network}

      • getBillingType

        @Stability(Stable)
@Nullable
default String getBillingType()
        Billing type of the Apigee organization. See Apigee pricing.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#billing_type ApigeeOrganization#billing_type}

      • getControlPlaneEncryptionKeyName

        @Stability(Stable)
@Nullable
default String getControlPlaneEncryptionKeyName()
        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". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#control_plane_encryption_key_name ApigeeOrganization#control_plane_encryption_key_name}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        Description of the Apigee organization.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#description ApigeeOrganization#description}

      • getDisableVpcPeering

        @Stability(Stable)
@Nullable
default Object getDisableVpcPeering()
        Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee.

        Required if an 'authorizedNetwork' on the consumer project is not provided, in which case the flag should be set to 'true'. Valid only when 'RuntimeType' is set to CLOUD. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#disable_vpc_peering ApigeeOrganization#disable_vpc_peering}

      • getDisplayName

        @Stability(Stable)
@Nullable
default String getDisplayName()
        The display name of the Apigee organization.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#display_name ApigeeOrganization#display_name}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#id ApigeeOrganization#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getProperties

        @Stability(Stable)
@Nullable
default ApigeeOrganizationProperties getProperties()
        properties block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#properties ApigeeOrganization#properties}

      • getRetention

        @Stability(Stable)
@Nullable
default String getRetention()
        Optional.

        This setting is applicable only for organizations that are soft-deleted (i.e., BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored. Default value: "DELETION_RETENTION_UNSPECIFIED" Possible values: ["DELETION_RETENTION_UNSPECIFIED", "MINIMUM"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#retention ApigeeOrganization#retention}

      • getRuntimeDatabaseEncryptionKeyName

        @Stability(Stable)
@Nullable
default String getRuntimeDatabaseEncryptionKeyName()
        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, a Google-Managed encryption key will be used. Valid only when 'RuntimeType' is CLOUD. For example: 'projects/foo/locations/us/keyRings/bar/cryptoKeys/baz'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#runtime_database_encryption_key_name ApigeeOrganization#runtime_database_encryption_key_name}

      • getRuntimeType

        @Stability(Stable)
@Nullable
default String getRuntimeType()
        Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value: "CLOUD" Possible values: ["CLOUD", "HYBRID"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#runtime_type ApigeeOrganization#runtime_type}

      • getTimeouts

        @Stability(Stable)
@Nullable
default ApigeeOrganizationTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#timeouts ApigeeOrganization#timeouts}