Class RouterNat

A NAT service created in a router.

To get more information about RouterNat, see:

• API documentation
• How-to Guides
• Google Cloud Router

Inheritance

System.Object

Resource

CustomResource

RouterNat

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Compute

Assembly: Pulumi.Gcp.dll

Syntax

public class RouterNat : CustomResource

Constructors

RouterNat(String, RouterNatArgs, CustomResourceOptions)

Create a RouterNat resource with the given unique name, arguments, and options.

Declaration

public RouterNat(string name, RouterNatArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
RouterNatArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

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.

Declaration

public Output<ImmutableArray<string>> DrainNatIps { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

IcmpIdleTimeoutSec

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

Declaration

public Output<int?> IcmpIdleTimeoutSec { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

LogConfig

Configuration for logging on NAT Structure is documented below.

Declaration

public Output<RouterNatLogConfig> LogConfig { get; }

Property Value

Type	Description
Output<RouterNatLogConfig>

MinPortsPerVm

Minimum number of ports allocated to a VM from this NAT.

Declaration

public Output<int?> MinPortsPerVm { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Name

Self-link of subnetwork to NAT

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.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.

Declaration

public Output<string> NatIpAllocateOption { get; }

Property Value

Type	Description
Output<System.String>

NatIps

Self-links of NAT IPs. Only valid if natIpAllocateOption is set to MANUAL_ONLY.

Declaration

public Output<ImmutableArray<string>> NatIps { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

Region

Region where the router and NAT reside.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

Router

The name of the Cloud Router in which this NAT will be configured.

Declaration

public Output<string> Router { get; }

Property Value

Type	Description
Output<System.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.

Declaration

public Output<string> SourceSubnetworkIpRangesToNat { get; }

Property Value

Type	Description
Output<System.String>

Subnetworks

One or more subnetwork NAT configurations. Only used if source_subnetwork_ip_ranges_to_nat is set to LIST_OF_SUBNETWORKS Structure is documented below.

Declaration

public Output<ImmutableArray<RouterNatSubnetwork>> Subnetworks { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<RouterNatSubnetwork>>

TcpEstablishedIdleTimeoutSec

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

Declaration

public Output<int?> TcpEstablishedIdleTimeoutSec { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

TcpTransitoryIdleTimeoutSec

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

Declaration

public Output<int?> TcpTransitoryIdleTimeoutSec { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

UdpIdleTimeoutSec

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

Declaration

public Output<int?> UdpIdleTimeoutSec { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Methods

Get(String, Input<String>, RouterNatState, CustomResourceOptions)

Get an existing RouterNat resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static RouterNat Get(string name, Input<string> id, RouterNatState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
RouterNatState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
RouterNat