Package software.amazon.awscdk.services.ec2

Class CfnNatGateway

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnNatGateway
All Implemented Interfaces:
IInspectable, INatGatewayRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:08.868Z") @Stability(Stable) public class CfnNatGateway extends CfnResource implements IInspectable, INatGatewayRef, ITaggable
Specifies 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 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 in the Amazon VPC User Guide .

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.*;
 CfnNatGateway cfnNatGateway = CfnNatGateway.Builder.create(this, "MyCfnNatGateway")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnNatGateway

      protected CfnNatGateway(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnNatGateway

      protected CfnNatGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnNatGateway

      @Stability(Stable) public CfnNatGateway(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnNatGatewayProps props)
      Create a new AWS::EC2::NatGateway.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnNatGateway

      @Stability(Stable) public CfnNatGateway(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::EC2::NatGateway.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForNatGateway

      @Stability(Stable) @NotNull public static String arnForNatGateway(@NotNull INatGatewayRef resource)
      Parameters:
      resource - This parameter is required.

    • fromNatGatewayId

      @Stability(Stable) @NotNull public static INatGatewayRef fromNatGatewayId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String natGatewayId)
      Creates a new INatGatewayRef from a natGatewayId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      natGatewayId - This parameter is required.

    • isCfnNatGateway

      @Stability(Stable) @NotNull public static Boolean isCfnNatGateway(@NotNull Object x)
      Checks whether the given object is a CfnNatGateway.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAutoProvisionZones

      @Stability(Stable) @NotNull public String getAttrAutoProvisionZones()
      For regional NAT gateways only: Indicates whether AWS automatically manages AZ coverage.

      When enabled, the NAT gateway associates EIPs in all AZs where your VPC has subnets to handle outbound NAT traffic, expands to new AZs when you create subnets there, and retracts from AZs where you've removed all subnets. When disabled, you must manually manage which AZs the NAT gateway supports and their corresponding EIPs.

      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 .

    • getAttrAutoScalingIps

      @Stability(Stable) @NotNull public String getAttrAutoScalingIps()
      For regional NAT gateways only: Indicates whether AWS automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.

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

    • getAttrEniId

      @Stability(Stable) @NotNull public String getAttrEniId()
      The ID of the network interface.

    • getAttrNatGatewayId

      @Stability(Stable) @NotNull public String getAttrNatGatewayId()
      The ID of the NAT gateway.

    • getAttrRouteTableId

      @Stability(Stable) @NotNull public String getAttrRouteTableId()
      For regional NAT gateways only, this is the ID of the NAT gateway.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getNatGatewayRef

      @Stability(Stable) @NotNull public NatGatewayReference getNatGatewayRef()
      A reference to a NatGateway resource.
      Specified by:
      getNatGatewayRef in interface INatGatewayRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAllocationId

      @Stability(Stable) @Nullable public String getAllocationId()
      [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.

    • setAllocationId

      @Stability(Stable) public void setAllocationId(@Nullable String value)
      [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.

    • getAvailabilityMode

      @Stability(Stable) @Nullable public String getAvailabilityMode()
      Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

    • setAvailabilityMode

      @Stability(Stable) public void setAvailabilityMode(@Nullable String value)
      Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

    • getAvailabilityZoneAddresses

      @Stability(Stable) @Nullable public 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.

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

    • setAvailabilityZoneAddresses

      @Stability(Stable) public void setAvailabilityZoneAddresses(@Nullable IResolvable value)
      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.

    • setAvailabilityZoneAddresses

      @Stability(Stable) public void setAvailabilityZoneAddresses(@Nullable List<Object> value)
      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.

    • getConnectivityType

      @Stability(Stable) @Nullable public String getConnectivityType()
      Indicates whether the NAT gateway supports public or private connectivity.

    • setConnectivityType

      @Stability(Stable) public void setConnectivityType(@Nullable String value)
      Indicates whether the NAT gateway supports public or private connectivity.

    • getMaxDrainDurationSeconds

      @Stability(Stable) @Nullable public Number getMaxDrainDurationSeconds()
      The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.

    • setMaxDrainDurationSeconds

      @Stability(Stable) public void setMaxDrainDurationSeconds(@Nullable Number value)
      The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.

    • getPrivateIpAddress

      @Stability(Stable) @Nullable public String getPrivateIpAddress()
      The private IPv4 address to assign to the NAT gateway.

    • setPrivateIpAddress

      @Stability(Stable) public void setPrivateIpAddress(@Nullable String value)
      The private IPv4 address to assign to the NAT gateway.

    • getSecondaryAllocationIds

      @Stability(Stable) @Nullable public List<String> getSecondaryAllocationIds()
      Secondary EIP allocation IDs.

    • setSecondaryAllocationIds

      @Stability(Stable) public void setSecondaryAllocationIds(@Nullable List<String> value)
      Secondary EIP allocation IDs.

    • getSecondaryPrivateIpAddressCount

      @Stability(Stable) @Nullable public Number getSecondaryPrivateIpAddressCount()
      [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.

    • setSecondaryPrivateIpAddressCount

      @Stability(Stable) public void setSecondaryPrivateIpAddressCount(@Nullable Number value)
      [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.

    • getSecondaryPrivateIpAddresses

      @Stability(Stable) @Nullable public List<String> getSecondaryPrivateIpAddresses()
      Secondary private IPv4 addresses.

    • setSecondaryPrivateIpAddresses

      @Stability(Stable) public void setSecondaryPrivateIpAddresses(@Nullable List<String> value)
      Secondary private IPv4 addresses.

    • getSubnetId

      @Stability(Stable) @Nullable public String getSubnetId()
      The ID of the subnet in which the NAT gateway is located.

    • setSubnetId

      @Stability(Stable) public void setSubnetId(@Nullable String value)
      The ID of the subnet in which the NAT gateway is located.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags for the NAT gateway.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags for the NAT gateway.

    • getVpcId

      @Stability(Stable) @Nullable public String getVpcId()
      The ID of the VPC in which the NAT gateway is located.

    • setVpcId

      @Stability(Stable) public void setVpcId(@Nullable String value)
      The ID of the VPC in which the NAT gateway is located.