software.amazon.awscdk.services.ec2

Class NatInstanceProvider

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.NatProvider

software.amazon.awscdk.services.ec2.NatInstanceProvider

All Implemented Interfaces:

IConnectable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-08T20:48:12.703Z")
 @Stability(value=Stable)
public class NatInstanceProvider
extends NatProvider
implements IConnectable

NAT provider which uses NAT Instances.

Example:

 // Configure the `natGatewayProvider` when defining a Vpc
 NatInstanceProvider natGatewayProvider = NatProvider.instance(NatInstanceProps.builder()
         .instanceType(new InstanceType("t3.small"))
         .build());
 Vpc vpc = Vpc.Builder.create(this, "MyVpc")
         .natGatewayProvider(natGatewayProvider)
         // The 'natGateways' parameter now controls the number of NAT instances
         .natGateways(2)
         .build();
 

Nested Class Summary

Nested Classes

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
ISecurityGroup	getSecurityGroup() The Security Group associated with the NAT instances.

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

gateway, gateway, instance

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

Constructor Detail

NatInstanceProvider

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

NatInstanceProvider

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

NatInstanceProvider

@Stability(value=Stable)
public NatInstanceProvider(@NotNull
                                                    NatInstanceProps props)

Parameters:

props - This parameter is required.

Method Detail

configureNat

@Stability(value=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(value=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(value=Stable)
 @NotNull
public List<GatewayConfig> getConfiguredGateways()

Return list of gateways spawned by the provider.

Specified by:

getConfiguredGateways in class NatProvider

getConnections

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

Manage the Security Groups associated with the NAT instances.

Specified by:

getConnections in interface IConnectable

getSecurityGroup

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

The Security Group associated with the NAT instances.