Subnet - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Subnet

Describes a subnet.

Contents

assignIpv6AddressOnCreation

Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

Type: Boolean

Required: No

availabilityZone

The Availability Zone of the subnet.

Type: String

Required: No

availabilityZoneId

The AZ ID of the subnet.

Type: String

Required: No

availableIpAddressCount

The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

Type: Integer

Required: No

blockPublicAccessStates

The state of VPC Block Public Access (BPA).

Type: BlockPublicAccessStates object

Required: No

cidrBlock

The IPv4 CIDR block assigned to the subnet.

Type: String

Required: No

customerOwnedIpv4Pool

The customer-owned IPv4 address pool associated with the subnet.

Type: String

Required: No

defaultForAz

Indicates whether this is the default subnet for the Availability Zone.

Type: Boolean

Required: No

enableDns64

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

Type: Boolean

Required: No

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

Type: Integer

Required: No

ipv6CidrBlockAssociationSet

Information about the IPv6 CIDR blocks associated with the subnet.

Type: Array of SubnetIpv6CidrBlockAssociation objects

Required: No

ipv6Native

Indicates whether this is an IPv6 only subnet.

Type: Boolean

Required: No

mapCustomerOwnedIpOnLaunch

Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

Type: Boolean

Required: No

mapPublicIpOnLaunch

Indicates whether instances launched in this subnet receive a public IPv4 address.

Amazon 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 Amazon VPC pricing page.

Type: Boolean

Required: No

outpostArn

The Amazon Resource Name (ARN) of the Outpost.

Type: String

Required: No

ownerId

The ID of the Amazon Web Services account that owns the subnet.

Type: String

Required: No

privateDnsNameOptionsOnLaunch

The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.

Type: PrivateDnsNameOptionsOnLaunch object

Required: No

state

The current state of the subnet.

Type: String

Valid Values: pending | available | unavailable

Required: No

subnetArn

The Amazon Resource Name (ARN) of the subnet.

Type: String

Required: No

subnetId

The ID of the subnet.

Type: String

Required: No

tagSet

Any tags assigned to the subnet.

Type: Array of Tag objects

Required: No

vpcId

The ID of the VPC the subnet is in.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: