Package software.amazon.awscdk.services.ec2

Class RegionalNatGatewayProviderProps.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.RegionalNatGatewayProviderProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RegionalNatGatewayProviderProps>

Enclosing interface:

RegionalNatGatewayProviderProps

@Stability(Stable)
public static final class RegionalNatGatewayProviderProps.Builder
extends Object
implements software.amazon.jsii.Builder<RegionalNatGatewayProviderProps>

A builder for RegionalNatGatewayProviderProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RegionalNatGatewayProviderProps.Builder	allocationId(String allocationId)	Sets the value of RegionalNatGatewayProviderProps.getAllocationId()
RegionalNatGatewayProviderProps.Builder	availabilityZoneAddresses(List<? extends AvailabilityZoneAddress> availabilityZoneAddresses)	Sets the value of RegionalNatGatewayProviderProps.getAvailabilityZoneAddresses()
RegionalNatGatewayProviderProps	build()	Builds the configured instance.
RegionalNatGatewayProviderProps.Builder	eip(IEIPRef eip)	Sets the value of RegionalNatGatewayProviderProps.getEip()
RegionalNatGatewayProviderProps.Builder	maxDrainDuration(Duration maxDrainDuration)	Sets the value of RegionalNatGatewayProviderProps.getMaxDrainDuration()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

allocationId

@Stability(Stable)
public RegionalNatGatewayProviderProps.Builder allocationId(String allocationId)

Sets the value of RegionalNatGatewayProviderProps.getAllocationId()

Parameters:

allocationId - The allocation ID of the Elastic IP address to use for this NAT gateway. Cannot be specified together with eip. Ignored when availabilityZoneAddresses is specified.

Returns:

this

availabilityZoneAddresses

@Stability(Stable)
public RegionalNatGatewayProviderProps.Builder availabilityZoneAddresses(List<? extends AvailabilityZoneAddress> availabilityZoneAddresses)

Sets the value of RegionalNatGatewayProviderProps.getAvailabilityZoneAddresses()

Parameters:

availabilityZoneAddresses - Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses to use in each AZ. When specified, allocationId and eip are ignored. This enables manual mode for Regional NAT Gateway where you control EIP allocation per AZ.

In manual mode the gateway only serves the listed Availability Zones and does not expand to other zones automatically, so every Availability Zone that contains a private subnet routed through this gateway must be listed. When the zone names are known at synthesis time, a private subnet in an unlisted zone is rejected with an error. Entries that use availabilityZoneId or unresolved tokens cannot be checked and are assumed to be correct.

Returns:

this

eip

@Stability(Stable)
public RegionalNatGatewayProviderProps.Builder eip(IEIPRef eip)

Sets the value of RegionalNatGatewayProviderProps.getEip()

Parameters:

eip - Reference to an existing EIP to use for this NAT gateway. Cannot be specified together with allocationId. Ignored when availabilityZoneAddresses is specified.

Returns:

this

maxDrainDuration

@Stability(Stable)
public RegionalNatGatewayProviderProps.Builder maxDrainDuration(Duration maxDrainDuration)

Sets the value of RegionalNatGatewayProviderProps.getMaxDrainDuration()

Parameters:

maxDrainDuration - Maximum amount of time to wait before forcibly releasing IP addresses if connections are still in progress.

Returns:

this

build

@Stability(Stable)
public RegionalNatGatewayProviderProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<RegionalNatGatewayProviderProps>

Returns:

a new instance of RegionalNatGatewayProviderProps

Throws:

NullPointerException - if any required attribute was not provided