Package com.hashicorp.cdktf.providers.google.compute_address

Class ComputeAddress.Builder

    • Method Detail

      • create

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

      • connection

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

      • connection

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

      • count

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • name

        @Stability(Stable)
public ComputeAddress.Builder name​(String name)
        Name of the resource.

        The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression '[a-z](%5B-a-z0-9%5D*%5Ba-z0-9%5D)?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#name ComputeAddress#name}

        Parameters:
        name - Name of the resource. This parameter is required.
        Returns:
        this

      • address

        @Stability(Stable)
public ComputeAddress.Builder address​(String address)
        The static external IP address represented by this resource.

        The IP address must be inside the specified subnetwork, if any. Set by the API if undefined. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#address ComputeAddress#address}

        Parameters:
        address - The static external IP address represented by this resource. This parameter is required.
        Returns:
        this

      • addressType

        @Stability(Stable)
public ComputeAddress.Builder addressType​(String addressType)
        The type of address to reserve.

        Note: if you set this argument's value as 'INTERNAL' you need to leave the 'network_tier' argument unset in that resource block. Default value: "EXTERNAL" Possible values: ["INTERNAL", "EXTERNAL"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#address_type ComputeAddress#address_type}

        Parameters:
        addressType - The type of address to reserve. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public ComputeAddress.Builder description​(String description)
        An optional description of this resource.

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

        Parameters:
        description - An optional description of this resource. This parameter is required.
        Returns:
        this

      • id

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

      • ipv6EndpointType

        @Stability(Stable)
public ComputeAddress.Builder ipv6EndpointType​(String ipv6EndpointType)
        The endpoint type of this address, which should be VM or NETLB.

        This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. Possible values: ["VM", "NETLB"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#ipv6_endpoint_type ComputeAddress#ipv6_endpoint_type}

        Parameters:
        ipv6EndpointType - The endpoint type of this address, which should be VM or NETLB. This parameter is required.
        Returns:
        this

      • ipVersion

        @Stability(Stable)
public ComputeAddress.Builder ipVersion​(String ipVersion)
        The IP Version that will be used by this address. The default value is 'IPV4'. Possible values: ["IPV4", "IPV6"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#ip_version ComputeAddress#ip_version}

        Parameters:
        ipVersion - The IP Version that will be used by this address. The default value is 'IPV4'. Possible values: ["IPV4", "IPV6"]. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public ComputeAddress.Builder labels​(Map<String,​String> labels)
        Labels to apply to this address. A list of key->value pairs.

        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#labels ComputeAddress#labels}

        Parameters:
        labels - Labels to apply to this address. A list of key->value pairs. This parameter is required.
        Returns:
        this

      • network

        @Stability(Stable)
public ComputeAddress.Builder network​(String network)
        The URL of the network in which to reserve the address.

        This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#network ComputeAddress#network}

        Parameters:
        network - The URL of the network in which to reserve the address. This parameter is required.
        Returns:
        this

      • networkTier

        @Stability(Stable)
public ComputeAddress.Builder networkTier​(String networkTier)
        The networking tier used for configuring this address.

        If this field is not specified, it is assumed to be PREMIUM. This argument should not be used when configuring Internal addresses, because [network tier cannot be set for internal traffic; it's always Premium](https://cloud.google.com/network-tiers/docs/overview). Possible values: ["PREMIUM", "STANDARD"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#network_tier ComputeAddress#network_tier}

        Parameters:
        networkTier - The networking tier used for configuring this address. This parameter is required.
        Returns:
        this

      • prefixLength

        @Stability(Stable)
public ComputeAddress.Builder prefixLength​(Number prefixLength)
        The prefix length if the resource represents an IP range.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#prefix_length ComputeAddress#prefix_length}

        Parameters:
        prefixLength - The prefix length if the resource represents an IP range. This parameter is required.
        Returns:
        this

      • project

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

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

      • purpose

        @Stability(Stable)
public ComputeAddress.Builder purpose​(String purpose)
        The purpose of this resource, which can be one of the following values.

        * GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. * SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers. * VPC_PEERING for addresses that are reserved for VPC peer networks. * IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. * PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#purpose ComputeAddress#purpose}

        Parameters:
        purpose - The purpose of this resource, which can be one of the following values. This parameter is required.
        Returns:
        this

      • region

        @Stability(Stable)
public ComputeAddress.Builder region​(String region)
        The Region in which the created address should reside. 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/compute_address#region ComputeAddress#region}

        Parameters:
        region - The Region in which the created address should reside. If it is not provided, the provider region is used. This parameter is required.
        Returns:
        this

      • subnetwork

        @Stability(Stable)
public ComputeAddress.Builder subnetwork​(String subnetwork)
        The URL of the subnetwork in which to reserve the address.

        If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_address#subnetwork ComputeAddress#subnetwork}

        Parameters:
        subnetwork - The URL of the subnetwork in which to reserve the address. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public ComputeAddress.Builder timeouts​(ComputeAddressTimeouts timeouts)
        timeouts block.

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

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