Package com.hashicorp.cdktf.providers.google.compute_router_nat

Class ComputeRouterNat.Builder

    • Method Detail

      • create

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

      • connection

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

      • connection

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

      • count

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • name

        @Stability(Stable)
public ComputeRouterNat.Builder name​(String name)
        Name of the NAT service. The name must be 1-63 characters long and comply with RFC1035.

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

        Parameters:
        name - Name of the NAT service. The name must be 1-63 characters long and comply with RFC1035. This parameter is required.
        Returns:
        this

      • router

        @Stability(Stable)
public ComputeRouterNat.Builder router​(String router)
        The name of the Cloud Router in which this NAT will be configured.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#router ComputeRouterNat#router}

        Parameters:
        router - The name of the Cloud Router in which this NAT will be configured. This parameter is required.
        Returns:
        this

      • sourceSubnetworkIpRangesToNat

        @Stability(Stable)
public ComputeRouterNat.Builder sourceSubnetworkIpRangesToNat​(String sourceSubnetworkIpRangesToNat)
        How NAT should be configured per Subnetwork.

        If 'ALL_SUBNETWORKS_ALL_IP_RANGES', all of the IP ranges in every Subnetwork are allowed to Nat. If 'ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES', all of the primary IP ranges in every Subnetwork are allowed to Nat. 'LIST_OF_SUBNETWORKS': A list of Subnetworks are allowed to Nat (specified in the field subnetwork below). Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other RouterNat section in any Router for this network in this region. Possible values: ["ALL_SUBNETWORKS_ALL_IP_RANGES", "ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES", "LIST_OF_SUBNETWORKS"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#source_subnetwork_ip_ranges_to_nat ComputeRouterNat#source_subnetwork_ip_ranges_to_nat}

        Parameters:
        sourceSubnetworkIpRangesToNat - How NAT should be configured per Subnetwork. This parameter is required.
        Returns:
        this

      • autoNetworkTier

        @Stability(Stable)
public ComputeRouterNat.Builder autoNetworkTier​(String autoNetworkTier)
        The network tier to use when automatically reserving NAT IP addresses.

        Must be one of: PREMIUM, STANDARD. If not specified, then the current project-level default tier is used. Possible values: ["PREMIUM", "STANDARD"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#auto_network_tier ComputeRouterNat#auto_network_tier}

        Parameters:
        autoNetworkTier - The network tier to use when automatically reserving NAT IP addresses. This parameter is required.
        Returns:
        this

      • drainNatIps

        @Stability(Stable)
public ComputeRouterNat.Builder drainNatIps​(List<String> drainNatIps)
        A list of URLs of the IP resources to be drained.

        These IPs must be valid static external IPs that have been assigned to the NAT. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#drain_nat_ips ComputeRouterNat#drain_nat_ips}

        Parameters:
        drainNatIps - A list of URLs of the IP resources to be drained. This parameter is required.
        Returns:
        this

      • enableDynamicPortAllocation

        @Stability(Stable)
public ComputeRouterNat.Builder enableDynamicPortAllocation​(Boolean enableDynamicPortAllocation)
        Enable Dynamic Port Allocation.

        If minPortsPerVm is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config. If maxPortsPerVm is set, maxPortsPerVm must be set to a power of two greater than minPortsPerVm. If maxPortsPerVm is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config. Mutually exclusive with enableEndpointIndependentMapping. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#enable_dynamic_port_allocation ComputeRouterNat#enable_dynamic_port_allocation}

        Parameters:
        enableDynamicPortAllocation - Enable Dynamic Port Allocation. This parameter is required.
        Returns:
        this

      • enableDynamicPortAllocation

        @Stability(Stable)
public ComputeRouterNat.Builder enableDynamicPortAllocation​(com.hashicorp.cdktf.IResolvable enableDynamicPortAllocation)
        Enable Dynamic Port Allocation.

        If minPortsPerVm is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config. If maxPortsPerVm is set, maxPortsPerVm must be set to a power of two greater than minPortsPerVm. If maxPortsPerVm is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config. Mutually exclusive with enableEndpointIndependentMapping. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#enable_dynamic_port_allocation ComputeRouterNat#enable_dynamic_port_allocation}

        Parameters:
        enableDynamicPortAllocation - Enable Dynamic Port Allocation. This parameter is required.
        Returns:
        this

      • enableEndpointIndependentMapping

        @Stability(Stable)
public ComputeRouterNat.Builder enableEndpointIndependentMapping​(Boolean enableEndpointIndependentMapping)
        Enable endpoint independent mapping. For more information see the official documentation.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#enable_endpoint_independent_mapping ComputeRouterNat#enable_endpoint_independent_mapping}

        Parameters:
        enableEndpointIndependentMapping - Enable endpoint independent mapping. For more information see the official documentation. This parameter is required.
        Returns:
        this

      • enableEndpointIndependentMapping

        @Stability(Stable)
public ComputeRouterNat.Builder enableEndpointIndependentMapping​(com.hashicorp.cdktf.IResolvable enableEndpointIndependentMapping)
        Enable endpoint independent mapping. For more information see the official documentation.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#enable_endpoint_independent_mapping ComputeRouterNat#enable_endpoint_independent_mapping}

        Parameters:
        enableEndpointIndependentMapping - Enable endpoint independent mapping. For more information see the official documentation. This parameter is required.
        Returns:
        this

      • endpointTypes

        @Stability(Stable)
public ComputeRouterNat.Builder endpointTypes​(List<String> endpointTypes)
        Specifies the endpoint Types supported by the NAT Gateway.

        Supported values include: 'ENDPOINT_TYPE_VM', 'ENDPOINT_TYPE_SWG', 'ENDPOINT_TYPE_MANAGED_PROXY_LB'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#endpoint_types ComputeRouterNat#endpoint_types}

        Parameters:
        endpointTypes - Specifies the endpoint Types supported by the NAT Gateway. This parameter is required.
        Returns:
        this

      • icmpIdleTimeoutSec

        @Stability(Stable)
public ComputeRouterNat.Builder icmpIdleTimeoutSec​(Number icmpIdleTimeoutSec)
        Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#icmp_idle_timeout_sec ComputeRouterNat#icmp_idle_timeout_sec}

        Parameters:
        icmpIdleTimeoutSec - Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. This parameter is required.
        Returns:
        this

      • id

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

      • logConfig

        @Stability(Stable)
public ComputeRouterNat.Builder logConfig​(ComputeRouterNatLogConfig logConfig)
        log_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#log_config ComputeRouterNat#log_config}

        Parameters:
        logConfig - log_config block. This parameter is required.
        Returns:
        this

      • maxPortsPerVm

        @Stability(Stable)
public ComputeRouterNat.Builder maxPortsPerVm​(Number maxPortsPerVm)
        Maximum number of ports allocated to a VM from this NAT.

        This field can only be set when enableDynamicPortAllocation is enabled. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#max_ports_per_vm ComputeRouterNat#max_ports_per_vm}

        Parameters:
        maxPortsPerVm - Maximum number of ports allocated to a VM from this NAT. This parameter is required.
        Returns:
        this

      • minPortsPerVm

        @Stability(Stable)
public ComputeRouterNat.Builder minPortsPerVm​(Number minPortsPerVm)
        Minimum number of ports allocated to a VM from this NAT.

        Defaults to 64 for static port allocation and 32 dynamic port allocation if not set. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#min_ports_per_vm ComputeRouterNat#min_ports_per_vm}

        Parameters:
        minPortsPerVm - Minimum number of ports allocated to a VM from this NAT. This parameter is required.
        Returns:
        this

      • natIpAllocateOption

        @Stability(Stable)
public ComputeRouterNat.Builder natIpAllocateOption​(String natIpAllocateOption)
        How external IPs should be allocated for this NAT.

        Valid values are 'AUTO_ONLY' for only allowing NAT IPs allocated by Google Cloud Platform, or 'MANUAL_ONLY' for only user-allocated NAT IP addresses. Possible values: ["MANUAL_ONLY", "AUTO_ONLY"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#nat_ip_allocate_option ComputeRouterNat#nat_ip_allocate_option}

        Parameters:
        natIpAllocateOption - How external IPs should be allocated for this NAT. This parameter is required.
        Returns:
        this

      • natIps

        @Stability(Stable)
public ComputeRouterNat.Builder natIps​(List<String> natIps)
        Self-links of NAT IPs. Only valid if natIpAllocateOption is set to MANUAL_ONLY.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#nat_ips ComputeRouterNat#nat_ips}

        Parameters:
        natIps - Self-links of NAT IPs. Only valid if natIpAllocateOption is set to MANUAL_ONLY. This parameter is required.
        Returns:
        this

      • project

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

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

      • region

        @Stability(Stable)
public ComputeRouterNat.Builder region​(String region)
        Region where the router and NAT reside.

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

        Parameters:
        region - Region where the router and NAT reside. This parameter is required.
        Returns:
        this

      • rules

        @Stability(Stable)
public ComputeRouterNat.Builder rules​(com.hashicorp.cdktf.IResolvable rules)
        rules block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#rules ComputeRouterNat#rules}

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

      • rules

        @Stability(Stable)
public ComputeRouterNat.Builder rules​(List<? extends ComputeRouterNatRules> rules)
        rules block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#rules ComputeRouterNat#rules}

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

      • subnetwork

        @Stability(Stable)
public ComputeRouterNat.Builder subnetwork​(com.hashicorp.cdktf.IResolvable subnetwork)
        subnetwork block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#subnetwork ComputeRouterNat#subnetwork}

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

      • subnetwork

        @Stability(Stable)
public ComputeRouterNat.Builder subnetwork​(List<? extends ComputeRouterNatSubnetwork> subnetwork)
        subnetwork block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#subnetwork ComputeRouterNat#subnetwork}

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

      • tcpEstablishedIdleTimeoutSec

        @Stability(Stable)
public ComputeRouterNat.Builder tcpEstablishedIdleTimeoutSec​(Number tcpEstablishedIdleTimeoutSec)
        Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#tcp_established_idle_timeout_sec ComputeRouterNat#tcp_established_idle_timeout_sec}

        Parameters:
        tcpEstablishedIdleTimeoutSec - Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. This parameter is required.
        Returns:
        this

      • tcpTimeWaitTimeoutSec

        @Stability(Stable)
public ComputeRouterNat.Builder tcpTimeWaitTimeoutSec​(Number tcpTimeWaitTimeoutSec)
        Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#tcp_time_wait_timeout_sec ComputeRouterNat#tcp_time_wait_timeout_sec}

        Parameters:
        tcpTimeWaitTimeoutSec - Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set. This parameter is required.
        Returns:
        this

      • tcpTransitoryIdleTimeoutSec

        @Stability(Stable)
public ComputeRouterNat.Builder tcpTransitoryIdleTimeoutSec​(Number tcpTransitoryIdleTimeoutSec)
        Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#tcp_transitory_idle_timeout_sec ComputeRouterNat#tcp_transitory_idle_timeout_sec}

        Parameters:
        tcpTransitoryIdleTimeoutSec - Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public ComputeRouterNat.Builder timeouts​(ComputeRouterNatTimeouts timeouts)
        timeouts block.

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

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

      • udpIdleTimeoutSec

        @Stability(Stable)
public ComputeRouterNat.Builder udpIdleTimeoutSec​(Number udpIdleTimeoutSec)
        Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_nat#udp_idle_timeout_sec ComputeRouterNat#udp_idle_timeout_sec}

        Parameters:
        udpIdleTimeoutSec - Timeout (in seconds) for UDP connections. Defaults to 30s if not set. This parameter is required.
        Returns:
        this