NatGateway

AWS Cloud Control v1.40.0, Dec 11 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.40.0 published on Thursday, Dec 11, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.40.0 published on Thursday, Dec 11, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address. With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see NAT gateways in the Amazon VPC User Guide. If you add a default route (AWS::EC2::Route resource) that points to a NAT gateway, specify the NAT gateway ID for the route’s NatGatewayId property. When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see Allocate an Elastic IP address in the Amazon VPC User Guide.

Create NatGateway Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NatGateway(name: string, args?: NatGatewayArgs, opts?: CustomResourceOptions);

@overload
def NatGateway(resource_name: str,
               args: Optional[NatGatewayArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def NatGateway(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               allocation_id: Optional[str] = None,
               availability_mode: Optional[str] = None,
               availability_zone_addresses: Optional[Sequence[NatGatewayAvailabilityZoneAddressArgs]] = None,
               connectivity_type: Optional[str] = None,
               max_drain_duration_seconds: Optional[int] = None,
               private_ip_address: Optional[str] = None,
               secondary_allocation_ids: Optional[Sequence[str]] = None,
               secondary_private_ip_address_count: Optional[int] = None,
               secondary_private_ip_addresses: Optional[Sequence[str]] = None,
               subnet_id: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
               vpc_id: Optional[str] = None)

func NewNatGateway(ctx *Context, name string, args *NatGatewayArgs, opts ...ResourceOption) (*NatGateway, error)

public NatGateway(string name, NatGatewayArgs? args = null, CustomResourceOptions? opts = null)

public NatGateway(String name, NatGatewayArgs args)
public NatGateway(String name, NatGatewayArgs args, CustomResourceOptions options)

type: aws-native:ec2:NatGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NatGateway resource accepts the following input properties:

AllocationId string

[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.

AvailabilityMode string

Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

A zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

AvailabilityZoneAddresses List<Pulumi.AwsNative.Ec2.Inputs.NatGatewayAvailabilityZoneAddress>

For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ. The regional NAT gateway uses these EIPs to handle outbound NAT traffic from their respective AZs. If not specified, the NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface. If you specify this parameter, auto-expansion is disabled and you must manually manage AZ coverage.

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

ConnectivityType string

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

MaxDrainDurationSeconds int

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

PrivateIpAddress 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.

SecondaryAllocationIds List<string>

Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.

SecondaryPrivateIpAddressCount int

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide. SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.

SecondaryPrivateIpAddresses List<string>

Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide. SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.

SubnetId string

The ID of the subnet in which the NAT gateway is located.

Tags List<Pulumi.AwsNative.Inputs.Tag>

The tags for the NAT gateway.

VpcId string

The ID of the VPC in which the NAT gateway is located.

AllocationId string

AvailabilityMode string

Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

AvailabilityZoneAddresses []NatGatewayAvailabilityZoneAddressArgs

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

ConnectivityType string

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

MaxDrainDurationSeconds int

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

PrivateIpAddress 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.

SecondaryAllocationIds []string

Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.

SecondaryPrivateIpAddressCount int

SecondaryPrivateIpAddresses []string

SubnetId string

The ID of the subnet in which the NAT gateway is located.

Tags TagArgs

The tags for the NAT gateway.

VpcId string

The ID of the VPC in which the NAT gateway is located.

allocationId String

availabilityMode String

Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

availabilityZoneAddresses List<NatGatewayAvailabilityZoneAddress>

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

connectivityType String

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

maxDrainDurationSeconds Integer

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

privateIpAddress 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.

secondaryAllocationIds List<String>

Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.

secondaryPrivateIpAddressCount Integer

secondaryPrivateIpAddresses List<String>

subnetId String

The ID of the subnet in which the NAT gateway is located.

tags List<Tag>

The tags for the NAT gateway.

vpcId String

The ID of the VPC in which the NAT gateway is located.

allocationId string

availabilityMode string

Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

availabilityZoneAddresses NatGatewayAvailabilityZoneAddress[]

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

connectivityType string

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

maxDrainDurationSeconds number

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

privateIpAddress 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.

secondaryAllocationIds string[]

Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.

secondaryPrivateIpAddressCount number

secondaryPrivateIpAddresses string[]

subnetId string

The ID of the subnet in which the NAT gateway is located.

tags Tag[]

The tags for the NAT gateway.

vpcId string

The ID of the VPC in which the NAT gateway is located.

allocation_id str

availability_mode str

Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

availability_zone_addresses Sequence[NatGatewayAvailabilityZoneAddressArgs]

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

connectivity_type str

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

max_drain_duration_seconds int

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

private_ip_address 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.

secondary_allocation_ids Sequence[str]

Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.

secondary_private_ip_address_count int

secondary_private_ip_addresses Sequence[str]

subnet_id str

The ID of the subnet in which the NAT gateway is located.

tags Sequence[TagArgs]

The tags for the NAT gateway.

vpc_id str

The ID of the VPC in which the NAT gateway is located.

allocationId String

availabilityMode String

Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

availabilityZoneAddresses List<Property Map>

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

connectivityType String

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

maxDrainDurationSeconds Number

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

privateIpAddress 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.

secondaryAllocationIds List<String>

Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.

secondaryPrivateIpAddressCount Number

secondaryPrivateIpAddresses List<String>

subnetId String

The ID of the subnet in which the NAT gateway is located.

tags List<Property Map>

The tags for the NAT gateway.

vpcId String

The ID of the VPC in which the NAT gateway is located.

Outputs

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

AutoProvisionZones string

For regional NAT gateways only: Indicates whether AWS automatically manages AZ coverage. When enabled, the NAT gateway associates EIPs in all AZs where your VPC has subnets to handle outbound NAT traffic, expands to new AZs when you create subnets there, and retracts from AZs where you've removed all subnets. When disabled, you must manually manage which AZs the NAT gateway supports and their corresponding EIPs.

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

AutoScalingIps string

For regional NAT gateways only: Indicates whether AWS automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

EniId string

The ID of the network interface.

Id string

The provider-assigned unique ID for this managed resource.

NatGatewayId string

The ID of the NAT gateway.

RouteTableId string

For regional NAT gateways only, this is the ID of the NAT gateway.

AutoProvisionZones string

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

AutoScalingIps string

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

EniId string

The ID of the network interface.

Id string

The provider-assigned unique ID for this managed resource.

NatGatewayId string

The ID of the NAT gateway.

RouteTableId string

For regional NAT gateways only, this is the ID of the NAT gateway.

autoProvisionZones String

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

autoScalingIps String

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

eniId String

The ID of the network interface.

id String

The provider-assigned unique ID for this managed resource.

natGatewayId String

The ID of the NAT gateway.

routeTableId String

For regional NAT gateways only, this is the ID of the NAT gateway.

autoProvisionZones string

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

autoScalingIps string

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

eniId string

The ID of the network interface.

id string

The provider-assigned unique ID for this managed resource.

natGatewayId string

The ID of the NAT gateway.

routeTableId string

For regional NAT gateways only, this is the ID of the NAT gateway.

auto_provision_zones str

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

auto_scaling_ips str

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

eni_id str

The ID of the network interface.

id str

The provider-assigned unique ID for this managed resource.

nat_gateway_id str

The ID of the NAT gateway.

route_table_id str

For regional NAT gateways only, this is the ID of the NAT gateway.

autoProvisionZones String

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

autoScalingIps String

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

eniId String

The ID of the network interface.

id String

The provider-assigned unique ID for this managed resource.

natGatewayId String

The ID of the NAT gateway.

routeTableId String

For regional NAT gateways only, this is the ID of the NAT gateway.

Supporting Types

NatGatewayAvailabilityZoneAddress, NatGatewayAvailabilityZoneAddressArgs

AllocationIds List<string>

The allocation IDs of the Elastic IP addresses (EIPs) to be used for handling outbound NAT traffic in this specific Availability Zone.

AvailabilityZone string

For regional NAT gateways only: The Availability Zone where this specific NAT gateway configuration will be active. Each AZ in a regional NAT gateway has its own configuration to handle outbound NAT traffic from that AZ.

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

AvailabilityZoneId string

For regional NAT gateways only: The ID of the Availability Zone where this specific NAT gateway configuration will be active. Each AZ in a regional NAT gateway has its own configuration to handle outbound NAT traffic from that AZ. Use this instead of AvailabilityZone for consistent identification of AZs across AWS Regions.

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

AllocationIds []string

The allocation IDs of the Elastic IP addresses (EIPs) to be used for handling outbound NAT traffic in this specific Availability Zone.

AvailabilityZone string

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

AvailabilityZoneId string

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

allocationIds List<String>

The allocation IDs of the Elastic IP addresses (EIPs) to be used for handling outbound NAT traffic in this specific Availability Zone.

availabilityZone String

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

availabilityZoneId String

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

allocationIds string[]

The allocation IDs of the Elastic IP addresses (EIPs) to be used for handling outbound NAT traffic in this specific Availability Zone.

availabilityZone string

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

availabilityZoneId string

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

allocation_ids Sequence[str]

The allocation IDs of the Elastic IP addresses (EIPs) to be used for handling outbound NAT traffic in this specific Availability Zone.

availability_zone str

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

availability_zone_id str

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

allocationIds List<String>

The allocation IDs of the Elastic IP addresses (EIPs) to be used for handling outbound NAT traffic in this specific Availability Zone.

availabilityZone String

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

availabilityZoneId String

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

Tag, TagArgs

A set of tags to apply to the resource.

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.40.0 published on Thursday, Dec 11, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

aws-native.ec2.NatGateway

On this page

On this page

Create NatGateway Resource

Constructor syntax

Parameters

NatGateway Resource Properties

Inputs

Outputs

Supporting Types

NatGatewayAvailabilityZoneAddress, NatGatewayAvailabilityZoneAddressArgs

Tag, TagArgs

Package Details

On this page

On this page