Package software.amazon.awscdk.services.ec2

Class NatInstanceProviderV2

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.NatProvider

software.amazon.awscdk.services.ec2.NatInstanceProviderV2

All Implemented Interfaces:

IConnectable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.209Z")
@Stability(Stable)
public class NatInstanceProviderV2
extends NatProvider
implements IConnectable

Modern NAT provider which uses NAT Instances.

The instance uses Amazon Linux 2023 as the operating system.

Example:

 NatInstanceProviderV2 natGatewayProvider = NatProvider.instanceV2(NatInstanceProps.builder()
         .instanceType(new InstanceType("t3.small"))
         .defaultAllowedTraffic(NatTrafficDirection.NONE)
         .build());
 Vpc vpc = Vpc.Builder.create(this, "Vpc").natGatewayProvider(natGatewayProvider).build();
 SecurityGroup securityGroup = SecurityGroup.Builder.create(this, "SecurityGroup")
         .vpc(vpc)
         .allowAllOutbound(false)
         .build();
 securityGroup.addEgressRule(Peer.anyIpv4(), Port.tcp(443));
 for (Object gatewayInstance : natGatewayProvider.getGatewayInstances()) {
     gatewayInstance.addSecurityGroup(securityGroup);
 }
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	DEFAULT_USER_DATA_COMMANDS	Amazon Linux 2023 NAT instance user data commands Enable iptables on the instance, enable persistent IP forwarding, configure NAT on instance.

Constructor Summary

Constructors

Modifier	Constructor	Description
	NatInstanceProviderV2(NatInstanceProps props)
protected	NatInstanceProviderV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NatInstanceProviderV2(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	configureNat(ConfigureNatOptions options)	Called by the VPC to configure NAT.
void	configureSubnet(PrivateSubnet subnet)	Configures subnet with the gateway.
List<GatewayConfig>	getConfiguredGateways()	Return list of gateways spawned by the provider.
Connections	getConnections()	Manage the Security Groups associated with the NAT instances.
List<Instance>	getGatewayInstances()	Array of gateway instances spawned by the provider after internal configuration.
ISecurityGroup	getSecurityGroup()	The Security Group associated with the NAT instances.

Methods inherited from class software.amazon.awscdk.services.ec2.NatProvider

gateway, gateway, instance, instanceV2

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

DEFAULT_USER_DATA_COMMANDS

@Stability(Stable)
public static final List<String> DEFAULT_USER_DATA_COMMANDS

Amazon Linux 2023 NAT instance user data commands Enable iptables on the instance, enable persistent IP forwarding, configure NAT on instance.

See Also:

• https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html#create-nat-ami

Constructor Details

NatInstanceProviderV2

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

NatInstanceProviderV2

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

NatInstanceProviderV2

@Stability(Stable)
public NatInstanceProviderV2(@NotNull
 NatInstanceProps props)

Parameters:

props - This parameter is required.

Method Details

configureNat

@Stability(Stable)
public void configureNat(@NotNull
 ConfigureNatOptions options)

Called by the VPC to configure NAT.

Don't call this directly, the VPC will call it automatically.

Specified by:

configureNat in class NatProvider

Parameters:

options - This parameter is required.

configureSubnet

@Stability(Stable)
public void configureSubnet(@NotNull
 PrivateSubnet subnet)

Configures subnet with the gateway.

Don't call this directly, the VPC will call it automatically.

Specified by:

configureSubnet in class NatProvider

Parameters:

subnet - This parameter is required.

getConfiguredGateways

@Stability(Stable)
@NotNull
public List<GatewayConfig> getConfiguredGateways()

Return list of gateways spawned by the provider.

Specified by:

getConfiguredGateways in class NatProvider

getConnections

@Stability(Stable)
@NotNull
public Connections getConnections()

Manage the Security Groups associated with the NAT instances.

Specified by:

getConnections in interface IConnectable

getGatewayInstances

@Stability(Stable)
@NotNull
public List<Instance> getGatewayInstances()

Array of gateway instances spawned by the provider after internal configuration.

getSecurityGroup

@Stability(Stable)
@NotNull
public ISecurityGroup getSecurityGroup()

The Security Group associated with the NAT instances.