Class RouterNat (1.17.0)

Version 1.17.0

• 1.23.0 (latest)
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

RouterNat(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
auto_network_tier	str 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. This field is a member of oneof_ _auto_network_tier.
drain_nat_ips	MutableSequence[str] 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	bool 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. This field is a member of oneof_ _enable_dynamic_port_allocation.
enable_endpoint_independent_mapping	bool This field is a member of oneof_ _enable_endpoint_independent_mapping.
endpoint_types	MutableSequence[str] 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	int Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. This field is a member of oneof_ _icmp_idle_timeout_sec.
log_config	google.cloud.compute_v1.types.RouterNatLogConfig Configure logging on this NAT. This field is a member of oneof_ _log_config.
max_ports_per_vm	int 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. This field is a member of oneof_ _max_ports_per_vm.
min_ports_per_vm	int 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. This field is a member of oneof_ _min_ports_per_vm.
name	str Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. This field is a member of oneof_ _name.
nat_ip_allocate_option	str 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. This field is a member of oneof_ _nat_ip_allocate_option.
nat_ips	MutableSequence[str] 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	MutableSequence[google.cloud.compute_v1.types.RouterNatRule] A list of rules associated with this NAT.
source_subnetwork_ip_ranges_to_nat	str 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. This field is a member of oneof_ _source_subnetwork_ip_ranges_to_nat.
subnetworks	MutableSequence[google.cloud.compute_v1.types.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	int Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. This field is a member of oneof_ _tcp_established_idle_timeout_sec.
tcp_time_wait_timeout_sec	int Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set. This field is a member of oneof_ _tcp_time_wait_timeout_sec.
tcp_transitory_idle_timeout_sec	int Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. This field is a member of oneof_ _tcp_transitory_idle_timeout_sec.
type_	str 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. This field is a member of oneof_ _type.
udp_idle_timeout_sec	int Timeout (in seconds) for UDP connections. Defaults to 30s if not set. This field is a member of oneof_ _udp_idle_timeout_sec.

Classes

AutoNetworkTier

AutoNetworkTier(value)

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.

Values: UNDEFINED_AUTO_NETWORK_TIER (0): A value indicating that the enum field is not set. FIXED_STANDARD (310464328): Public internet quality with fixed bandwidth. PREMIUM (399530551): High quality, Google-grade network tier, support for all networking products. STANDARD (484642493): Public internet quality, only limited support for other networking products. STANDARD_OVERRIDES_FIXED_STANDARD (465847234): (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.

EndpointTypes

EndpointTypes(value)

Values: UNDEFINED_ENDPOINT_TYPES (0): A value indicating that the enum field is not set. ENDPOINT_TYPE_MANAGED_PROXY_LB (439196930): This is used for regional Application Load Balancers (internal and external) and regional proxy Network Load Balancers (internal and external) endpoints. ENDPOINT_TYPE_SWG (159344456): This is used for Secure Web Gateway endpoints. ENDPOINT_TYPE_VM (57095474): This is the default.

NatIpAllocateOption

NatIpAllocateOption(value)

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.

Values: UNDEFINED_NAT_IP_ALLOCATE_OPTION (0): A value indicating that the enum field is not set. AUTO_ONLY (182333500): Nat IPs are allocated by GCP; customers can not specify any Nat IPs. MANUAL_ONLY (261251205): Only use Nat IPs provided by customers. When specified Nat IPs are not enough then the Nat service fails for new VMs.

SourceSubnetworkIpRangesToNat

SourceSubnetworkIpRangesToNat(value)

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.

Values: UNDEFINED_SOURCE_SUBNETWORK_IP_RANGES_TO_NAT (0): A value indicating that the enum field is not set. ALL_SUBNETWORKS_ALL_IP_RANGES (179964376): All the IP ranges in every Subnetwork are allowed to Nat. ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES (185573819): All the primary IP ranges in every Subnetwork are allowed to Nat. LIST_OF_SUBNETWORKS (517542270): A list of Subnetworks are allowed to Nat (specified in the field subnetwork below)

Type

Type(value)

Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC.

Values: UNDEFINED_TYPE (0): A value indicating that the enum field is not set. PRIVATE (403485027): NAT used for private IP translation. PUBLIC (223389289): NAT used for public IP translation. This is the default.