CfnSubnetProps
- class aws_cdk.aws_ec2.CfnSubnetProps(*, vpc_id, assign_ipv6_address_on_creation=None, availability_zone=None, availability_zone_id=None, cidr_block=None, enable_dns64=None, enable_lni_at_device_index=None, ipv4_ipam_pool_id=None, ipv4_netmask_length=None, ipv6_cidr_block=None, ipv6_ipam_pool_id=None, ipv6_native=None, ipv6_netmask_length=None, map_public_ip_on_launch=None, outpost_arn=None, private_dns_name_options_on_launch=None, tags=None)
Bases:
object
Properties for defining a
CfnSubnet
.- Parameters:
vpc_id (
str
) – The ID of the VPC the subnet is in. If you update this property, you must also update theCidrBlock
property.assign_ipv6_address_on_creation (
Union
[bool
,IResolvable
,None
]) – Indicates whether a network interface created in this subnet receives an IPv6 address. The default value isfalse
. If you specifyAssignIpv6AddressOnCreation
, you must also specify an IPv6 CIDR block.availability_zone (
Optional
[str
]) – The Availability Zone of the subnet. If you update this property, you must also update theCidrBlock
property.availability_zone_id (
Optional
[str
]) – The AZ ID of the subnet.cidr_block (
Optional
[str
]) – The IPv4 CIDR block assigned to the subnet. If you update this property, we create a new subnet, and then delete the existing one.enable_dns64 (
Union
[bool
,IResolvable
,None
]) – Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. .. epigraph:: 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 a0.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 .enable_lni_at_device_index (
Union
[int
,float
,None
]) – 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).ipv4_ipam_pool_id (
Optional
[str
]) – An IPv4 IPAM pool ID for the subnet.ipv4_netmask_length (
Union
[int
,float
,None
]) – An IPv4 netmask length for the subnet.ipv6_cidr_block (
Optional
[str
]) – The IPv6 CIDR block. If you specifyAssignIpv6AddressOnCreation
, you must also specify an IPv6 CIDR block.ipv6_ipam_pool_id (
Optional
[str
]) – An IPv6 IPAM pool ID for the subnet.ipv6_native (
Union
[bool
,IResolvable
,None
]) – Indicates whether this is an IPv6 only subnet. For more information, see Subnet basics in the Amazon Virtual Private Cloud User Guide .ipv6_netmask_length (
Union
[int
,float
,None
]) – An IPv6 netmask length for the subnet.map_public_ip_on_launch (
Union
[bool
,IResolvable
,None
]) – Indicates whether instances launched in this subnet receive a public IPv4 address. The default value isfalse
. 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 .outpost_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the Outpost.private_dns_name_options_on_launch (
Any
) – 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)tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Any tags assigned to the subnet.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ec2 as ec2 # private_dns_name_options_on_launch: Any cfn_subnet_props = ec2.CfnSubnetProps( vpc_id="vpcId", # the properties below are optional assign_ipv6_address_on_creation=False, availability_zone="availabilityZone", availability_zone_id="availabilityZoneId", cidr_block="cidrBlock", enable_dns64=False, enable_lni_at_device_index=123, ipv4_ipam_pool_id="ipv4IpamPoolId", ipv4_netmask_length=123, ipv6_cidr_block="ipv6CidrBlock", ipv6_ipam_pool_id="ipv6IpamPoolId", ipv6_native=False, ipv6_netmask_length=123, map_public_ip_on_launch=False, outpost_arn="outpostArn", private_dns_name_options_on_launch=private_dns_name_options_on_launch, tags=[CfnTag( key="key", value="value" )] )
Attributes
- assign_ipv6_address_on_creation
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.
- availability_zone
The Availability Zone of the subnet.
If you update this property, you must also update the
CidrBlock
property.
- availability_zone_id
The AZ ID of the subnet.
- cidr_block
The IPv4 CIDR block assigned to the subnet.
If you update this property, we create a new subnet, and then delete the existing one.
- enable_dns64
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 .
- enable_lni_at_device_index
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).
- ipv4_ipam_pool_id
An IPv4 IPAM pool ID for the subnet.
- ipv4_netmask_length
An IPv4 netmask length for the subnet.
- ipv6_cidr_block
The IPv6 CIDR block.
If you specify
AssignIpv6AddressOnCreation
, you must also specify an IPv6 CIDR block.
- ipv6_ipam_pool_id
An IPv6 IPAM pool ID for the subnet.
- ipv6_native
Indicates whether this is an IPv6 only subnet.
For more information, see Subnet basics in the Amazon Virtual Private Cloud User Guide .
- ipv6_netmask_length
An IPv6 netmask length for the subnet.
- map_public_ip_on_launch
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 .
- outpost_arn
The Amazon Resource Name (ARN) of the Outpost.
- private_dns_name_options_on_launch
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)
- tags
Any tags assigned to the subnet.
- vpc_id
The ID of the VPC the subnet is in.
If you update this property, you must also update the
CidrBlock
property.