Package software.amazon.awscdk.services.ec2

Class CfnSubnet.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnSubnet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSubnet>

Enclosing class:

CfnSubnet

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

A fluent builder for CfnSubnet.

Method Summary

Modifier and Type	Method	Description
CfnSubnet.Builder	assignIpv6AddressOnCreation(Boolean assignIpv6AddressOnCreation)	Indicates whether a network interface created in this subnet receives an IPv6 address.
CfnSubnet.Builder	assignIpv6AddressOnCreation(IResolvable assignIpv6AddressOnCreation)	Indicates whether a network interface created in this subnet receives an IPv6 address.
CfnSubnet.Builder	availabilityZone(String availabilityZone)	The Availability Zone of the subnet.
CfnSubnet.Builder	availabilityZoneId(String availabilityZoneId)	The AZ ID of the subnet.
CfnSubnet	build()
CfnSubnet.Builder	cidrBlock(String cidrBlock)	The IPv4 CIDR block assigned to the subnet.
static CfnSubnet.Builder	create(software.constructs.Construct scope, String id)
CfnSubnet.Builder	enableDns64(Boolean enableDns64)	Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
CfnSubnet.Builder	enableDns64(IResolvable enableDns64)	Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
CfnSubnet.Builder	enableLniAtDeviceIndex(Number enableLniAtDeviceIndex)	Indicates the device position for local network interfaces in this subnet.
CfnSubnet.Builder	ipv4IpamPoolId(String ipv4IpamPoolId)	An IPv4 IPAM pool ID for the subnet.
CfnSubnet.Builder	ipv4NetmaskLength(Number ipv4NetmaskLength)	An IPv4 netmask length for the subnet.
CfnSubnet.Builder	ipv6CidrBlock(String ipv6CidrBlock)	The IPv6 CIDR block.
CfnSubnet.Builder	ipv6IpamPoolId(String ipv6IpamPoolId)	An IPv6 IPAM pool ID for the subnet.
CfnSubnet.Builder	ipv6Native(Boolean ipv6Native)	Indicates whether this is an IPv6 only subnet.
CfnSubnet.Builder	ipv6Native(IResolvable ipv6Native)	Indicates whether this is an IPv6 only subnet.
CfnSubnet.Builder	ipv6NetmaskLength(Number ipv6NetmaskLength)	An IPv6 netmask length for the subnet.
CfnSubnet.Builder	mapPublicIpOnLaunch(Boolean mapPublicIpOnLaunch)	Indicates whether instances launched in this subnet receive a public IPv4 address.
CfnSubnet.Builder	mapPublicIpOnLaunch(IResolvable mapPublicIpOnLaunch)	Indicates whether instances launched in this subnet receive a public IPv4 address.
CfnSubnet.Builder	outpostArn(String outpostArn)	The Amazon Resource Name (ARN) of the Outpost.
CfnSubnet.Builder	privateDnsNameOptionsOnLaunch(Object privateDnsNameOptionsOnLaunch)	The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled.
CfnSubnet.Builder	tags(List<? extends CfnTag> tags)	Any tags assigned to the subnet.
CfnSubnet.Builder	vpcId(String vpcId)	The ID of the VPC the subnet is in.

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 CfnSubnet.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 CfnSubnet.Builder.

vpcId

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

The ID of the VPC the subnet is in.

If you update this property, you must also update the CidrBlock property.

Parameters:

vpcId - The ID of the VPC the subnet is in. This parameter is required.

Returns:

this

See Also:

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

assignIpv6AddressOnCreation

@Stability(Stable)
public CfnSubnet.Builder assignIpv6AddressOnCreation(Boolean assignIpv6AddressOnCreation)

Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false .

If you specify AssignIpv6AddressOnCreation , you must also specify an IPv6 CIDR block.

Parameters:

assignIpv6AddressOnCreation - Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false . This parameter is required.

Returns:

this

See Also:

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

assignIpv6AddressOnCreation

@Stability(Stable)
public CfnSubnet.Builder assignIpv6AddressOnCreation(IResolvable assignIpv6AddressOnCreation)

Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false .

If you specify AssignIpv6AddressOnCreation , you must also specify an IPv6 CIDR block.

Parameters:

assignIpv6AddressOnCreation - Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false . This parameter is required.

Returns:

this

See Also:

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

availabilityZone

@Stability(Stable)
public CfnSubnet.Builder availabilityZone(String availabilityZone)

The Availability Zone of the subnet.

If you update this property, you must also update the CidrBlock property.

Parameters:

availabilityZone - The Availability Zone of the subnet. This parameter is required.

Returns:

this

See Also:

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

availabilityZoneId

@Stability(Stable)
public CfnSubnet.Builder availabilityZoneId(String availabilityZoneId)

The AZ ID of the subnet.

Parameters:

availabilityZoneId - The AZ ID of the subnet. This parameter is required.

Returns:

this

See Also:

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

cidrBlock

@Stability(Stable)
public CfnSubnet.Builder cidrBlock(String cidrBlock)

The IPv4 CIDR block assigned to the subnet.

If you update this property, we create a new subnet, and then delete the existing one.

Parameters:

cidrBlock - The IPv4 CIDR block assigned to the subnet. This parameter is required.

Returns:

this

See Also:

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

enableDns64

