Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

NatGateway

Describes a NAT gateway.

Contents

createTime

The date and time the NAT gateway was created.

Type: Timestamp

Required: No

deleteTime

The date and time the NAT gateway was deleted, if applicable.

Type: Timestamp

Required: No

failureCode

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

Type: String

Required: No

failureMessage

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"

  • For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"

  • For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"

  • For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"

  • For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."

  • For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."

Type: String

Required: No

natGatewayAddressSet

Information about the IP addresses and network interface associated with the NAT gateway.

Type: Array of NatGatewayAddress objects

Required: No

natGatewayId

The ID of the NAT gateway.

Type: String

Required: No

provisionedBandwidth

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

Type: ProvisionedBandwidth object

Required: No

state

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

Type: String

Valid Values: pending | failed | available | deleting | deleted

Required: No

subnetId

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

Type: String

Required: No

tagSet

The tags for the NAT gateway.

Type: Array of Tag objects

Required: No

vpcId

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: