@aws-cdk/aws-ec2-alpha.NatGatewayOptions

Experimental

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

NatGatewayOptions Struct

Options to define a NAT gateway.

Stability

Experimental

Source

lib/route.ts

Example

const stack = new Stack();
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.PUBLIC });

myVpc.addInternetGateway();
myVpc.addNatGateway({
  subnet: subnet,
  connectivityType: NatConnectivityType.PUBLIC,
});

stack = Stack()
my_vpc = VpcV2(self, "Vpc")
route_table = RouteTable(self, "RouteTable",
    vpc=my_vpc
)
subnet = SubnetV2(self, "Subnet",
    vpc=my_vpc,
    availability_zone="eu-west-2a",
    ipv4_cidr_block=IpCidr("10.0.0.0/24"),
    subnet_type=SubnetType.PUBLIC
)

my_vpc.add_internet_gateway()
my_vpc.add_nat_gateway(
    subnet=subnet,
    connectivity_type=NatConnectivityType.PUBLIC
)

Stack stack = new Stack();
VpcV2 myVpc = new VpcV2(this, "Vpc");
RouteTable routeTable = RouteTable.Builder.create(this, "RouteTable")
        .vpc(myVpc)
        .build();
SubnetV2 subnet = SubnetV2.Builder.create(this, "Subnet")
        .vpc(myVpc)
        .availabilityZone("eu-west-2a")
        .ipv4CidrBlock(new IpCidr("10.0.0.0/24"))
        .subnetType(SubnetType.PUBLIC)
        .build();

myVpc.addInternetGateway();
myVpc.addNatGateway(NatGatewayOptions.builder()
        .subnet(subnet)
        .connectivityType(NatConnectivityType.PUBLIC)
        .build());

// Install: dotnet add package Amazon.CDK.AWS.ec2.Alpha
var stack = new Stack();
var myVpc = new VpcV2(this, "Vpc");
var routeTable = new RouteTable(this, "RouteTable", new RouteTableProps {
    Vpc = myVpc
});
var subnet = new SubnetV2(this, "Subnet", new SubnetV2Props {
    Vpc = myVpc,
    AvailabilityZone = "eu-west-2a",
    Ipv4CidrBlock = new IpCidr("10.0.0.0/24"),
    SubnetType = SubnetType.PUBLIC
});

myVpc.AddInternetGateway();
myVpc.AddNatGateway(new NatGatewayOptions {
    Subnet = subnet,
    ConnectivityType = NatConnectivityType.PUBLIC
});

// Install: go get github.com/aws/aws-cdk-go/awsec2alpha/v2
stack := awscdk.Newstack()
myVpc := awsec2alpha.NewVpcV2(this, jsii.String("Vpc"))
routeTable := awsec2alpha.NewRouteTable(this, jsii.String("RouteTable"), &RouteTableProps{
	Vpc: myVpc,
})
subnet := awsec2alpha.NewSubnetV2(this, jsii.String("Subnet"), &SubnetV2Props{
	Vpc: myVpc,
	AvailabilityZone: jsii.String("eu-west-2a"),
	Ipv4CidrBlock: awsec2alpha.NewIpCidr(jsii.String("10.0.0.0/24")),
	SubnetType: awscdk.SubnetType_PUBLIC,
})

myVpc.AddInternetGateway()
myVpc.AddNatGateway(&NatGatewayOptions{
	Subnet: subnet,
	ConnectivityType: awsec2alpha.NatConnectivityType_PUBLIC,
})

Properties

allocationId?optionalstringallocation_id?optionalstrallocationId?optionalStringAllocationId?optionalstringAllocationId?optional*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.

connectivityType?optionalNatConnectivityTypeconnectivity_type?optionalNatConnectivityTypeconnectivityType?optionalNatConnectivityTypeConnectivityType?optionalNatConnectivityTypeConnectivityType?optionalNatConnectivityType= NatConnectivityType.Public#

Indicates whether the NAT gateway supports public or private connectivity.

maxDrainDuration?optionalDurationmax_drain_duration?optionalDurationmaxDrainDuration?optionalDurationMaxDrainDuration?optionalDurationMaxDrainDuration?optionalDuration= Duration.seconds(350)#

The maximum amount of time to wait before forcibly releasing the IP addresses if connections are still in progress.

natGatewayName?optionalstringnat_gateway_name?optionalstrnatGatewayName?optionalStringNatGatewayName?optionalstringNatGatewayName?optional*string#

The resource name of the NAT gateway.

Default: NATGW provisioned without any name

privateIpAddress?optionalstringprivate_ip_address?optionalstrprivateIpAddress?optionalStringPrivateIpAddress?optionalstringPrivateIpAddress?optional*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.

secondaryAllocationIds?optionalstring[]secondary_allocation_ids?optionaltyping.List[str]secondaryAllocationIds?optionalList<String>SecondaryAllocationIds?optionalstring[]SecondaryAllocationIds?optional*[]*string#

Secondary EIP allocation IDs.

Default: no secondary allocation IDs attached to NATGW

secondaryPrivateIpAddressCount?optionalnumbersecondary_private_ip_address_count?optionalint | floatsecondaryPrivateIpAddressCount?optionalNumberSecondaryPrivateIpAddressCount?optionaldoubleSecondaryPrivateIpAddressCount?optional*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.

secondaryPrivateIpAddresses?optionalstring[]secondary_private_ip_addresses?optionaltyping.List[str]secondaryPrivateIpAddresses?optionalList<String>SecondaryPrivateIpAddresses?optionalstring[]SecondaryPrivateIpAddresses?optional*[]*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.