software.amazon.awscdk.services.ec2

Class NatProvider

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.NatProvider

Direct Known Subclasses:

NatInstanceProvider

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.124Z")
public abstract class NatProvider
extends software.amazon.jsii.JsiiObject

NAT providers.

Determines what type of NAT provider to create, either NAT gateways or NAT instance.

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();
 

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract void	configureNat(ConfigureNatOptions options) Called by the VPC to configure NAT.
abstract void	configureSubnet(PrivateSubnet subnet) Configures subnet with the gateway.
static NatProvider	gateway() Use NAT Gateways to provide NAT services for your VPC.
static NatProvider	gateway(NatGatewayProps props) Use NAT Gateways to provide NAT services for your VPC.
abstract java.util.List<GatewayConfig>	getConfiguredGateways() Return list of gateways spawned by the provider.
static NatInstanceProvider	instance(NatInstanceProps props) Use NAT instances to provide NAT services for your VPC.

Methods inherited from class java.lang.Object

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

Constructor Detail

NatProvider

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

NatProvider

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

NatProvider

protected NatProvider()

Method Detail

gateway

public static NatProvider gateway(NatGatewayProps props)

Use NAT Gateways to provide NAT services for your VPC.

NAT gateways are managed by AWS.

Parameters:

props -

See Also:

https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html

gateway

public static NatProvider gateway()

Use NAT Gateways to provide NAT services for your VPC.

NAT gateways are managed by AWS.

See Also:

https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html

instance

public static NatInstanceProvider instance(NatInstanceProps props)

Use NAT instances to provide NAT services for your VPC.

NAT instances are managed by you, but in return allow more configuration.

Be aware that instances created using this provider will not be automatically replaced if they are stopped for any reason. You should implement your own NatProvider based on AutoScaling groups if you need that.

Parameters:

props - This parameter is required.

See Also:

https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html

configureNat

public abstract void configureNat(ConfigureNatOptions options)

Called by the VPC to configure NAT.

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

Parameters:

options - This parameter is required.

configureSubnet

public abstract void configureSubnet(PrivateSubnet subnet)

Configures subnet with the gateway.

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

Parameters:

subnet - This parameter is required.

getConfiguredGateways

public abstract java.util.List<GatewayConfig> getConfiguredGateways()

Return list of gateways spawned by the provider.