@Stability(Stable)
public CfnSubnet.Builder enableDns64(Boolean enableDns64)

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a 0.0.0.0/0 route pointing to the internet gateway. For more information, see Configure DNS64 and NAT64 in the Amazon Virtual Private Cloud User Guide .

Parameters:

enableDns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. This parameter is required.

Returns:

this

See Also:

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

enableDns64

@Stability(Stable)
public CfnSubnet.Builder enableDns64(IResolvable enableDns64)

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a 0.0.0.0/0 route pointing to the internet gateway. For more information, see Configure DNS64 and NAT64 in the Amazon Virtual Private Cloud User Guide .

Parameters:

enableDns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. This parameter is required.

Returns:

this

See Also:

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

enableLniAtDeviceIndex

@Stability(Stable)
public CfnSubnet.Builder enableLniAtDeviceIndex(Number enableLniAtDeviceIndex)

Indicates the device position for local network interfaces in this subnet.

For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).

Parameters:

enableLniAtDeviceIndex - Indicates the device position for local network interfaces in this subnet. This parameter is required.

Returns:

this

See Also:

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

ipv4IpamPoolId

@Stability(Stable)
public CfnSubnet.Builder ipv4IpamPoolId(String ipv4IpamPoolId)

An IPv4 IPAM pool ID for the subnet.

Parameters:

ipv4IpamPoolId - An IPv4 IPAM pool ID for the subnet. This parameter is required.

Returns:

this

See Also:

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

ipv4NetmaskLength

@Stability(Stable)
public CfnSubnet.Builder ipv4NetmaskLength(Number ipv4NetmaskLength)

An IPv4 netmask length for the subnet.

Parameters:

ipv4NetmaskLength - An IPv4 netmask length for the subnet. This parameter is required.

Returns:

this

See Also:

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

ipv6CidrBlock

@Stability(Stable)
public CfnSubnet.Builder ipv6CidrBlock(String ipv6CidrBlock)

The IPv6 CIDR block.

If you specify AssignIpv6AddressOnCreation , you must also specify an IPv6 CIDR block.

Parameters:

ipv6CidrBlock - The IPv6 CIDR block. This parameter is required.

Returns:

this

See Also:

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

ipv6IpamPoolId

@Stability(Stable)
public CfnSubnet.Builder ipv6IpamPoolId(String ipv6IpamPoolId)

An IPv6 IPAM pool ID for the subnet.

Parameters:

ipv6IpamPoolId - An IPv6 IPAM pool ID for the subnet. This parameter is required.

Returns:

this

See Also:

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

ipv6Native

@Stability(Stable)
public CfnSubnet.Builder ipv6Native(Boolean ipv6Native)

Indicates whether this is an IPv6 only subnet.

For more information, see Subnet basics in the Amazon Virtual Private Cloud User Guide .

Parameters:

ipv6Native - Indicates whether this is an IPv6 only subnet. This parameter is required.

Returns:

this

See Also:

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

ipv6Native

@Stability(Stable)
public CfnSubnet.Builder ipv6Native(IResolvable ipv6Native)

Indicates whether this is an IPv6 only subnet.

For more information, see Subnet basics in the Amazon Virtual Private Cloud User Guide .

Parameters:

ipv6Native - Indicates whether this is an IPv6 only subnet. This parameter is required.

Returns:

this

See Also:

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

ipv6NetmaskLength

@Stability(Stable)
public CfnSubnet.Builder ipv6NetmaskLength(Number ipv6NetmaskLength)

An IPv6 netmask length for the subnet.

Parameters:

ipv6NetmaskLength - An IPv6 netmask length for the subnet. This parameter is required.

Returns:

this

See Also:

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

mapPublicIpOnLaunch

@Stability(Stable)
public CfnSubnet.Builder mapPublicIpOnLaunch(Boolean mapPublicIpOnLaunch)

Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is false .

AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the VPC pricing page .

Parameters:

mapPublicIpOnLaunch - Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is false . This parameter is required.

Returns:

this

See Also:

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

mapPublicIpOnLaunch

@Stability(Stable)
public CfnSubnet.Builder mapPublicIpOnLaunch(IResolvable mapPublicIpOnLaunch)

Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is false .

AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the VPC pricing page .

Parameters:

mapPublicIpOnLaunch - Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is false . This parameter is required.

Returns:

this

See Also:

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

outpostArn

@Stability(Stable)
public CfnSubnet.Builder outpostArn(String outpostArn)

The Amazon Resource Name (ARN) of the Outpost.

Parameters:

outpostArn - The Amazon Resource Name (ARN) of the Outpost. This parameter is required.

Returns:

this

See Also:

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

privateDnsNameOptionsOnLaunch

@Stability(Stable)
public CfnSubnet.Builder privateDnsNameOptionsOnLaunch(Object privateDnsNameOptionsOnLaunch)

The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled.

For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide .

Available options:

• EnableResourceNameDnsAAAARecord (true | false)
• EnableResourceNameDnsARecord (true | false)
• HostnameType (ip-name | resource-name)

Parameters:

privateDnsNameOptionsOnLaunch - The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. This parameter is required.

Returns:

this

See Also:

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

tags

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

Any tags assigned to the subnet.

Parameters:

tags - Any tags assigned to the subnet. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSubnet build()

Specified by:

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

Returns:

a newly built instance of CfnSubnet.