Package software.amazon.awscdk.services.ec2

Interface CfnNatGatewayProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnNatGatewayProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:08.870Z")
@Stability(Stable)
public interface CfnNatGatewayProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnNatGateway.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnNatGatewayProps cfnNatGatewayProps = CfnNatGatewayProps.builder()
         .allocationId("allocationId")
         .availabilityMode("availabilityMode")
         .availabilityZoneAddresses(List.of(AvailabilityZoneAddressProperty.builder()
                 .allocationIds(List.of("allocationIds"))
                 // the properties below are optional
                 .availabilityZone("availabilityZone")
                 .availabilityZoneId("availabilityZoneId")
                 .build()))
         .connectivityType("connectivityType")
         .maxDrainDurationSeconds(123)
         .privateIpAddress("privateIpAddress")
         .secondaryAllocationIds(List.of("secondaryAllocationIds"))
         .secondaryPrivateIpAddressCount(123)
         .secondaryPrivateIpAddresses(List.of("secondaryPrivateIpAddresses"))
         .subnetId("subnetId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcId("vpcId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnNatGatewayProps.Builder	A builder for CfnNatGatewayProps
static final class	CfnNatGatewayProps.Jsii$Proxy	An implementation for CfnNatGatewayProps

Method Summary

Modifier and Type	Method	Description
static CfnNatGatewayProps.Builder	builder()
default Object	getAllocationId()	[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
default String	getAvailabilityMode()	Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.
default Object	getAvailabilityZoneAddresses()	For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ.
default String	getConnectivityType()	Indicates whether the NAT gateway supports public or private connectivity.
default Number	getMaxDrainDurationSeconds()	The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.
default String	getPrivateIpAddress()	The private IPv4 address to assign to the NAT gateway.
default List<String>	getSecondaryAllocationIds()	Secondary EIP allocation IDs.
default Number	getSecondaryPrivateIpAddressCount()	[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.
default List<String>	getSecondaryPrivateIpAddresses()	Secondary private IPv4 addresses.
default Object	getSubnetId()	The ID of the subnet in which the NAT gateway is located.
default List<CfnTag>	getTags()	The tags for the NAT gateway.
default String	getVpcId()	The ID of the VPC in which the NAT gateway is located.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllocationId

@Stability(Stable)
@Nullable
default Object getAllocationId()

[Public NAT gateway only] 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.

Returns union: either String or IEIPRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid

getAvailabilityMode

@Stability(Stable)
@Nullable
default String getAvailabilityMode()

Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

A zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-availabilitymode

getAvailabilityZoneAddresses

@Stability(Stable)
@Nullable
default Object getAvailabilityZoneAddresses()

For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ.

The regional NAT gateway uses these EIPs to handle outbound NAT traffic from their respective AZs. If not specified, the NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface. If you specify this parameter, auto-expansion is disabled and you must manually manage AZ coverage.

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnNatGateway.AvailabilityZoneAddressProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-availabilityzoneaddresses

getConnectivityType

@Stability(Stable)
@Nullable
default String getConnectivityType()

Indicates whether the NAT gateway supports public or private connectivity.

The default is public connectivity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-connectivitytype

getMaxDrainDurationSeconds

@Stability(Stable)
@Nullable
default Number getMaxDrainDurationSeconds()

The 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-maxdraindurationseconds

getPrivateIpAddress

@Stability(Stable)
@Nullable
default String getPrivateIpAddress()

The private IPv4 address to assign to the NAT gateway.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-privateipaddress

getSecondaryAllocationIds

@Stability(Stable)
@Nullable
default List<String> getSecondaryAllocationIds()

Secondary EIP allocation IDs.

For more information, see Create a NAT gateway in the Amazon VPC User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryallocationids

getSecondaryPrivateIpAddressCount

@Stability(Stable)
@Nullable
default Number getSecondaryPrivateIpAddressCount()

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.

For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide .

SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresscount

getSecondaryPrivateIpAddresses

@Stability(Stable)
@Nullable
default List<String> getSecondaryPrivateIpAddresses()

Secondary private IPv4 addresses.

For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide .

SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresses

getSubnetId

@Stability(Stable)
@Nullable
default Object getSubnetId()

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

Returns union: either String or ISubnetRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-subnetid

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the NAT gateway.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-tags

getVpcId

@Stability(Stable)
@Nullable
default String getVpcId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-vpcid

builder

@Stability(Stable)
static CfnNatGatewayProps.Builder builder()

Returns:

a CfnNatGatewayProps.Builder of CfnNatGatewayProps