NatGateway

Provides a resource to create a VPC NAT Gateway.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var gw = new Aws.Ec2.NatGateway("gw", new Aws.Ec2.NatGatewayArgs
        {
            AllocationId = aws_eip.Nat.Id,
            SubnetId = aws_subnet.Example.Id,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewNatGateway(ctx, "gw", &ec2.NatGatewayArgs{
			AllocationId: pulumi.Any(aws_eip.Nat.Id),
			SubnetId:     pulumi.Any(aws_subnet.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

gw = aws.ec2.NatGateway("gw",
    allocation_id=aws_eip["nat"]["id"],
    subnet_id=aws_subnet["example"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const gw = new aws.ec2.NatGateway("gw", {
    allocationId: aws_eip.nat.id,
    subnetId: aws_subnet.example.id,
});

Create a NatGateway Resource

new NatGateway(name: string, args: NatGatewayArgs, opts?: CustomResourceOptions);
@overload
def NatGateway(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               allocation_id: Optional[str] = None,
               subnet_id: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               tags_all: Optional[Mapping[str, str]] = None)
@overload
def NatGateway(resource_name: str,
               args: NatGatewayArgs,
               opts: Optional[ResourceOptions] = None)
func NewNatGateway(ctx *Context, name string, args NatGatewayArgs, opts ...ResourceOption) (*NatGateway, error)
public NatGateway(string name, NatGatewayArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args NatGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args NatGatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args NatGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NatGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

NatGateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The NatGateway resource accepts the following input properties:

AllocationId string
The Allocation ID of the Elastic IP address for the gateway.
SubnetId string
The Subnet ID of the subnet in which to place the gateway.
Tags Dictionary<string, string>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
AllocationId string
The Allocation ID of the Elastic IP address for the gateway.
SubnetId string
The Subnet ID of the subnet in which to place the gateway.
Tags map[string]string
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
allocationId string
The Allocation ID of the Elastic IP address for the gateway.
subnetId string
The Subnet ID of the subnet in which to place the gateway.
tags {[key: string]: string}
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
allocation_id str
The Allocation ID of the Elastic IP address for the gateway.
subnet_id str
The Subnet ID of the subnet in which to place the gateway.
tags Mapping[str, str]
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .

Outputs

All input properties are implicitly available as output properties. Additionally, the NatGateway resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
NetworkInterfaceId string
The ENI ID of the network interface created by the NAT gateway.
PrivateIp string
The private IP address of the NAT Gateway.
PublicIp string
The public IP address of the NAT Gateway.
Id string
The provider-assigned unique ID for this managed resource.
NetworkInterfaceId string
The ENI ID of the network interface created by the NAT gateway.
PrivateIp string
The private IP address of the NAT Gateway.
PublicIp string
The public IP address of the NAT Gateway.
id string
The provider-assigned unique ID for this managed resource.
networkInterfaceId string
The ENI ID of the network interface created by the NAT gateway.
privateIp string
The private IP address of the NAT Gateway.
publicIp string
The public IP address of the NAT Gateway.
id str
The provider-assigned unique ID for this managed resource.
network_interface_id str
The ENI ID of the network interface created by the NAT gateway.
private_ip str
The private IP address of the NAT Gateway.
public_ip str
The public IP address of the NAT Gateway.

Look up an Existing NatGateway Resource

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

public static get(name: string, id: Input<ID>, state?: NatGatewayState, opts?: CustomResourceOptions): NatGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocation_id: Optional[str] = None,
        network_interface_id: Optional[str] = None,
        private_ip: Optional[str] = None,
        public_ip: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> NatGateway
func GetNatGateway(ctx *Context, name string, id IDInput, state *NatGatewayState, opts ...ResourceOption) (*NatGateway, error)
public static NatGateway Get(string name, Input<string> id, NatGatewayState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AllocationId string
The Allocation ID of the Elastic IP address for the gateway.
NetworkInterfaceId string
The ENI ID of the network interface created by the NAT gateway.
PrivateIp string
The private IP address of the NAT Gateway.
PublicIp string
The public IP address of the NAT Gateway.
SubnetId string
The Subnet ID of the subnet in which to place the gateway.
Tags Dictionary<string, string>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
AllocationId string
The Allocation ID of the Elastic IP address for the gateway.
NetworkInterfaceId string
The ENI ID of the network interface created by the NAT gateway.
PrivateIp string
The private IP address of the NAT Gateway.
PublicIp string
The public IP address of the NAT Gateway.
SubnetId string
The Subnet ID of the subnet in which to place the gateway.
Tags map[string]string
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
allocationId string
The Allocation ID of the Elastic IP address for the gateway.
networkInterfaceId string
The ENI ID of the network interface created by the NAT gateway.
privateIp string
The private IP address of the NAT Gateway.
publicIp string
The public IP address of the NAT Gateway.
subnetId string
The Subnet ID of the subnet in which to place the gateway.
tags {[key: string]: string}
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
allocation_id str
The Allocation ID of the Elastic IP address for the gateway.
network_interface_id str
The ENI ID of the network interface created by the NAT gateway.
private_ip str
The private IP address of the NAT Gateway.
public_ip str
The public IP address of the NAT Gateway.
subnet_id str
The Subnet ID of the subnet in which to place the gateway.
tags Mapping[str, str]
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .

Import

NAT Gateways can be imported using the id, e.g.

 $ pulumi import aws:ec2/natGateway:NatGateway private_gw nat-05dba92075d71c408

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.