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.
EndpointTypes
EndpointTypes(value)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.
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.
Type
Type(value)Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC.