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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

EC2-VPC: If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

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 AllocateAddress = AllocateAddress' {
- address :: Maybe Text
- customerOwnedIpv4Pool :: Maybe Text
- domain :: Maybe DomainType
- dryRun :: Maybe Bool
- networkBorderGroup :: Maybe Text
- publicIpv4Pool :: Maybe Text
- tagSpecifications :: Maybe [TagSpecification]
}
newAllocateAddress :: AllocateAddress
allocateAddress_address :: Lens' AllocateAddress (Maybe Text)
allocateAddress_customerOwnedIpv4Pool :: Lens' AllocateAddress (Maybe Text)
allocateAddress_domain :: Lens' AllocateAddress (Maybe DomainType)
allocateAddress_dryRun :: Lens' AllocateAddress (Maybe Bool)
allocateAddress_networkBorderGroup :: Lens' AllocateAddress (Maybe Text)
allocateAddress_publicIpv4Pool :: Lens' AllocateAddress (Maybe Text)
allocateAddress_tagSpecifications :: Lens' AllocateAddress (Maybe [TagSpecification])
data AllocateAddressResponse = AllocateAddressResponse' {
- allocationId :: Maybe Text
- carrierIp :: Maybe Text
- customerOwnedIp :: Maybe Text
- customerOwnedIpv4Pool :: Maybe Text
- domain :: Maybe DomainType
- networkBorderGroup :: Maybe Text
- publicIp :: Maybe Text
- publicIpv4Pool :: Maybe Text
- httpStatus :: Int
}
newAllocateAddressResponse :: Int -> AllocateAddressResponse
allocateAddressResponse_allocationId :: Lens' AllocateAddressResponse (Maybe Text)
allocateAddressResponse_carrierIp :: Lens' AllocateAddressResponse (Maybe Text)
allocateAddressResponse_customerOwnedIp :: Lens' AllocateAddressResponse (Maybe Text)
allocateAddressResponse_customerOwnedIpv4Pool :: Lens' AllocateAddressResponse (Maybe Text)
allocateAddressResponse_domain :: Lens' AllocateAddressResponse (Maybe DomainType)
allocateAddressResponse_networkBorderGroup :: Lens' AllocateAddressResponse (Maybe Text)
allocateAddressResponse_publicIp :: Lens' AllocateAddressResponse (Maybe Text)
allocateAddressResponse_publicIpv4Pool :: Lens' AllocateAddressResponse (Maybe Text)
allocateAddressResponse_httpStatus :: Lens' AllocateAddressResponse Int

Creating a Request

data AllocateAddress Source #

See: newAllocateAddress smart constructor.

Constructors

AllocateAddress'

Fields

address :: Maybe Text
EC2-VPC
The Elastic IP address to recover or an IPv4 address from an address pool.
customerOwnedIpv4Pool :: Maybe Text
The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.
domain :: Maybe DomainType
Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.
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.
networkBorderGroup :: Maybe Text
A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use DescribeAvailabilityZones to view the network border groups.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.
publicIpv4Pool :: Maybe Text
The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.
tagSpecifications :: Maybe [TagSpecification]
The tags to assign to the Elastic IP address.

Instances

Instances details

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

newAllocateAddress :: AllocateAddress Source #

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

AllocateAddress, allocateAddress_address - [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

AllocateAddress, allocateAddress_customerOwnedIpv4Pool - The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

AllocateAddress, allocateAddress_domain - Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

$sel:dryRun:AllocateAddress', allocateAddress_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.

AllocateAddress, allocateAddress_networkBorderGroup - A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.

AllocateAddress, allocateAddress_publicIpv4Pool - The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

AllocateAddress, allocateAddress_tagSpecifications - The tags to assign to the Elastic IP address.

Request Lenses

allocateAddress_address :: Lens' AllocateAddress (Maybe Text) Source #

EC2-VPC: The Elastic IP address to recover or an IPv4 address from an address pool.

allocateAddress_customerOwnedIpv4Pool :: Lens' AllocateAddress (Maybe Text) Source #

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

allocateAddress_domain :: Lens' AllocateAddress (Maybe DomainType) Source #

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

allocateAddress_dryRun :: Lens' AllocateAddress (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.

allocateAddress_networkBorderGroup :: Lens' AllocateAddress (Maybe Text) Source #

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.

allocateAddress_publicIpv4Pool :: Lens' AllocateAddress (Maybe Text) Source #

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

allocateAddress_tagSpecifications :: Lens' AllocateAddress (Maybe [TagSpecification]) Source #

The tags to assign to the Elastic IP address.

Destructuring the Response

data AllocateAddressResponse Source #

See: newAllocateAddressResponse smart constructor.

Constructors

AllocateAddressResponse'

Fields

allocationId :: Maybe Text
EC2-VPC
The ID that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.
carrierIp :: Maybe Text
The carrier IP address. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
customerOwnedIp :: Maybe Text
The customer-owned IP address.
customerOwnedIpv4Pool :: Maybe Text
The ID of the customer-owned address pool.
domain :: Maybe DomainType
Indicates whether the Elastic IP address is for use with instances in a VPC (vpc) or instances in EC2-Classic (standard).
networkBorderGroup :: Maybe Text
The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
publicIp :: Maybe Text
The Elastic IP address.
publicIpv4Pool :: Maybe Text
The ID of an address pool.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newAllocateAddressResponse Source #

Arguments

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

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

AllocateAddressResponse, allocateAddressResponse_allocationId - [EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

AllocateAddressResponse, allocateAddressResponse_carrierIp - The carrier IP address. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

AllocateAddressResponse, allocateAddressResponse_customerOwnedIp - The customer-owned IP address.

AllocateAddress, allocateAddressResponse_customerOwnedIpv4Pool - The ID of the customer-owned address pool.

AllocateAddress, allocateAddressResponse_domain - Indicates whether the Elastic IP address is for use with instances in a VPC (vpc) or instances in EC2-Classic (standard).

AllocateAddress, allocateAddressResponse_networkBorderGroup - The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

AllocateAddressResponse, allocateAddressResponse_publicIp - The Elastic IP address.

AllocateAddress, allocateAddressResponse_publicIpv4Pool - The ID of an address pool.

$sel:httpStatus:AllocateAddressResponse', allocateAddressResponse_httpStatus - The response's http status code.

Response Lenses

allocateAddressResponse_allocationId :: Lens' AllocateAddressResponse (Maybe Text) Source #

EC2-VPC: The ID that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

allocateAddressResponse_carrierIp :: Lens' AllocateAddressResponse (Maybe Text) Source #

The carrier IP address. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

allocateAddressResponse_customerOwnedIp :: Lens' AllocateAddressResponse (Maybe Text) Source #

The customer-owned IP address.

allocateAddressResponse_customerOwnedIpv4Pool :: Lens' AllocateAddressResponse (Maybe Text) Source #

The ID of the customer-owned address pool.

allocateAddressResponse_domain :: Lens' AllocateAddressResponse (Maybe DomainType) Source #

Indicates whether the Elastic IP address is for use with instances in a VPC (vpc) or instances in EC2-Classic (standard).

allocateAddressResponse_networkBorderGroup :: Lens' AllocateAddressResponse (Maybe Text) Source #

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

allocateAddressResponse_publicIp :: Lens' AllocateAddressResponse (Maybe Text) Source #

The Elastic IP address.

allocateAddressResponse_publicIpv4Pool :: Lens' AllocateAddressResponse (Maybe Text) Source #

The ID of an address pool.

allocateAddressResponse_httpStatus :: Lens' AllocateAddressResponse Int Source #

The response's http status code.