Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::RouterNat (v2.14.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::RouterNat.

Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#auto_network_tier

def auto_network_tier() -> ::String

Returns

(::String) — 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. Check the AutoNetworkTier enum for the list of possible values.

#auto_network_tier=

def auto_network_tier=(value) -> ::String

Parameter

value (::String) — 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. Check the AutoNetworkTier enum for the list of possible values.

Returns

(::String) — 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. Check the AutoNetworkTier enum for the list of possible values.

#drain_nat_ips

def drain_nat_ips() -> ::Array<::String>

Returns

(::Array<::String>) — 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. These IPs should be used for updating/patching a NAT only.

#drain_nat_ips=

def drain_nat_ips=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — 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. These IPs should be used for updating/patching a NAT only.

Returns

(::Array<::String>) — 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. These IPs should be used for updating/patching a NAT only.

#enable_dynamic_port_allocation

def enable_dynamic_port_allocation() -> ::Boolean

Returns

(::Boolean) — Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts 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.

#enable_dynamic_port_allocation=

def enable_dynamic_port_allocation=(value) -> ::Boolean

Parameter

value (::Boolean) — Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts 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.

Returns

(::Boolean) — Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts 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.

#enable_endpoint_independent_mapping

def enable_endpoint_independent_mapping() -> ::Boolean

Returns

(::Boolean)

#enable_endpoint_independent_mapping=

def enable_endpoint_independent_mapping=(value) -> ::Boolean

Parameter

value (::Boolean)

Returns

(::Boolean)

#endpoint_types

def endpoint_types() -> ::Array<::String>

Returns

(::Array<::String>) — List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM Check the EndpointTypes enum for the list of possible values.

#endpoint_types=

def endpoint_types=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM Check the EndpointTypes enum for the list of possible values.

Returns

(::Array<::String>) — List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM Check the EndpointTypes enum for the list of possible values.

#icmp_idle_timeout_sec

def icmp_idle_timeout_sec() -> ::Integer

Returns

(::Integer) — Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

#icmp_idle_timeout_sec=

def icmp_idle_timeout_sec=(value) -> ::Integer

Parameter

value (::Integer) — Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

Returns

(::Integer) — Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

#log_config

def log_config() -> ::Google::Cloud::Compute::V1::RouterNatLogConfig

Returns

(::Google::Cloud::Compute::V1::RouterNatLogConfig) — Configure logging on this NAT.

#log_config=

def log_config=(value) -> ::Google::Cloud::Compute::V1::RouterNatLogConfig

Parameter

value (::Google::Cloud::Compute::V1::RouterNatLogConfig) — Configure logging on this NAT.

Returns

(::Google::Cloud::Compute::V1::RouterNatLogConfig) — Configure logging on this NAT.

#max_ports_per_vm

def max_ports_per_vm() -> ::Integer

Returns

(::Integer) — Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.

#max_ports_per_vm=

def max_ports_per_vm=(value) -> ::Integer

Parameter

value (::Integer) — Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.

Returns

(::Integer) — Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.

#min_ports_per_vm

def min_ports_per_vm() -> ::Integer

Returns

(::Integer) — Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

#min_ports_per_vm=

def min_ports_per_vm=(value) -> ::Integer

Parameter

value (::Integer) — Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

Returns

(::Integer) — Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

#name

def name() -> ::String

Returns

(::String) — Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

Returns

(::String) — Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

#nat_ip_allocate_option

def nat_ip_allocate_option() -> ::String

Returns

(::String) — Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. Check the NatIpAllocateOption enum for the list of possible values.

#nat_ip_allocate_option=

def nat_ip_allocate_option=(value) -> ::String

Parameter

value (::String) — Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. Check the NatIpAllocateOption enum for the list of possible values.

Returns

(::String) — Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. Check the NatIpAllocateOption enum for the list of possible values.

#nat_ips

def nat_ips() -> ::Array<::String>

Returns

(::Array<::String>) — A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

#nat_ips=

def nat_ips=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

Returns

(::Array<::String>) — A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

#rules

def rules() -> ::Array<::Google::Cloud::Compute::V1::RouterNatRule>

Returns

(::Array<::Google::Cloud::Compute::V1::RouterNatRule>) — A list of rules associated with this NAT.

#rules=

def rules=(value) -> ::Array<::Google::Cloud::Compute::V1::RouterNatRule>

Parameter

value (::Array<::Google::Cloud::Compute::V1::RouterNatRule>) — A list of rules associated with this NAT.

Returns

(::Array<::Google::Cloud::Compute::V1::RouterNatRule>) — A list of rules associated with this NAT.

#source_subnetwork_ip_ranges_to_nat

def source_subnetwork_ip_ranges_to_nat() -> ::String

Returns

(::String) — Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - 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) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region. Check the SourceSubnetworkIpRangesToNat enum for the list of possible values.

#source_subnetwork_ip_ranges_to_nat=

def source_subnetwork_ip_ranges_to_nat=(value) -> ::String

Parameter

value (::String) — Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - 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) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region. Check the SourceSubnetworkIpRangesToNat enum for the list of possible values.

Returns

(::String) — Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - 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) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region. Check the SourceSubnetworkIpRangesToNat enum for the list of possible values.

#subnetworks

def subnetworks() -> ::Array<::Google::Cloud::Compute::V1::RouterNatSubnetworkToNat>

Returns

(::Array<::Google::Cloud::Compute::V1::RouterNatSubnetworkToNat>) — A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

#subnetworks=

def subnetworks=(value) -> ::Array<::Google::Cloud::Compute::V1::RouterNatSubnetworkToNat>

Parameter

value (::Array<::Google::Cloud::Compute::V1::RouterNatSubnetworkToNat>) — A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

Returns

(::Array<::Google::Cloud::Compute::V1::RouterNatSubnetworkToNat>) — A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

#tcp_established_idle_timeout_sec

def tcp_established_idle_timeout_sec() -> ::Integer

Returns

(::Integer) — Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

#tcp_established_idle_timeout_sec=

def tcp_established_idle_timeout_sec=(value) -> ::Integer

Parameter

value (::Integer) — Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

Returns

(::Integer) — Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

#tcp_time_wait_timeout_sec

def tcp_time_wait_timeout_sec() -> ::Integer

Returns

(::Integer) — Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

#tcp_time_wait_timeout_sec=

def tcp_time_wait_timeout_sec=(value) -> ::Integer

Parameter

value (::Integer) — Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

Returns

(::Integer) — Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

#tcp_transitory_idle_timeout_sec

def tcp_transitory_idle_timeout_sec() -> ::Integer

Returns

(::Integer) — Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

#tcp_transitory_idle_timeout_sec=

def tcp_transitory_idle_timeout_sec=(value) -> ::Integer

Parameter

value (::Integer) — Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

Returns

(::Integer) — Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

#type

def type() -> ::String

Returns

(::String) — Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. Check the Type enum for the list of possible values.

#type=

def type=(value) -> ::String

Parameter

value (::String) — Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. Check the Type enum for the list of possible values.

Returns

(::String) — Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. Check the Type enum for the list of possible values.

#udp_idle_timeout_sec

def udp_idle_timeout_sec() -> ::Integer

Returns

(::Integer) — Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

#udp_idle_timeout_sec=

def udp_idle_timeout_sec=(value) -> ::Integer

Parameter

value (::Integer) — Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

Returns

(::Integer) — Timeout (in seconds) for UDP connections. Defaults to 30s if not set.