Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.AssignPrivateIpAddresses

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.

Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.

You must specify either the IP addresses or the IP address count in the request.

You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

Synopsis

Creating a Request

data AssignPrivateIpAddresses Source #

Contains the parameters for AssignPrivateIpAddresses.

See: newAssignPrivateIpAddresses smart constructor.

Constructors

AssignPrivateIpAddresses'

Fields

allowReassignment :: Maybe Bool
Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
ipv4PrefixCount :: Maybe Int
The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
ipv4Prefixes :: Maybe [Text]
One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
privateIpAddresses :: Maybe [Text]
The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
secondaryPrivateIpAddressCount :: Maybe Int
The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
networkInterfaceId :: Text
The ID of the network interface.

Instances

Instances details

ToHeaders AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods toHeaders :: AssignPrivateIpAddresses -> [Header] #
ToPath AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods toPath :: AssignPrivateIpAddresses -> ByteString #
ToQuery AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods toQuery :: AssignPrivateIpAddresses -> QueryString #
AWSRequest AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Associated Types type AWSResponse AssignPrivateIpAddresses # Methods request :: (Service -> Service) -> AssignPrivateIpAddresses -> Request AssignPrivateIpAddresses # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssignPrivateIpAddresses -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssignPrivateIpAddresses))) #
Generic AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Associated Types type Rep AssignPrivateIpAddresses :: Type -> Type # Methods from :: AssignPrivateIpAddresses -> Rep AssignPrivateIpAddresses x # to :: Rep AssignPrivateIpAddresses x -> AssignPrivateIpAddresses #
Read AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods readsPrec :: Int -> ReadS AssignPrivateIpAddresses # readList :: ReadS [AssignPrivateIpAddresses] # readPrec :: ReadPrec AssignPrivateIpAddresses # readListPrec :: ReadPrec [AssignPrivateIpAddresses] #
Show AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods showsPrec :: Int -> AssignPrivateIpAddresses -> ShowS # show :: AssignPrivateIpAddresses -> String # showList :: [AssignPrivateIpAddresses] -> ShowS #
NFData AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods rnf :: AssignPrivateIpAddresses -> () #
Eq AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods (==) :: AssignPrivateIpAddresses -> AssignPrivateIpAddresses -> Bool # (/=) :: AssignPrivateIpAddresses -> AssignPrivateIpAddresses -> Bool #
Hashable AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods hashWithSalt :: Int -> AssignPrivateIpAddresses -> Int # hash :: AssignPrivateIpAddresses -> Int #
type AWSResponse AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses type AWSResponse AssignPrivateIpAddresses = AssignPrivateIpAddressesResponse
type Rep AssignPrivateIpAddresses Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses type Rep AssignPrivateIpAddresses = D1 ('MetaData "AssignPrivateIpAddresses" "Amazonka.EC2.AssignPrivateIpAddresses" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AssignPrivateIpAddresses'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowReassignment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "ipv4PrefixCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "ipv4Prefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "privateIpAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "secondaryPrivateIpAddressCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "networkInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newAssignPrivateIpAddresses Source #

Arguments

:: Text	`AssignPrivateIpAddresses`
-> AssignPrivateIpAddresses

Create a value of AssignPrivateIpAddresses 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:

$sel:allowReassignment:AssignPrivateIpAddresses', assignPrivateIpAddresses_allowReassignment - Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

AssignPrivateIpAddresses, assignPrivateIpAddresses_ipv4PrefixCount - The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

AssignPrivateIpAddresses, assignPrivateIpAddresses_ipv4Prefixes - One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

AssignPrivateIpAddresses, assignPrivateIpAddresses_privateIpAddresses - The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

AssignPrivateIpAddresses, assignPrivateIpAddresses_secondaryPrivateIpAddressCount - The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

AssignPrivateIpAddresses, assignPrivateIpAddresses_networkInterfaceId - The ID of the network interface.

Request Lenses

assignPrivateIpAddresses_allowReassignment :: Lens' AssignPrivateIpAddresses (Maybe Bool) Source #

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

assignPrivateIpAddresses_ipv4PrefixCount :: Lens' AssignPrivateIpAddresses (Maybe Int) Source #

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

assignPrivateIpAddresses_ipv4Prefixes :: Lens' AssignPrivateIpAddresses (Maybe [Text]) Source #

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

assignPrivateIpAddresses_privateIpAddresses :: Lens' AssignPrivateIpAddresses (Maybe [Text]) Source #

The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

assignPrivateIpAddresses_secondaryPrivateIpAddressCount :: Lens' AssignPrivateIpAddresses (Maybe Int) Source #

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

assignPrivateIpAddresses_networkInterfaceId :: Lens' AssignPrivateIpAddresses Text Source #

The ID of the network interface.

Destructuring the Response

data AssignPrivateIpAddressesResponse Source #

See: newAssignPrivateIpAddressesResponse smart constructor.

Constructors

AssignPrivateIpAddressesResponse'
Fields assignedIpv4Prefixes :: Maybe [Ipv4PrefixSpecification] The IPv4 prefixes that are assigned to the network interface. assignedPrivateIpAddresses :: Maybe [AssignedPrivateIpAddress] The private IP addresses assigned to the network interface. networkInterfaceId :: Maybe Text The ID of the network interface. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic AssignPrivateIpAddressesResponse Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Associated Types type Rep AssignPrivateIpAddressesResponse :: Type -> Type # Methods from :: AssignPrivateIpAddressesResponse -> Rep AssignPrivateIpAddressesResponse x # to :: Rep AssignPrivateIpAddressesResponse x -> AssignPrivateIpAddressesResponse #
Read AssignPrivateIpAddressesResponse Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods readsPrec :: Int -> ReadS AssignPrivateIpAddressesResponse # readList :: ReadS [AssignPrivateIpAddressesResponse] # readPrec :: ReadPrec AssignPrivateIpAddressesResponse # readListPrec :: ReadPrec [AssignPrivateIpAddressesResponse] #
Show AssignPrivateIpAddressesResponse Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods showsPrec :: Int -> AssignPrivateIpAddressesResponse -> ShowS # show :: AssignPrivateIpAddressesResponse -> String # showList :: [AssignPrivateIpAddressesResponse] -> ShowS #
NFData AssignPrivateIpAddressesResponse Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods rnf :: AssignPrivateIpAddressesResponse -> () #
Eq AssignPrivateIpAddressesResponse Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses Methods (==) :: AssignPrivateIpAddressesResponse -> AssignPrivateIpAddressesResponse -> Bool # (/=) :: AssignPrivateIpAddressesResponse -> AssignPrivateIpAddressesResponse -> Bool #
type Rep AssignPrivateIpAddressesResponse Source #
Instance details Defined in Amazonka.EC2.AssignPrivateIpAddresses type Rep AssignPrivateIpAddressesResponse = D1 ('MetaData "AssignPrivateIpAddressesResponse" "Amazonka.EC2.AssignPrivateIpAddresses" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AssignPrivateIpAddressesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assignedIpv4Prefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Ipv4PrefixSpecification])) :: S1 ('MetaSel ('Just "assignedPrivateIpAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AssignedPrivateIpAddress]))) :: (S1 ('MetaSel ('Just "networkInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))