EC2 / Client / modify_subnet_attribute

modify_subnet_attribute

EC2.Client.modify_subnet_attribute(**kwargs)

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

Use this action to modify subnets on Amazon Web Services 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 Web Services Outposts, see the following:

• Outpost servers

• Outpost racks

See also: AWS API Documentation

Request Syntax

response = client.modify_subnet_attribute(
    AssignIpv6AddressOnCreation={
        'Value': True|False
    },
    MapPublicIpOnLaunch={
        'Value': True|False
    },
    SubnetId='string',
    MapCustomerOwnedIpOnLaunch={
        'Value': True|False
    },
    CustomerOwnedIpv4Pool='string',
    EnableDns64={
        'Value': True|False
    },
    PrivateDnsHostnameTypeOnLaunch='ip-name'|'resource-name',
    EnableResourceNameDnsARecordOnLaunch={
        'Value': True|False
    },
    EnableResourceNameDnsAAAARecordOnLaunch={
        'Value': True|False
    },
    EnableLniAtDeviceIndex=123,
    DisableLniAtDeviceIndex={
        'Value': True|False
    }
)

Parameters:

• AssignIpv6AddressOnCreation (dict) –

  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.

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• MapPublicIpOnLaunch (dict) –

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

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• SubnetId (string) –

  [REQUIRED]

  The ID of the subnet.

• MapCustomerOwnedIpOnLaunch (dict) –

  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.

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• CustomerOwnedIpv4Pool (string) –

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

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

• EnableDns64 (dict) –

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

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• PrivateDnsHostnameTypeOnLaunch (string) – 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).

• EnableResourceNameDnsARecordOnLaunch (dict) –

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

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• EnableResourceNameDnsAAAARecordOnLaunch (dict) –

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

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• EnableLniAtDeviceIndex (integer) – 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).

• DisableLniAtDeviceIndex (dict) –

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

  • Value (boolean) –

    The attribute value. The valid values are true or false.

Returns:

None

Examples

This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.

response = client.modify_subnet_attribute(
    MapPublicIpOnLaunch={
        'Value': True,
    },
    SubnetId='subnet-1a2b3c4d',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}