Package com.hashicorp.cdktf.providers.google.vpc_access_connector

Interface VpcAccessConnectorConfig

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

    • Method Detail

      • getName

        @Stability(Stable)
@NotNull
String getName()
        The name of the resource (Max 25 characters).

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#name VpcAccessConnector#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/vpc_access_connector#id VpcAccessConnector#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.

      • getIpCidrRange

        @Stability(Stable)
@Nullable
default String getIpCidrRange()
        The range of internal addresses that follows RFC 4632 notation. Example: '10.132.0.0/28'.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#ip_cidr_range VpcAccessConnector#ip_cidr_range}

      • getMachineType

        @Stability(Stable)
@Nullable
default String getMachineType()
        Machine type of VM Instance underlying connector. Default is e2-micro.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#machine_type VpcAccessConnector#machine_type}

      • getMaxInstances

        @Stability(Stable)
@Nullable
default Number getMaxInstances()
        Maximum value of instances in autoscaling group underlying the connector.

        Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#max_instances VpcAccessConnector#max_instances}

      • getMaxThroughput

        @Stability(Stable)
@Nullable
default Number getMaxThroughput()
        Maximum throughput of the connector in Mbps, must be greater than 'min_throughput'.

        Default is 300. Refers to the expected throughput when using an e2-micro machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by min_throughput. If both max_throughput and max_instances are provided, max_instances takes precedence over max_throughput. The use of max_throughput is discouraged in favor of max_instances. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#max_throughput VpcAccessConnector#max_throughput}

      • getMinInstances

        @Stability(Stable)
@Nullable
default Number getMinInstances()
        Minimum value of instances in autoscaling group underlying the connector.

        Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#min_instances VpcAccessConnector#min_instances}

      • getMinThroughput

        @Stability(Stable)
@Nullable
default Number getMinThroughput()
        Minimum throughput of the connector in Mbps.

        Default and min is 200. Refers to the expected throughput when using an e2-micro machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by max_throughput. If both min_throughput and min_instances are provided, min_instances takes precedence over min_throughput. The use of min_throughput is discouraged in favor of min_instances. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#min_throughput VpcAccessConnector#min_throughput}

      • getNetwork

        @Stability(Stable)
@Nullable
default String getNetwork()
        Name or self_link of the VPC network. Required if 'ip_cidr_range' is set.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#network VpcAccessConnector#network}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#project VpcAccessConnector#project}.

      • getRegion

        @Stability(Stable)
@Nullable
default String getRegion()
        Region where the VPC Access connector resides. If it is not provided, the provider region is used.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#region VpcAccessConnector#region}

      • getSubnet

        @Stability(Stable)
@Nullable
default VpcAccessConnectorSubnet getSubnet()
        subnet block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vpc_access_connector#subnet VpcAccessConnector#subnet}

      • getTimeouts

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

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