AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-ec2-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

NatGatewayProps Struct ​

Properties to define a NAT gateway.

Stability
Experimental
Source
lib/route.ts

Example ​

ts
const myVpc = new VpcV2(this, 'Vpc');
const routeTable = new RouteTable(this, 'RouteTable', {
  vpc: myVpc,
});
const subnet = new SubnetV2(this, 'Subnet', {
  vpc: myVpc,
  availabilityZone: 'eu-west-2a',
  ipv4CidrBlock: new IpCidr('10.0.0.0/24'),
  subnetType: SubnetType.PRIVATE_ISOLATED });

const natgw = new NatGateway(this, 'NatGW', {
  subnet: subnet,
  vpc: myVpc,
  connectivityType: NatConnectivityType.PRIVATE,
  privateIpAddress: '10.0.0.42',
});
new Route(this, 'NatGwRoute', {
  routeTable,
  destination: '0.0.0.0/0',
  target: { gateway: natgw },
});

Properties ​

allocationIdoptionalstringallocation_idoptionalstrallocationIdoptionalStringAllocationIdoptionalstringAllocationIdoptional*string#
AllocationID of Elastic IP address that's associated with the NAT gateway.

Default: attr.allocationID of a new Elastic IP created by default //TODO: ADD L2 for elastic ip

This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.

connectivityTypeoptionalNatConnectivityTypeconnectivity_typeoptionalNatConnectivityTypeconnectivityTypeoptionalNatConnectivityTypeConnectivityTypeoptionalNatConnectivityTypeConnectivityTypeoptionalNatConnectivityType= NatConnectivityType.Public#
Indicates whether the NAT gateway supports public or private connectivity.
maxDrainDurationoptionalDurationmax_drain_durationoptionalDurationmaxDrainDurationoptionalDurationMaxDrainDurationoptionalDurationMaxDrainDurationoptionalDuration= Duration.seconds(350)#
The maximum amount of time to wait before forcibly releasing the IP addresses if connections are still in progress.
natGatewayNameoptionalstringnat_gateway_nameoptionalstrnatGatewayNameoptionalStringNatGatewayNameoptionalstringNatGatewayNameoptional*string#
The resource name of the NAT gateway.

Default: NATGW provisioned without any name

privateIpAddressoptionalstringprivate_ip_addressoptionalstrprivateIpAddressoptionalStringPrivateIpAddressoptionalstringPrivateIpAddressoptional*string#
The private IPv4 address to assign to the NAT gateway.

Default: If you don't provide an address, a private IPv4 address will be automatically assigned.

secondaryAllocationIdsoptionalstring[]secondary_allocation_idsoptionaltyping.List[str]secondaryAllocationIdsoptionalList<String>SecondaryAllocationIdsoptionalstring[]SecondaryAllocationIdsoptional*[]*string#
Secondary EIP allocation IDs.

Default: no secondary allocation IDs attached to NATGW

secondaryPrivateIpAddressCountoptionalnumbersecondary_private_ip_address_countoptionalint | floatsecondaryPrivateIpAddressCountoptionalNumberSecondaryPrivateIpAddressCountoptionaldoubleSecondaryPrivateIpAddressCountoptional*float64#
The number of secondary private IPv4 addresses you want to assign to the NAT gateway.

Default: no secondary allocation IDs associated with NATGW

SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.

secondaryPrivateIpAddressesoptionalstring[]secondary_private_ip_addressesoptionaltyping.List[str]secondaryPrivateIpAddressesoptionalList<String>SecondaryPrivateIpAddressesoptionalstring[]SecondaryPrivateIpAddressesoptional*[]*string#
Secondary private IPv4 addresses.

Default: no secondary private IpAddresses associated with NATGW

SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.

subnetISubnetV2subnetISubnetV2subnetISubnetV2SubnetISubnetV2SubnetISubnetV2required#
The subnet in which the NAT gateway is located.
vpcoptionalIVpcV2vpcoptionalIVpcV2vpcoptionalIVpcV2VpcoptionalIVpcV2VpcoptionalIVpcV2#
The ID of the VPC in which the NAT gateway is located.

Default: no elastic ip associated, required in case of public connectivity if AllocationId is not defined