Package software.amazon.awscdk.services.ec2

Class NatGatewayProvider

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.NatProvider

software.amazon.awscdk.services.ec2.NatGatewayProvider

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:35.401Z")
@Stability(Stable)
public class NatGatewayProvider
extends NatProvider

Provider for NAT Gateways.

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.*;
 NatGatewayProvider natGatewayProvider = NatGatewayProvider.Builder.create()
         .eipAllocationIds(List.of("eipAllocationIds"))
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	NatGatewayProvider()
	NatGatewayProvider(NatGatewayProps props)
protected	NatGatewayProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NatGatewayProvider(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.

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

Constructor Details

NatGatewayProvider

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

NatGatewayProvider

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

NatGatewayProvider

@Stability(Stable)
public NatGatewayProvider(@Nullable
 NatGatewayProps props)

Parameters:

props -

NatGatewayProvider

@Stability(Stable)
public NatGatewayProvider()

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