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

Interface ApigeeInstanceConfig

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

    • Method Detail

      • getLocation

        @Stability(Stable)
@NotNull
String getLocation()
        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}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        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}

      • getOrgId

        @Stability(Stable)
@NotNull
String getOrgId()
        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}

      • getConsumerAcceptList

        @Stability(Stable)
@Nullable
default List<String> getConsumerAcceptList()
        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}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        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}

      • getDiskEncryptionKeyName

        @Stability(Stable)
@Nullable
default String getDiskEncryptionKeyName()
        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}

      • getDisplayName

        @Stability(Stable)
@Nullable
default String getDisplayName()
        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}

      • 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_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.

      • getIpRange

        @Stability(Stable)
@Nullable
default String getIpRange()
        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}

      • getPeeringCidrRange

        @Stability(Stable)
@Nullable
default String getPeeringCidrRange()
        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}

      • getTimeouts

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

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