Package software.amazon.awscdk.services.ec2.alpha

Class NatGateway

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.alpha.NatGateway

All Implemented Interfaces:

IResource, IRouteTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-13T21:17:43.030Z")
@Stability(Experimental)
public class NatGateway
extends Resource
implements IRouteTarget

(experimental) Creates a network address translation (NAT) gateway.

Example:

 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.PRIVATE_ISOLATED)
         .build();
 NatGateway natgw = NatGateway.Builder.create(this, "NatGW")
         .subnet(subnet)
         .vpc(myVpc)
         .connectivityType(NatConnectivityType.PRIVATE)
         .privateIpAddress("10.0.0.42")
         .build();
 Route.Builder.create(this, "NatGwRoute")
         .routeTable(routeTable)
         .destination("0.0.0.0/0")
         .target(Map.of("gateway", natgw))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NatGateway.Builder	(experimental) A fluent builder for NatGateway.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.alpha.IRouteTarget

IRouteTarget.Jsii$Default, IRouteTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NatGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NatGateway(software.amazon.jsii.JsiiObjectRef objRef)
	NatGateway(software.constructs.Construct scope, String id, NatGatewayProps props)

Method Summary

Modifier and Type	Method	Description
NatConnectivityType	getConnectivityType()	(experimental) Indicates whether the NAT gateway supports public or private connectivity.
Duration	getMaxDrainDuration()	(experimental) The maximum amount of time to wait before forcibly releasing the IP addresses if connections are still in progress.
CfnNatGateway	getResource()	(experimental) The NAT gateway CFN resource.
String	getRouterTargetId()	(experimental) The ID of the route target.
RouterType	getRouterType()	(experimental) The type of router used in the route.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

NatGateway

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

NatGateway

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

NatGateway

@Stability(Experimental)
public NatGateway(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 NatGatewayProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getResource

@Stability(Experimental)
@NotNull
public CfnNatGateway getResource()

(experimental) The NAT gateway CFN resource.

getRouterTargetId

@Stability(Experimental)
@NotNull
public String getRouterTargetId()

(experimental) The ID of the route target.

Specified by:

getRouterTargetId in interface IRouteTarget

getRouterType

@Stability(Experimental)
@NotNull
public RouterType getRouterType()

(experimental) The type of router used in the route.

Specified by:

getRouterType in interface IRouteTarget

getConnectivityType

@Stability(Experimental)
@Nullable
public NatConnectivityType getConnectivityType()

(experimental) Indicates whether the NAT gateway supports public or private connectivity.

Default: public

getMaxDrainDuration

@Stability(Experimental)
@Nullable
public Duration getMaxDrainDuration()

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

Default: '350 seconds'