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

Class VpcAccessConnector.Builder

    • Method Detail

      • create

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

      • connection

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

      • connection

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • name

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

        Parameters:
        name - The name of the resource (Max 25 characters). This parameter is required.
        Returns:
        this

      • id

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

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

      • ipCidrRange

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

        Parameters:
        ipCidrRange - The range of internal addresses that follows RFC 4632 notation. Example: '10.132.0.0/28'. This parameter is required.
        Returns:
        this

      • machineType

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

        Parameters:
        machineType - Machine type of VM Instance underlying connector. Default is e2-micro. This parameter is required.
        Returns:
        this

      • maxInstances

        @Stability(Stable)
public VpcAccessConnector.Builder maxInstances​(Number maxInstances)
        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}

        Parameters:
        maxInstances - Maximum value of instances in autoscaling group underlying the connector. This parameter is required.
        Returns:
        this

      • maxThroughput

        @Stability(Stable)
public VpcAccessConnector.Builder maxThroughput​(Number maxThroughput)
        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}

        Parameters:
        maxThroughput - Maximum throughput of the connector in Mbps, must be greater than 'min_throughput'. This parameter is required.
        Returns:
        this

      • minInstances

        @Stability(Stable)
public VpcAccessConnector.Builder minInstances​(Number minInstances)
        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}

        Parameters:
        minInstances - Minimum value of instances in autoscaling group underlying the connector. This parameter is required.
        Returns:
        this

      • minThroughput

        @Stability(Stable)
public VpcAccessConnector.Builder minThroughput​(Number minThroughput)
        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}

        Parameters:
        minThroughput - Minimum throughput of the connector in Mbps. This parameter is required.
        Returns:
        this

      • network

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

        Parameters:
        network - Name or self_link of the VPC network. Required if 'ip_cidr_range' is set. This parameter is required.
        Returns:
        this

      • project

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

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

      • region

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

        Parameters:
        region - Region where the VPC Access connector resides. If it is not provided, the provider region is used. This parameter is required.
        Returns:
        this

      • subnet

        @Stability(Stable)
public VpcAccessConnector.Builder subnet​(VpcAccessConnectorSubnet subnet)
        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}

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

      • timeouts

        @Stability(Stable)
public VpcAccessConnector.Builder timeouts​(VpcAccessConnectorTimeouts timeouts)
        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}

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