Package software.amazon.awscdk.services.ec2

Class CfnNatGateway.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnNatGateway.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnNatGateway>

Enclosing class:

CfnNatGateway

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

A fluent builder for CfnNatGateway.

Method Summary

Modifier and Type	Method	Description
CfnNatGateway.Builder	allocationId(String allocationId)	[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
CfnNatGateway.Builder	allocationId(IEIPRef allocationId)	[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
CfnNatGateway.Builder	availabilityMode(String availabilityMode)	Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.
CfnNatGateway.Builder	availabilityZoneAddresses(List<? extends Object> availabilityZoneAddresses)	For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ.
CfnNatGateway.Builder	availabilityZoneAddresses(IResolvable availabilityZoneAddresses)	For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ.
CfnNatGateway	build()
CfnNatGateway.Builder	connectivityType(String connectivityType)	Indicates whether the NAT gateway supports public or private connectivity.
static CfnNatGateway.Builder	create(software.constructs.Construct scope, String id)
CfnNatGateway.Builder	maxDrainDurationSeconds(Number maxDrainDurationSeconds)	The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.
CfnNatGateway.Builder	privateIpAddress(String privateIpAddress)	The private IPv4 address to assign to the NAT gateway.
CfnNatGateway.Builder	secondaryAllocationIds(List<String> secondaryAllocationIds)	Secondary EIP allocation IDs.
CfnNatGateway.Builder	secondaryPrivateIpAddressCount(Number secondaryPrivateIpAddressCount)	[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.
CfnNatGateway.Builder	secondaryPrivateIpAddresses(List<String> secondaryPrivateIpAddresses)	Secondary private IPv4 addresses.
CfnNatGateway.Builder	subnetId(String subnetId)	The ID of the subnet in which the NAT gateway is located.
CfnNatGateway.Builder	subnetId(ISubnetRef subnetId)	The ID of the subnet in which the NAT gateway is located.
CfnNatGateway.Builder	tags(List<? extends CfnTag> tags)	The tags for the NAT gateway.
CfnNatGateway.Builder	vpcId(String vpcId)	The ID of the VPC in which the NAT gateway is located.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnNatGateway.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnNatGateway.Builder.

allocationId

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

[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.

This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.

Parameters:

allocationId - [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid

allocationId

@Stability(Stable)
public CfnNatGateway.Builder allocationId(IEIPRef allocationId)

[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.

This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.

Parameters:

allocationId - [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid

availabilityMode

@Stability(Stable)
public CfnNatGateway.Builder availabilityMode(String availabilityMode)

Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

A zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

Parameters:

availabilityMode - Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-availabilitymode

availabilityZoneAddresses

@Stability(Stable)
public CfnNatGateway.Builder availabilityZoneAddresses(IResolvable availabilityZoneAddresses)

For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ.

The regional NAT gateway uses these EIPs to handle outbound NAT traffic from their respective AZs. If not specified, the NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface. If you specify this parameter, auto-expansion is disabled and you must manually manage AZ coverage.

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

Parameters:

availabilityZoneAddresses - For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-availabilityzoneaddresses

availabilityZoneAddresses

@Stability(Stable)
public CfnNatGateway.Builder availabilityZoneAddresses(List<? extends Object> availabilityZoneAddresses)

For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ.

The regional NAT gateway uses these EIPs to handle outbound NAT traffic from their respective AZs. If not specified, the NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface. If you specify this parameter, auto-expansion is disabled and you must manually manage AZ coverage.

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

Parameters:

availabilityZoneAddresses - For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-availabilityzoneaddresses

connectivityType

@Stability(Stable)
public CfnNatGateway.Builder connectivityType(String connectivityType)

Indicates whether the NAT gateway supports public or private connectivity.

The default is public connectivity.

Parameters:

connectivityType - Indicates whether the NAT gateway supports public or private connectivity. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-connectivitytype

maxDrainDurationSeconds

@Stability(Stable)
public CfnNatGateway.Builder maxDrainDurationSeconds(Number maxDrainDurationSeconds)

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.

Default value is 350 seconds.

Parameters:

maxDrainDurationSeconds - The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-maxdraindurationseconds

privateIpAddress

@Stability(Stable)
public CfnNatGateway.Builder privateIpAddress(String privateIpAddress)

The private IPv4 address to assign to the NAT gateway.

If you don't provide an address, a private IPv4 address will be automatically assigned.

Parameters:

privateIpAddress - The private IPv4 address to assign to the NAT gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-privateipaddress

secondaryAllocationIds

@Stability(Stable)
public CfnNatGateway.Builder secondaryAllocationIds(List<String> secondaryAllocationIds)

Secondary EIP allocation IDs.

For more information, see Create a NAT gateway in the Amazon VPC User Guide .

Parameters:

secondaryAllocationIds - Secondary EIP allocation IDs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryallocationids

secondaryPrivateIpAddressCount

@Stability(Stable)
public CfnNatGateway.Builder secondaryPrivateIpAddressCount(Number secondaryPrivateIpAddressCount)

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.

For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide .

SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.

Parameters:

secondaryPrivateIpAddressCount - [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresscount

secondaryPrivateIpAddresses

@Stability(Stable)
public CfnNatGateway.Builder secondaryPrivateIpAddresses(List<String> secondaryPrivateIpAddresses)

Secondary private IPv4 addresses.

For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide .

SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.

Parameters:

secondaryPrivateIpAddresses - Secondary private IPv4 addresses. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresses

subnetId

@Stability(Stable)
public CfnNatGateway.Builder subnetId(String subnetId)

The ID of the subnet in which the NAT gateway is located.

Parameters:

subnetId - The ID of the subnet in which the NAT gateway is located. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-subnetid

subnetId

@Stability(Stable)
public CfnNatGateway.Builder subnetId(ISubnetRef subnetId)

The ID of the subnet in which the NAT gateway is located.

Parameters:

subnetId - The ID of the subnet in which the NAT gateway is located. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-subnetid

tags

@Stability(Stable)
public CfnNatGateway.Builder tags(List<? extends CfnTag> tags)

The tags for the NAT gateway.

Parameters:

tags - The tags for the NAT gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-tags

vpcId

@Stability(Stable)
public CfnNatGateway.Builder vpcId(String vpcId)

The ID of the VPC in which the NAT gateway is located.

Parameters:

vpcId - The ID of the VPC in which the NAT gateway is located. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-vpcid

build

@Stability(Stable)
public CfnNatGateway build()

Specified by:

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

Returns:

a newly built instance of CfnNatGateway.