Compute Engine v1 API - Class RouterNat (2.12.0)

public sealed class RouterNat : IMessage<RouterNat>, IEquatable<RouterNat>, IDeepCloneable<RouterNat>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class 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.

Inheritance

object > RouterNat

Implements

IMessage RouterNat, IEquatable RouterNat, IDeepCloneable RouterNat, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RouterNat()

public RouterNat()

RouterNat(RouterNat)

public RouterNat(RouterNat other)

Parameter
Name	Description
`other`	`RouterNat`

Properties

AutoNetworkTier

public string AutoNetworkTier { get; set; }

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.

Property Value
Type	Description
`string`

DrainNatIps

public RepeatedField<string> DrainNatIps { get; }

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.

Property Value
Type	Description
`RepeatedFieldstring`

EnableDynamicPortAllocation

public bool EnableDynamicPortAllocation { get; set; }

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.

Property Value
Type	Description
`bool`

EnableEndpointIndependentMapping

public bool EnableEndpointIndependentMapping { get; set; }

Property Value
Type	Description
`bool`

EndpointTypes

public RepeatedField<string> EndpointTypes { get; }

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.

Property Value
Type	Description
`RepeatedFieldstring`

HasAutoNetworkTier

public bool HasAutoNetworkTier { get; }

Gets whether the "auto_network_tier" field is set

Property Value
Type	Description
`bool`

HasEnableDynamicPortAllocation

public bool HasEnableDynamicPortAllocation { get; }

Gets whether the "enable_dynamic_port_allocation" field is set

Property Value
Type	Description
`bool`

HasEnableEndpointIndependentMapping

public bool HasEnableEndpointIndependentMapping { get; }

Gets whether the "enable_endpoint_independent_mapping" field is set

Property Value
Type	Description
`bool`

HasIcmpIdleTimeoutSec

public bool HasIcmpIdleTimeoutSec { get; }

Gets whether the "icmp_idle_timeout_sec" field is set

Property Value
Type	Description
`bool`

HasMaxPortsPerVm

public bool HasMaxPortsPerVm { get; }

Gets whether the "max_ports_per_vm" field is set

Property Value
Type	Description
`bool`

HasMinPortsPerVm

public bool HasMinPortsPerVm { get; }

Gets whether the "min_ports_per_vm" field is set

Property Value
Type	Description
`bool`

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type	Description
`bool`

HasNatIpAllocateOption

public bool HasNatIpAllocateOption { get; }

Gets whether the "nat_ip_allocate_option" field is set

Property Value
Type	Description
`bool`

HasSourceSubnetworkIpRangesToNat

public bool HasSourceSubnetworkIpRangesToNat { get; }

Gets whether the "source_subnetwork_ip_ranges_to_nat" field is set

Property Value
Type	Description
`bool`

HasTcpEstablishedIdleTimeoutSec

public bool HasTcpEstablishedIdleTimeoutSec { get; }

Gets whether the "tcp_established_idle_timeout_sec" field is set

Property Value
Type	Description
`bool`

HasTcpTimeWaitTimeoutSec

public bool HasTcpTimeWaitTimeoutSec { get; }

Gets whether the "tcp_time_wait_timeout_sec" field is set

Property Value
Type	Description
`bool`

HasTcpTransitoryIdleTimeoutSec

public bool HasTcpTransitoryIdleTimeoutSec { get; }

Gets whether the "tcp_transitory_idle_timeout_sec" field is set

Property Value
Type	Description
`bool`

HasType

public bool HasType { get; }

Gets whether the "type" field is set

Property Value
Type	Description
`bool`

HasUdpIdleTimeoutSec

public bool HasUdpIdleTimeoutSec { get; }

Gets whether the "udp_idle_timeout_sec" field is set

Property Value
Type	Description
`bool`

IcmpIdleTimeoutSec

public int IcmpIdleTimeoutSec { get; set; }

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

Property Value
Type	Description
`int`

LogConfig

public RouterNatLogConfig LogConfig { get; set; }

Configure logging on this NAT.

Property Value
Type	Description
`RouterNatLogConfig`

MaxPortsPerVm

public int MaxPortsPerVm { get; set; }

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.

Property Value
Type	Description
`int`

MinPortsPerVm

public int MinPortsPerVm { get; set; }

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.

Property Value
Type	Description
`int`

Name

public string Name { get; set; }

Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

Property Value
Type	Description
`string`

NatIpAllocateOption

public string NatIpAllocateOption { get; set; }

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.

Property Value
Type	Description
`string`

NatIps

public RepeatedField<string> NatIps { get; }

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.

Property Value
Type	Description
`RepeatedFieldstring`

Rules

public RepeatedField<RouterNatRule> Rules { get; }

A list of rules associated with this NAT.

Property Value
Type	Description
`RepeatedFieldRouterNatRule`

SourceSubnetworkIpRangesToNat

public string SourceSubnetworkIpRangesToNat { get; set; }

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.

Property Value
Type	Description
`string`

Subnetworks

public RepeatedField<RouterNatSubnetworkToNat> Subnetworks { get; }

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.

Property Value
Type	Description
`RepeatedFieldRouterNatSubnetworkToNat`

TcpEstablishedIdleTimeoutSec

public int TcpEstablishedIdleTimeoutSec { get; set; }

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

Property Value
Type	Description
`int`

TcpTimeWaitTimeoutSec

public int TcpTimeWaitTimeoutSec { get; set; }

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

Property Value
Type	Description
`int`

TcpTransitoryIdleTimeoutSec

public int TcpTransitoryIdleTimeoutSec { get; set; }

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

Property Value
Type	Description
`int`

Type

public string Type { get; set; }

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.

Property Value
Type	Description
`string`

UdpIdleTimeoutSec

public int UdpIdleTimeoutSec { get; set; }

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

Property Value
Type	Description
`int`