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

ModifySubnetAttribute

Modifies a subnet attribute. You can only modify one attribute at a time.

Use this action to modify subnets on Amazon Outposts.

  • To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool. These two parameters act as a single attribute.

  • To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or DisableLniAtDeviceIndex.

For more information about Amazon Outposts, see the following:

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

AssignIpv6AddressOnCreation

Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives an IPv6 address).

If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it's created using version 2016-11-15 or later of the Amazon EC2 API.

Type: AttributeBooleanValue object

Required: No

CustomerOwnedIpv4Pool

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

You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.

Type: String

Required: No

DisableLniAtDeviceIndex

Specify true to indicate that local network interfaces at the current position should be disabled.

Type: AttributeBooleanValue object

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: AttributeBooleanValue object

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). A local network interface cannot be the primary network interface (eth0).

Type: Integer

Required: No

EnableResourceNameDnsAAAARecordOnLaunch

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

Type: AttributeBooleanValue object

Required: No

EnableResourceNameDnsARecordOnLaunch

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

Type: AttributeBooleanValue object

Required: No

MapCustomerOwnedIpOnLaunch

Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.

When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.

Type: AttributeBooleanValue object

Required: No

MapPublicIpOnLaunch

Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.

Type: AttributeBooleanValue object

Required: No

PrivateDnsHostnameTypeOnLaunch

The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).

Type: String

Valid Values: ip-name | resource-name

Required: No

SubnetId

The ID of the subnet.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

Is true if the request succeeds, and an error otherwise.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common client error codes.

Examples

Example 1

This example modifies the attribute for subnet-1a2b3c4d to specify that all instances launched into this subnet are assigned a public IPv4 address.

Sample Request

https://ec2.amazonaws.com/?Action=ModifySubnetAttribute &SubnetId=subnet-1a2b3c4d &MapPublicIpOnLaunch.Value=true &AUTHPARAMS

Sample Response

<ModifySubnetAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>c500a0bc-ad14-46c2-b9c5-e24aexample</requestId> <return>true</return> </ModifySubnetAttributeResponse>

Example 2

This example modifies the attribute for subnet-1a2b3c4d to specify that all network interfaces created in this subnet (and therefore all instances launched into this subnet with a new network interface) are assigned an IPv6 address.

Sample Request

https://ec2.amazonaws.com/?Action=ModifySubnetAttribute &SubnetId=subnet-1a2b3c4d &AssignIpv6AddressOnCreation.Value=true &AUTHPARAMS

See Also

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