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

Class ApigeeOrganization.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static ApigeeOrganization.Builder create​(software.constructs.Construct scope,
                                                String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of ApigeeOrganization.Builder.

      • connection

        @Stability(Experimental)
public ApigeeOrganization.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public ApigeeOrganization.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public ApigeeOrganization.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public ApigeeOrganization.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public ApigeeOrganization.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public ApigeeOrganization.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public ApigeeOrganization.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public ApigeeOrganization.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • projectId

        @Stability(Stable)
public ApigeeOrganization.Builder projectId​(String projectId)
        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}

        Parameters:
        projectId - The project ID associated with the Apigee organization. This parameter is required.
        Returns:
        this

      • analyticsRegion

        @Stability(Stable)
public ApigeeOrganization.Builder analyticsRegion​(String analyticsRegion)
        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}

        Parameters:
        analyticsRegion - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization. This parameter is required.
        Returns:
        this

      • apiConsumerDataEncryptionKeyName

        @Stability(Stable)
public ApigeeOrganization.Builder apiConsumerDataEncryptionKeyName​(String apiConsumerDataEncryptionKeyName)
        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}

        Parameters:
        apiConsumerDataEncryptionKeyName - Cloud KMS key name used for encrypting API consumer data. This parameter is required.
        Returns:
        this

      • apiConsumerDataLocation

        @Stability(Stable)
public ApigeeOrganization.Builder apiConsumerDataLocation​(String apiConsumerDataLocation)
        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}

        Parameters:
        apiConsumerDataLocation - This field is needed only for customers using non-default data residency regions. This parameter is required.
        Returns:
        this

      • authorizedNetwork

        @Stability(Stable)
public ApigeeOrganization.Builder authorizedNetwork​(String authorizedNetwork)
        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}

        Parameters:
        authorizedNetwork - Compute Engine network used for Service Networking to be peered with Apigee runtime instances. This parameter is required.
        Returns:
        this

      • billingType

        @Stability(Stable)
public ApigeeOrganization.Builder billingType​(String billingType)
        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}

        Parameters:
        billingType - Billing type of the Apigee organization. See Apigee pricing. This parameter is required.
        Returns:
        this

      • controlPlaneEncryptionKeyName

        @Stability(Stable)
public ApigeeOrganization.Builder controlPlaneEncryptionKeyName​(String controlPlaneEncryptionKeyName)
        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}

        Parameters:
        controlPlaneEncryptionKeyName - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public ApigeeOrganization.Builder description​(String description)
        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}

        Parameters:
        description - Description of the Apigee organization. This parameter is required.
        Returns:
        this

      • disableVpcPeering

        @Stability(Stable)
public ApigeeOrganization.Builder disableVpcPeering​(Boolean disableVpcPeering)
        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}

        Parameters:
        disableVpcPeering - Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. This parameter is required.
        Returns:
        this

      • disableVpcPeering

        @Stability(Stable)
public ApigeeOrganization.Builder disableVpcPeering​(com.hashicorp.cdktf.IResolvable disableVpcPeering)
        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}

        Parameters:
        disableVpcPeering - Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public ApigeeOrganization.Builder displayName​(String displayName)
        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}

        Parameters:
        displayName - The display name of the Apigee organization. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public ApigeeOrganization.Builder id​(String id)
        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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_organization#id ApigeeOrganization#id}. This parameter is required.
        Returns:
        this

      • properties

        @Stability(Stable)
public ApigeeOrganization.Builder properties​(ApigeeOrganizationProperties properties)
        properties block.

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

        Parameters:
        properties - properties block. This parameter is required.
        Returns:
        this

      • retention

        @Stability(Stable)
public ApigeeOrganization.Builder retention​(String retention)
        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}

        Parameters:
        retention - Optional. This parameter is required.
        Returns:
        this

      • runtimeDatabaseEncryptionKeyName

        @Stability(Stable)
public ApigeeOrganization.Builder runtimeDatabaseEncryptionKeyName​(String runtimeDatabaseEncryptionKeyName)
        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}

        Parameters:
        runtimeDatabaseEncryptionKeyName - Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. This parameter is required.
        Returns:
        this

      • runtimeType

        @Stability(Stable)
public ApigeeOrganization.Builder runtimeType​(String runtimeType)
        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}

        Parameters:
        runtimeType - Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value: "CLOUD" Possible values: ["CLOUD", "HYBRID"]. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public ApigeeOrganization.Builder timeouts​(ApigeeOrganizationTimeouts timeouts)
        timeouts block.

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

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this