software.amazon.awscdk.services.ec2

Class CfnNatGateway

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ec2.CfnNatGateway

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.582Z")
public class CfnNatGateway
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::NatGateway`.

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.

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.

For more information, see NAT Gateways 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")
         .subnetId("subnetId")
         // the properties below are optional
         .allocationId("allocationId")
         .connectivityType("connectivityType")
         .maxDrainDurationSeconds(123)
         .privateIpAddress("privateIpAddress")
         .secondaryAllocationIds(List.of("secondaryAllocationIds"))
         .secondaryPrivateIpAddressCount(123)
         .secondaryPrivateIpAddresses(List.of("secondaryPrivateIpAddresses"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnNatGateway.Builder A fluent builder for CfnNatGateway.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnNatGateway(Construct scope, java.lang.String id, CfnNatGatewayProps props) Create a new `AWS::EC2::NatGateway`.
protected	CfnNatGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNatGateway(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAllocationId() [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
java.lang.String	getAttrNatGatewayId() The ID of the NAT gateway.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getConnectivityType() Indicates whether the NAT gateway supports public or private connectivity.
java.lang.Number	getMaxDrainDurationSeconds() The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.
java.lang.String	getPrivateIpAddress() The private IPv4 address to assign to the NAT gateway.
java.util.List<java.lang.String>	getSecondaryAllocationIds() Secondary EIP allocation IDs.
java.lang.Number	getSecondaryPrivateIpAddressCount() [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.
java.util.List<java.lang.String>	getSecondaryPrivateIpAddresses() Secondary private IPv4 addresses.
java.lang.String	getSubnetId() The ID of the subnet in which the NAT gateway is located.
TagManager	getTags() The tags for the NAT gateway.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAllocationId(java.lang.String value) [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
void	setConnectivityType(java.lang.String value) Indicates whether the NAT gateway supports public or private connectivity.
void	setMaxDrainDurationSeconds(java.lang.Number value) The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.
void	setPrivateIpAddress(java.lang.String value) The private IPv4 address to assign to the NAT gateway.
void	setSecondaryAllocationIds(java.util.List<java.lang.String> value) Secondary EIP allocation IDs.
void	setSecondaryPrivateIpAddressCount(java.lang.Number value) [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.
void	setSecondaryPrivateIpAddresses(java.util.List<java.lang.String> value) Secondary private IPv4 addresses.
void	setSubnetId(java.lang.String value) The ID of the subnet in which the NAT gateway is located.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnNatGateway

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

CfnNatGateway

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

CfnNatGateway

public CfnNatGateway(Construct scope,
                     java.lang.String id,
                     CfnNatGatewayProps props)

Create a new `AWS::EC2::NatGateway`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrNatGatewayId

public java.lang.String getAttrNatGatewayId()

The ID of the NAT gateway.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags for the NAT gateway.

getSubnetId

public java.lang.String getSubnetId()

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

setSubnetId

public void setSubnetId(java.lang.String value)

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

getAllocationId

public java.lang.String 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.

setAllocationId

public void setAllocationId(java.lang.String value)

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

getConnectivityType

public java.lang.String getConnectivityType()

Indicates whether the NAT gateway supports public or private connectivity.

The default is public connectivity.

setConnectivityType

public void setConnectivityType(java.lang.String value)

Indicates whether the NAT gateway supports public or private connectivity.

The default is public connectivity.

getMaxDrainDurationSeconds

public java.lang.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.

setMaxDrainDurationSeconds

public void setMaxDrainDurationSeconds(java.lang.Number value)

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.

getPrivateIpAddress

public java.lang.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.

setPrivateIpAddress

public void setPrivateIpAddress(java.lang.String value)

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.

getSecondaryAllocationIds

public java.util.List<java.lang.String> getSecondaryAllocationIds()

Secondary EIP allocation IDs.

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

setSecondaryAllocationIds

public void setSecondaryAllocationIds(java.util.List<java.lang.String> value)

Secondary EIP allocation IDs.

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

getSecondaryPrivateIpAddressCount

public java.lang.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.

setSecondaryPrivateIpAddressCount

public void setSecondaryPrivateIpAddressCount(java.lang.Number value)

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

getSecondaryPrivateIpAddresses

public java.util.List<java.lang.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.

setSecondaryPrivateIpAddresses

public void setSecondaryPrivateIpAddresses(java.util.List<java.lang.String> value)

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.