VPC NAT Gateway

This table represents the VPC NAT Gateway resource from Amazon Web Services.

aws.vpc_nat_gateway

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
connectivity_typecorestringIndicates whether the NAT gateway supports public or private connectivity.
create_timecoretimestampThe date and time the NAT gateway was created.
delete_timecoretimestampThe date and time the NAT gateway was deleted, if applicable.
failure_codecorestringIf the NAT gateway could not be created, specifies the error code for the failure. (<code>InsufficientFreeAddressesInSubnet</code> | <code>Gateway.NotAttached</code> | <code>InvalidAllocationID.NotFound</code> | <code>Resource.AlreadyAssociated</code> | <code>InternalError</code> | <code>InvalidSubnetID.NotFound</code>)
failure_messagecorestringIf the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code. <ul> <li> For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway" </li> <li> For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached" </li> <li> For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway" </li> <li> For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated" </li> <li> For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again." </li> <li> For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found." </li> </ul>
nat_gateway_addressescorejsonInformation about the IP addresses and network interface associated with the NAT gateway.
nat_gateway_arncorestring
nat_gateway_idcorestringThe ID of the NAT gateway.
provisioned_bandwidthcorejsonReserved. If you need to sustain traffic greater than the <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-gateways">documented limits</a>, contact Amazon Web Services Support.
statecorestringThe state of the NAT gateway. <ul> <li> <code>pending</code>: The NAT gateway is being created and is not ready to process traffic. </li> <li> <code>failed</code>: The NAT gateway could not be created. Check the <code>failureCode</code> and <code>failureMessage</code> fields for the reason. </li> <li> <code>available</code>: 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. </li> <li> <code>deleting</code>: The NAT gateway is in the process of being terminated and may still be processing traffic. </li> <li> <code>deleted</code>: The NAT gateway has been terminated and is no longer processing traffic. </li> </ul>
subnet_idcorestringThe ID of the subnet in which the NAT gateway is located.
tagscorehstore
vpc_idcorestringThe ID of the VPC in which the NAT gateway is located.