amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.ModifySubnetAttribute

Description

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:

Synopsis

Creating a Request

data ModifySubnetAttribute Source #

See: newModifySubnetAttribute smart constructor.

Constructors

ModifySubnetAttribute' 

Fields

  • assignIpv6AddressOnCreation :: Maybe AttributeBooleanValue

    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.

  • customerOwnedIpv4Pool :: Maybe Text

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

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

  • disableLniAtDeviceIndex :: Maybe AttributeBooleanValue

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

  • enableDns64 :: Maybe AttributeBooleanValue

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

  • enableLniAtDeviceIndex :: Maybe Int

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

  • enableResourceNameDnsAAAARecordOnLaunch :: Maybe AttributeBooleanValue

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

  • enableResourceNameDnsARecordOnLaunch :: Maybe AttributeBooleanValue

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

  • mapCustomerOwnedIpOnLaunch :: Maybe AttributeBooleanValue

    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.

  • mapPublicIpOnLaunch :: Maybe AttributeBooleanValue

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

  • privateDnsHostnameTypeOnLaunch :: Maybe HostnameType

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

  • subnetId :: Text

    The ID of the subnet.

Instances

Instances details
ToHeaders ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

ToPath ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

ToQuery ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

AWSRequest ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

Associated Types

type AWSResponse ModifySubnetAttribute #

Generic ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

Associated Types

type Rep ModifySubnetAttribute :: Type -> Type #

Read ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

Show ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

NFData ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

Methods

rnf :: ModifySubnetAttribute -> () #

Eq ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

Hashable ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

type AWSResponse ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

type Rep ModifySubnetAttribute Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

type Rep ModifySubnetAttribute = D1 ('MetaData "ModifySubnetAttribute" "Amazonka.EC2.ModifySubnetAttribute" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifySubnetAttribute'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "assignIpv6AddressOnCreation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue)) :*: S1 ('MetaSel ('Just "customerOwnedIpv4Pool") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "disableLniAtDeviceIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue)) :*: (S1 ('MetaSel ('Just "enableDns64") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue)) :*: S1 ('MetaSel ('Just "enableLniAtDeviceIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "enableResourceNameDnsAAAARecordOnLaunch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue)) :*: (S1 ('MetaSel ('Just "enableResourceNameDnsARecordOnLaunch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue)) :*: S1 ('MetaSel ('Just "mapCustomerOwnedIpOnLaunch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue)))) :*: (S1 ('MetaSel ('Just "mapPublicIpOnLaunch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue)) :*: (S1 ('MetaSel ('Just "privateDnsHostnameTypeOnLaunch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HostnameType)) :*: S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifySubnetAttribute Source #

Create a value of ModifySubnetAttribute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

$sel:disableLniAtDeviceIndex:ModifySubnetAttribute', modifySubnetAttribute_disableLniAtDeviceIndex - Specify true to indicate that local network interfaces at the current position should be disabled.

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

ModifySubnetAttribute, modifySubnetAttribute_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).

$sel:enableResourceNameDnsAAAARecordOnLaunch:ModifySubnetAttribute', modifySubnetAttribute_enableResourceNameDnsAAAARecordOnLaunch - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

$sel:enableResourceNameDnsARecordOnLaunch:ModifySubnetAttribute', modifySubnetAttribute_enableResourceNameDnsARecordOnLaunch - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

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

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

$sel:privateDnsHostnameTypeOnLaunch:ModifySubnetAttribute', modifySubnetAttribute_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).

ModifySubnetAttribute, modifySubnetAttribute_subnetId - The ID of the subnet.

Request Lenses

modifySubnetAttribute_assignIpv6AddressOnCreation :: Lens' ModifySubnetAttribute (Maybe AttributeBooleanValue) Source #

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.

modifySubnetAttribute_customerOwnedIpv4Pool :: Lens' ModifySubnetAttribute (Maybe Text) Source #

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

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

modifySubnetAttribute_disableLniAtDeviceIndex :: Lens' ModifySubnetAttribute (Maybe AttributeBooleanValue) Source #

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

modifySubnetAttribute_enableDns64 :: Lens' ModifySubnetAttribute (Maybe AttributeBooleanValue) Source #

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

modifySubnetAttribute_enableLniAtDeviceIndex :: Lens' ModifySubnetAttribute (Maybe Int) Source #

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

modifySubnetAttribute_enableResourceNameDnsAAAARecordOnLaunch :: Lens' ModifySubnetAttribute (Maybe AttributeBooleanValue) Source #

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

modifySubnetAttribute_enableResourceNameDnsARecordOnLaunch :: Lens' ModifySubnetAttribute (Maybe AttributeBooleanValue) Source #

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

modifySubnetAttribute_mapCustomerOwnedIpOnLaunch :: Lens' ModifySubnetAttribute (Maybe AttributeBooleanValue) Source #

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.

modifySubnetAttribute_mapPublicIpOnLaunch :: Lens' ModifySubnetAttribute (Maybe AttributeBooleanValue) Source #

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

modifySubnetAttribute_privateDnsHostnameTypeOnLaunch :: Lens' ModifySubnetAttribute (Maybe HostnameType) Source #

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

Destructuring the Response

data ModifySubnetAttributeResponse Source #

See: newModifySubnetAttributeResponse smart constructor.

Instances

Instances details
Generic ModifySubnetAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

Associated Types

type Rep ModifySubnetAttributeResponse :: Type -> Type #

Read ModifySubnetAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

Show ModifySubnetAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

NFData ModifySubnetAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

Eq ModifySubnetAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

type Rep ModifySubnetAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifySubnetAttribute

type Rep ModifySubnetAttributeResponse = D1 ('MetaData "ModifySubnetAttributeResponse" "Amazonka.EC2.ModifySubnetAttribute" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifySubnetAttributeResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newModifySubnetAttributeResponse :: ModifySubnetAttributeResponse Source #

Create a value of ModifySubnetAttributeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.