aws logo
AWS Classic v5.28.0, Jan 23 23

aws.ec2.NatGateway

Provides a resource to create a VPC NAT Gateway.

Example Usage

Public NAT

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ec2.NatGateway("example", new()
    {
        AllocationId = aws_eip.Example.Id,
        SubnetId = aws_subnet.Example.Id,
        Tags = 
        {
            { "Name", "gw NAT" },
        },
    }, new CustomResourceOptions
    {
        DependsOn = new[]
        {
            aws_internet_gateway.Example,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewNatGateway(ctx, "example", &ec2.NatGatewayArgs{
			AllocationId: pulumi.Any(aws_eip.Example.Id),
			SubnetId:     pulumi.Any(aws_subnet.Example.Id),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("gw NAT"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			aws_internet_gateway.Example,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.NatGateway;
import com.pulumi.aws.ec2.NatGatewayArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new NatGateway("example", NatGatewayArgs.builder()        
            .allocationId(aws_eip.example().id())
            .subnetId(aws_subnet.example().id())
            .tags(Map.of("Name", "gw NAT"))
            .build(), CustomResourceOptions.builder()
                .dependsOn(aws_internet_gateway.example())
                .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.ec2.NatGateway("example",
    allocation_id=aws_eip["example"]["id"],
    subnet_id=aws_subnet["example"]["id"],
    tags={
        "Name": "gw NAT",
    },
    opts=pulumi.ResourceOptions(depends_on=[aws_internet_gateway["example"]]))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2.NatGateway("example", {
    allocationId: aws_eip.example.id,
    subnetId: aws_subnet.example.id,
    tags: {
        Name: "gw NAT",
    },
}, {
    dependsOn: [aws_internet_gateway.example],
});
resources:
  example:
    type: aws:ec2:NatGateway
    properties:
      allocationId: ${aws_eip.example.id}
      subnetId: ${aws_subnet.example.id}
      tags:
        Name: gw NAT
    options:
      dependson:
        - ${aws_internet_gateway.example}

Private NAT

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ec2.NatGateway("example", new()
    {
        ConnectivityType = "private",
        SubnetId = aws_subnet.Example.Id,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewNatGateway(ctx, "example", &ec2.NatGatewayArgs{
			ConnectivityType: pulumi.String("private"),
			SubnetId:         pulumi.Any(aws_subnet.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.NatGateway;
import com.pulumi.aws.ec2.NatGatewayArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new NatGateway("example", NatGatewayArgs.builder()        
            .connectivityType("private")
            .subnetId(aws_subnet.example().id())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.ec2.NatGateway("example",
    connectivity_type="private",
    subnet_id=aws_subnet["example"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2.NatGateway("example", {
    connectivityType: "private",
    subnetId: aws_subnet.example.id,
});
resources:
  example:
    type: aws:ec2:NatGateway
    properties:
      connectivityType: private
      subnetId: ${aws_subnet.example.id}

Create 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,
               connectivity_type: Optional[str] = None,
               private_ip: Optional[str] = None,
               subnet_id: Optional[str] = None,
               tags: 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)
public NatGateway(String name, NatGatewayArgs args)
public NatGateway(String name, NatGatewayArgs args, CustomResourceOptions options)
type: aws:ec2:NatGateway
properties: # The arguments to resource properties.
options: # 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.
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.
name String
The unique name of the resource.
args NatGatewayArgs
The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The NatGateway resource accepts the following input properties:

SubnetId string

The Subnet ID of the subnet in which to place the gateway.

AllocationId string

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

ConnectivityType string

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

PrivateIp string

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

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.

SubnetId string

The Subnet ID of the subnet in which to place the gateway.

AllocationId string

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

ConnectivityType string

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

PrivateIp string

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

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.

subnetId String

The Subnet ID of the subnet in which to place the gateway.

allocationId String

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

connectivityType String

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

privateIp String

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

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.

subnetId string

The Subnet ID of the subnet in which to place the gateway.

allocationId string

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

connectivityType string

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

privateIp string

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

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.

subnet_id str

The Subnet ID of the subnet in which to place the gateway.

allocation_id str

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

connectivity_type str

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

private_ip str

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

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.

subnetId String

The Subnet ID of the subnet in which to place the gateway.

allocationId String

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

connectivityType String

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

privateIp String

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

tags Map<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.

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 ID of the network interface associated with the NAT gateway.

PublicIp string

The Elastic IP address associated with the NAT gateway.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Id string

The provider-assigned unique ID for this managed resource.

NetworkInterfaceId string

The ID of the network interface associated with the NAT gateway.

PublicIp string

The Elastic IP address associated with the NAT gateway.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

id String

The provider-assigned unique ID for this managed resource.

networkInterfaceId String

The ID of the network interface associated with the NAT gateway.

publicIp String

The Elastic IP address associated with the NAT gateway.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

id string

The provider-assigned unique ID for this managed resource.

networkInterfaceId string

The ID of the network interface associated with the NAT gateway.

publicIp string

The Elastic IP address associated with the NAT gateway.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

id str

The provider-assigned unique ID for this managed resource.

network_interface_id str

The ID of the network interface associated with the NAT gateway.

public_ip str

The Elastic IP address associated with the NAT gateway.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

id String

The provider-assigned unique ID for this managed resource.

networkInterfaceId String

The ID of the network interface associated with the NAT gateway.

publicIp String

The Elastic IP address associated with the NAT gateway.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up 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,
        connectivity_type: 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)
public static NatGateway get(String name, Output<String> id, NatGatewayState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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. Required for connectivity_type of public.

ConnectivityType string

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

NetworkInterfaceId string

The ID of the network interface associated with the NAT gateway.

PrivateIp string

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

PublicIp string

The Elastic IP address associated with 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 default_tags configuration block.

AllocationId string

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

ConnectivityType string

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

NetworkInterfaceId string

The ID of the network interface associated with the NAT gateway.

PrivateIp string

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

PublicIp string

The Elastic IP address associated with 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 default_tags configuration block.

allocationId String

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

connectivityType String

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

networkInterfaceId String

The ID of the network interface associated with the NAT gateway.

privateIp String

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

publicIp String

The Elastic IP address associated with 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 default_tags configuration block.

allocationId string

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

connectivityType string

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

networkInterfaceId string

The ID of the network interface associated with the NAT gateway.

privateIp string

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

publicIp string

The Elastic IP address associated with 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 default_tags configuration block.

allocation_id str

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

connectivity_type str

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

network_interface_id str

The ID of the network interface associated with the NAT gateway.

private_ip str

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

public_ip str

The Elastic IP address associated with 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 default_tags configuration block.

allocationId String

The Allocation ID of the Elastic IP address for the gateway. Required for connectivity_type of public.

connectivityType String

Connectivity type for the gateway. Valid values are private and public. Defaults to public.

networkInterfaceId String

The ID of the network interface associated with the NAT gateway.

privateIp String

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

publicIp String

The Elastic IP address associated with the NAT gateway.

subnetId String

The Subnet ID of the subnet in which to place the gateway.

tags Map<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>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Import

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

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

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.