Package com.hashicorp.cdktf.providers.google.apigee_instance

Class ApigeeInstance.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static ApigeeInstance.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 ApigeeInstance.Builder.

      • connection

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

      • connection

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

      • count

        @Stability(Experimental)
public ApigeeInstance.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • location

        @Stability(Stable)
public ApigeeInstance.Builder location​(String location)
        Required. Compute Engine location where the instance resides.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_instance#location ApigeeInstance#location}

        Parameters:
        location - Required. Compute Engine location where the instance resides. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public ApigeeInstance.Builder name​(String name)
        Resource ID of the instance.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_instance#name ApigeeInstance#name}

        Parameters:
        name - Resource ID of the instance. This parameter is required.
        Returns:
        this

      • orgId

        @Stability(Stable)
public ApigeeInstance.Builder orgId​(String orgId)
        The Apigee Organization associated with the Apigee instance, in the format 'organizations/{{org_name}}'.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_instance#org_id ApigeeInstance#org_id}

        Parameters:
        orgId - The Apigee Organization associated with the Apigee instance, in the format 'organizations/{{org_name}}'. This parameter is required.
        Returns:
        this

      • consumerAcceptList

        @Stability(Stable)
public ApigeeInstance.Builder consumerAcceptList​(List<String> consumerAcceptList)
        Optional.

        Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_instance#consumer_accept_list ApigeeInstance#consumer_accept_list}

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

      • description

        @Stability(Stable)
public ApigeeInstance.Builder description​(String description)
        Description of the instance.

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

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

      • diskEncryptionKeyName

        @Stability(Stable)
public ApigeeInstance.Builder diskEncryptionKeyName​(String diskEncryptionKeyName)
        Customer Managed Encryption Key (CMEK) used for disk and volume encryption.

        Required for Apigee paid subscriptions only. Use the following format: 'projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)' Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_instance#disk_encryption_key_name ApigeeInstance#disk_encryption_key_name}

        Parameters:
        diskEncryptionKeyName - Customer Managed Encryption Key (CMEK) used for disk and volume encryption. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public ApigeeInstance.Builder displayName​(String displayName)
        Display name of the instance.

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

        Parameters:
        displayName - Display name of the instance. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public ApigeeInstance.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_instance#id ApigeeInstance#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_instance#id ApigeeInstance#id}. This parameter is required.
        Returns:
        this

      • ipRange

        @Stability(Stable)
public ApigeeInstance.Builder ipRange​(String ipRange)
        IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation.

        This optional range, if provided, should be freely available as part of larger named range the customer has allocated to the Service Networking peering. If this is not provided, Apigee will automatically request for any available /22 CIDR block from Service Networking. The customer should use this CIDR block for configuring their firewall needs to allow traffic from Apigee. Input format: "a.b.c.d/22" Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_instance#ip_range ApigeeInstance#ip_range}

        Parameters:
        ipRange - IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation. This parameter is required.
        Returns:
        this

      • peeringCidrRange

        @Stability(Stable)
public ApigeeInstance.Builder peeringCidrRange​(String peeringCidrRange)
        The size of the CIDR block range that will be reserved by the instance.

        For valid values, see [CidrRange](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.instances#CidrRange) on the documentation. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_instance#peering_cidr_range ApigeeInstance#peering_cidr_range}

        Parameters:
        peeringCidrRange - The size of the CIDR block range that will be reserved by the instance. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public ApigeeInstance.Builder timeouts​(ApigeeInstanceTimeouts timeouts)
        timeouts block.

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

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