Skip to main content

subnets_list_only

Lists subnets in a region or regions, for all properties use subnets

Overview

Namesubnets_list_only
TypeResource
DescriptionSpecifies a subnet for the specified VPC.
For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.
Idaws.ec2.subnets_list_only

Fields

NameDatatypeDescription
assign_ipv6_address_on_creationbooleanIndicates 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.
vpc_idstringThe ID of the VPC the subnet is in.
If you update this property, you must also update the CidrBlock property.
map_public_ip_on_launchbooleanIndicates 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](https://docs.aws.amazon.com/vpc/pricing/).
enable_lni_at_device_indexintegerIndicates 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).
network_acl_association_idstring
availability_zonestringThe Availability Zone of the subnet.
If you update this property, you must also update the CidrBlock property.
availability_zone_idstringThe AZ ID of the subnet.
cidr_blockstringThe IPv4 CIDR block assigned to the subnet.
If you update this property, we create a new subnet, and then delete the existing one.
subnet_idstring
ipv6_cidr_blocksarrayThe IPv6 network ranges for the subnet, in CIDR notation.
ipv6_cidr_blockstringThe IPv6 CIDR block.
If you specify AssignIpv6AddressOnCreation, you must also specify an IPv6 CIDR block.
outpost_arnstringThe Amazon Resource Name (ARN) of the Outpost.
ipv6_nativebooleanIndicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.
enable_dns64booleanIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.
private_dns_name_options_on_launchobjectThe 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.
Available options:
+ EnableResourceNameDnsAAAARecord (true | false)
+ EnableResourceNameDnsARecord (true | false)
+ HostnameType (ip-name | resource-name)
tagsarrayAny tags assigned to the subnet.
ipv4_ipam_pool_idstringAn IPv4 IPAM pool ID for the subnet.
ipv4_netmask_lengthintegerAn IPv4 netmask length for the subnet.
ipv6_ipam_pool_idstringAn IPv6 IPAM pool ID for the subnet.
ipv6_netmask_lengthintegerAn IPv6 netmask length for the subnet.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all subnets in a region.

SELECT
region,
subnet_id
FROM aws.ec2.subnets_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the subnets_list_only resource, see subnets