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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

EC2-Classic, VPC in an EC2-VPC-only account: If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
VPC in an EC2-Classic account: If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
Subnets in Wavelength Zones: You can associate an IP address from the telecommunication carrier to the instance or network interface.

You cannot associate an Elastic IP address with an interface in a different network border group.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

Synopsis

data AssociateAddress = AssociateAddress' {
- allocationId :: Maybe Text
- allowReassociation :: Maybe Bool
- dryRun :: Maybe Bool
- instanceId :: Maybe Text
- networkInterfaceId :: Maybe Text
- privateIpAddress :: Maybe Text
- publicIp :: Maybe Text
}
newAssociateAddress :: AssociateAddress
associateAddress_allocationId :: Lens' AssociateAddress (Maybe Text)
associateAddress_allowReassociation :: Lens' AssociateAddress (Maybe Bool)
associateAddress_dryRun :: Lens' AssociateAddress (Maybe Bool)
associateAddress_instanceId :: Lens' AssociateAddress (Maybe Text)
associateAddress_networkInterfaceId :: Lens' AssociateAddress (Maybe Text)
associateAddress_privateIpAddress :: Lens' AssociateAddress (Maybe Text)
associateAddress_publicIp :: Lens' AssociateAddress (Maybe Text)
data AssociateAddressResponse = AssociateAddressResponse' {
- associationId :: Maybe Text
- httpStatus :: Int
}
newAssociateAddressResponse :: Int -> AssociateAddressResponse
associateAddressResponse_associationId :: Lens' AssociateAddressResponse (Maybe Text)
associateAddressResponse_httpStatus :: Lens' AssociateAddressResponse Int

Creating a Request

data AssociateAddress Source #

See: newAssociateAddress smart constructor.

Constructors

AssociateAddress'

Fields

allocationId :: Maybe Text
EC2-VPC
The allocation ID. This is required for EC2-VPC.
allowReassociation :: Maybe Bool
EC2-VPC
For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.
dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
instanceId :: Maybe Text
The ID of the instance. The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state.
networkInterfaceId :: Maybe Text
EC2-VPC
The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
privateIpAddress :: Maybe Text
EC2-VPC
The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
publicIp :: Maybe Text
EC2-Classic
The Elastic IP address to associate with the instance. This is required for EC2-Classic.

Instances

Instances details

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

newAssociateAddress :: AssociateAddress Source #

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

AssociateAddress, associateAddress_allocationId - [EC2-VPC] The allocation ID. This is required for EC2-VPC.

$sel:allowReassociation:AssociateAddress', associateAddress_allowReassociation - [EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

$sel:dryRun:AssociateAddress', associateAddress_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

AssociateAddress, associateAddress_instanceId - The ID of the instance. The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state.

AssociateAddress, associateAddress_networkInterfaceId - [EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

AssociateAddress, associateAddress_privateIpAddress - [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

AssociateAddress, associateAddress_publicIp - [EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.

Request Lenses

associateAddress_allocationId :: Lens' AssociateAddress (Maybe Text) Source #

EC2-VPC: The allocation ID. This is required for EC2-VPC.

associateAddress_allowReassociation :: Lens' AssociateAddress (Maybe Bool) Source #

EC2-VPC: For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

associateAddress_dryRun :: Lens' AssociateAddress (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

associateAddress_instanceId :: Lens' AssociateAddress (Maybe Text) Source #

The ID of the instance. The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state.

associateAddress_networkInterfaceId :: Lens' AssociateAddress (Maybe Text) Source #

EC2-VPC: The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

associateAddress_privateIpAddress :: Lens' AssociateAddress (Maybe Text) Source #

EC2-VPC: The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

associateAddress_publicIp :: Lens' AssociateAddress (Maybe Text) Source #

EC2-Classic: The Elastic IP address to associate with the instance. This is required for EC2-Classic.

Destructuring the Response

data AssociateAddressResponse Source #

See: newAssociateAddressResponse smart constructor.

Constructors

AssociateAddressResponse'
Fields associationId :: Maybe Text EC2-VPC The ID that represents the association of the Elastic IP address with an instance. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newAssociateAddressResponse Source #

Arguments

:: Int	`$sel:httpStatus:AssociateAddressResponse'`
-> AssociateAddressResponse

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

AssociateAddressResponse, associateAddressResponse_associationId - [EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

$sel:httpStatus:AssociateAddressResponse', associateAddressResponse_httpStatus - The response's http status code.

Response Lenses

associateAddressResponse_associationId :: Lens' AssociateAddressResponse (Maybe Text) Source #

EC2-VPC: The ID that represents the association of the Elastic IP address with an instance.

associateAddressResponse_httpStatus :: Lens' AssociateAddressResponse Int Source #

The response's http status code.