Package software.amazon.awscdk.services.ec2

Interface CfnSubnetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSubnetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:57.062Z")
@Stability(Stable)
public interface CfnSubnetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSubnet.

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.*;
 Object privateDnsNameOptionsOnLaunch;
 CfnSubnetProps cfnSubnetProps = CfnSubnetProps.builder()
         .vpcId("vpcId")
         // the properties below are optional
         .assignIpv6AddressOnCreation(false)
         .availabilityZone("availabilityZone")
         .availabilityZoneId("availabilityZoneId")
         .cidrBlock("cidrBlock")
         .enableDns64(false)
         .enableLniAtDeviceIndex(123)
         .ipv4IpamPoolId("ipv4IpamPoolId")
         .ipv4NetmaskLength(123)
         .ipv6CidrBlock("ipv6CidrBlock")
         .ipv6IpamPoolId("ipv6IpamPoolId")
         .ipv6Native(false)
         .ipv6NetmaskLength(123)
         .mapPublicIpOnLaunch(false)
         .outpostArn("outpostArn")
         .privateDnsNameOptionsOnLaunch(privateDnsNameOptionsOnLaunch)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSubnetProps.Builder	A builder for CfnSubnetProps
static final class	CfnSubnetProps.Jsii$Proxy	An implementation for CfnSubnetProps

Method Summary

Modifier and Type	Method	Description
static CfnSubnetProps.Builder	builder()
default Object	getAssignIpv6AddressOnCreation()	Indicates whether a network interface created in this subnet receives an IPv6 address.
default String	getAvailabilityZone()	The Availability Zone of the subnet.
default String	getAvailabilityZoneId()	The AZ ID of the subnet.
default String	getCidrBlock()	The IPv4 CIDR block assigned to the subnet.
default Object	getEnableDns64()	Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
default Number	getEnableLniAtDeviceIndex()	Indicates the device position for local network interfaces in this subnet.
default String	getIpv4IpamPoolId()	An IPv4 IPAM pool ID for the subnet.
default Number	getIpv4NetmaskLength()	An IPv4 netmask length for the subnet.
default String	getIpv6CidrBlock()	The IPv6 CIDR block.
default String	getIpv6IpamPoolId()	An IPv6 IPAM pool ID for the subnet.
default Object	getIpv6Native()	Indicates whether this is an IPv6 only subnet.
default Number	getIpv6NetmaskLength()	An IPv6 netmask length for the subnet.
default Object	getMapPublicIpOnLaunch()	Indicates whether instances launched in this subnet receive a public IPv4 address.
default String	getOutpostArn()	The Amazon Resource Name (ARN) of the Outpost.
default Object	getPrivateDnsNameOptionsOnLaunch()	The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled.
default List<CfnTag>	getTags()	Any tags assigned to the subnet.
String	getVpcId()	The ID of the VPC the subnet is in.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVpcId

@Stability(Stable)
@NotNull
String getVpcId()

The ID of the VPC the subnet is in.

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

See Also:

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

getAssignIpv6AddressOnCreation

@Stability(Stable)
@Nullable
default Object getAssignIpv6AddressOnCreation()

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.

See Also:

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

getAvailabilityZone

@Stability(Stable)
@Nullable
default String getAvailabilityZone()

The Availability Zone of the subnet.

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

See Also:

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

getAvailabilityZoneId

@Stability(Stable)
@Nullable
default String getAvailabilityZoneId()

The AZ ID of the subnet.

See Also:

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

getCidrBlock

@Stability(Stable)
@Nullable
default String getCidrBlock()

The IPv4 CIDR block assigned to the subnet.

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

See Also:

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

getEnableDns64

@Stability(Stable)
@Nullable
default Object getEnableDns64()

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 .

See Also:

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

getEnableLniAtDeviceIndex

@Stability(Stable)
@Nullable
default Number getEnableLniAtDeviceIndex()

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).

See Also:

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

getIpv4IpamPoolId

@Stability(Stable)
@Nullable
default String getIpv4IpamPoolId()

An IPv4 IPAM pool ID for the subnet.

See Also:

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

getIpv4NetmaskLength

@Stability(Stable)
@Nullable
default Number getIpv4NetmaskLength()

An IPv4 netmask length for the subnet.

See Also:

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

getIpv6CidrBlock

@Stability(Stable)
@Nullable
default String getIpv6CidrBlock()

The IPv6 CIDR block.

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

See Also:

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

getIpv6IpamPoolId

@Stability(Stable)
@Nullable
default String getIpv6IpamPoolId()

An IPv6 IPAM pool ID for the subnet.

See Also:

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

getIpv6Native

@Stability(Stable)
@Nullable
default Object getIpv6Native()

Indicates whether this is an IPv6 only subnet.

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

See Also:

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

getIpv6NetmaskLength

@Stability(Stable)
@Nullable
default Number getIpv6NetmaskLength()

An IPv6 netmask length for the subnet.

See Also:

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

getMapPublicIpOnLaunch

@Stability(Stable)
@Nullable
default Object getMapPublicIpOnLaunch()

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 .

See Also:

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

getOutpostArn

@Stability(Stable)
@Nullable
default String getOutpostArn()

The Amazon Resource Name (ARN) of the Outpost.

See Also:

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

getPrivateDnsNameOptionsOnLaunch

@Stability(Stable)
@Nullable
default Object getPrivateDnsNameOptionsOnLaunch()

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)

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Any tags assigned to the subnet.

See Also:

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

builder

@Stability(Stable)
static CfnSubnetProps.Builder builder()

Returns:

a CfnSubnetProps.Builder of CfnSubnetProps