Request Parameters Response Elements Errors Examples See Also

CreateNatGateway

Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.

With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.

With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.

For more information, see NAT gateways in the Amazon VPC User Guide.

Important

When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

AllocationId

[Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

Type: String

Required: No

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Constraint: Maximum 64 ASCII characters.

Type: String

Required: No

ConnectivityType

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

Type: String

Valid Values: private | public

Required: No

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

PrivateIpAddress

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.

Type: String

Required: No

SecondaryAllocationId.N

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

Type: Array of strings

Required: No

SecondaryPrivateIpAddress.N

Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.

Type: Array of strings

Required: No

SecondaryPrivateIpAddressCount

[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 VPC User Guide.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 31.

Required: No

SubnetId

The ID of the subnet in which to create the NAT gateway.

Type: String

Required: Yes

TagSpecification.N

The tags to assign to the NAT gateway.

Type: Array of TagSpecification objects

Required: No

Response Elements

The following elements are returned by the service.

clientToken

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

Type: String

natGateway

Information about the NAT gateway.

Type: NatGateway object

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

Examples

Example 1

This example creates a public NAT gateway in the specified subnet and associates the Elastic IP address with the specified allocation ID to the NAT gateway.

Sample Request


https://ec2.amazonaws.com/?Action=CreateNatGateway
&SubnetId=subnet-1234567890abcdef0
&AllocationId=eipalloc-0abcdef1234567890
&AUTHPARAMS

Sample Response


<CreateNatGatewayResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>1b74dc5c-bcda-403f-867d-example</requestId>
    <natGateway>
        <subnetId>subnet-1234567890abcdef0</subnetId>
        <natGatewayAddressSet>
            <item>
                <allocationId>eipalloc-0abcdef1234567890</allocationId>
                <networkInterfaceId>eni-0123abc456def7890</networkInterfaceId>
                <privateIp>10.0.0.191</privateIp>
                <publicIp>203.0.113.5</publicIp>
            </item>
        </natGatewayAddressSet>
        <createTime>2019-11-25T14:00:55.416Z</createTime>
        <vpcId>vpc-0598c7d356eba48d7</vpcId>
        <natGatewayId>nat-04e77a5e9c34432f9</natGatewayId>
        <connectivityType>public</connectivityType>
        <state>pending</state>
    </natGateway>
</CreateNatGatewayResponse>

Example 2

This example creates a private NAT gateway in the specified subnet.

Sample Request


https://ec2.amazonaws.com/?Action=CreateNatGateway
&SubnetId=subnet-1234567890abcdef0
&ConnectivityType=private
&AUTHPARAMS

Sample Response


<CreateNatGatewayResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>1b74dc5c-bcda-403f-867d-example</requestId>
    <natGateway>
        <subnetId>subnet-1234567890abcdef0</subnetId>
        <natGatewayAddressSet>
            <item>
                <networkInterfaceId>eni-1a2b3c4d5e6f78901</networkInterfaceId>
                <privateIp>10.0.1.26</privateIp>
            </item>
        </natGatewayAddressSet>
        <createTime>2021-06-05T14:00:55.416Z</createTime>
        <vpcId>vpc-0598c7d356eba48d7</vpcId>
        <natGatewayId>nat-04e77a5e9c34432f9</natGatewayId>
        <connectivityType>private</connectivityType>
        <state>pending</state>
    </natGateway>
</CreateNatGatewayResponse>