Skip to main content

nat_gateways

Creates, updates, deletes or gets a nat_gateway resource or lists nat_gateways in a region

Overview​

Namenat_gateways
TypeResource
DescriptionSpecifies 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](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) 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](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
Idawscc.ec2.nat_gateways

Fields​

NameDatatypeDescription
secondary_allocation_idsarraySecondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html) in the *Amazon VPC User Guide*.
private_ip_addressstringThe 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_private_ip_address_countinteger&#91;Private NAT gateway only&#93; The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see &#91;Create a NAT gateway&#93;(https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the &#42;Amazon Virtual Private Cloud User Guide&#42;.<br />&#96;&#96;SecondaryPrivateIpAddressCount&#96;&#96; and &#96;&#96;SecondaryPrivateIpAddresses&#96;&#96; cannot be set at the same time.
allocation_idstring&#91;Public NAT gateway only&#93; 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.
subnet_idstringThe ID of the subnet in which the NAT gateway is located.
connectivity_typestringIndicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
secondary_private_ip_addressesarraySecondary private IPv4 addresses. For more information about secondary addresses, see &#91;Create a NAT gateway&#93;(https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the &#42;Amazon Virtual Private Cloud User Guide&#42;.<br />&#96;&#96;SecondaryPrivateIpAddressCount&#96;&#96; and &#96;&#96;SecondaryPrivateIpAddresses&#96;&#96; cannot be set at the same time.
nat_gateway_idstring
▶tagsarrayThe tags for the NAT gateway.
max_drain_duration_secondsintegerThe 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.
regionstringAWS region.

For more information, see AWS::EC2::NatGateway.

Methods​

NameResourceAccessible byRequired Params
create_resourcenat_gatewaysINSERTregion
delete_resourcenat_gatewaysDELETEIdentifier, region
update_resourcenat_gatewaysUPDATEIdentifier, PatchDocument, region
list_resourcesnat_gateways_list_onlySELECTregion
get_resourcenat_gatewaysSELECTIdentifier, region

SELECT examples​

Gets all properties from an individual nat_gateway.

SELECT
  region,
  secondary_allocation_ids,
  private_ip_address,
  secondary_private_ip_address_count,
  allocation_id,
  subnet_id,
  connectivity_type,
  secondary_private_ip_addresses,
  nat_gateway_id,
  tags,
  max_drain_duration_seconds
FROM awscc.ec2.nat_gateways
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ nat_gateway_id }}';

INSERT example​

Use the following StackQL query and manifest file to create a new nat_gateway resource, using stack-deploy.

/*+ create */
INSERT INTO awscc.ec2.nat_gateways (
  SecondaryAllocationIds,
  PrivateIpAddress,
  SecondaryPrivateIpAddressCount,
  AllocationId,
  SubnetId,
  ConnectivityType,
  SecondaryPrivateIpAddresses,
  Tags,
  MaxDrainDurationSeconds,
  region
)
SELECT
  '{{ secondary_allocation_ids }}',
  '{{ private_ip_address }}',
  '{{ secondary_private_ip_address_count }}',
  '{{ allocation_id }}',
  '{{ subnet_id }}',
  '{{ connectivity_type }}',
  '{{ secondary_private_ip_addresses }}',
  '{{ tags }}',
  '{{ max_drain_duration_seconds }}',
  '{{ region }}';

UPDATE example​

Use the following StackQL query and manifest file to update a nat_gateway resource, using stack-deploy.

/*+ update */
UPDATE awscc.ec2.nat_gateways
SET PatchDocument = string('{{ {
    "SecondaryAllocationIds": secondary_allocation_ids,
    "SecondaryPrivateIpAddressCount": secondary_private_ip_address_count,
    "SecondaryPrivateIpAddresses": secondary_private_ip_addresses,
    "Tags": tags,
    "MaxDrainDurationSeconds": max_drain_duration_seconds
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ nat_gateway_id }}';

DELETE example​

/*+ delete */
DELETE FROM awscc.ec2.nat_gateways
WHERE
  Identifier = '{{ nat_gateway_id }}' AND
  region = 'us-east-1';

Permissions​

To operate on the nat_gateways resource, the following permissions are required:

ec2:DescribeNatGateways