amazonka-ec2-1.6.0: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.AllocateAddress

Contents

Description

Allocates an Elastic IP address.

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.

If you release an Elastic IP address for use in a VPC, you might be able to recover it. To recover an Elastic IP address that you released, specify it in the Address parameter. Note that you cannot recover an Elastic IP address that you released after it is allocated to another AWS account.

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

Synopsis

Creating a Request

allocateAddress :: AllocateAddress #

Creates a value of AllocateAddress with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • aaDomain - Set to vpc to allocate the address for use with instances in a VPC. Default: The address is for use with instances in EC2-Classic.
  • aaAddress - [EC2-VPC] The Elastic IP address to recover.
  • aaDryRun - 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 .

data AllocateAddress #

Contains the parameters for AllocateAddress.

See: allocateAddress smart constructor.

Instances

Eq AllocateAddress # 
Data AllocateAddress # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AllocateAddress -> c AllocateAddress #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AllocateAddress #

toConstr :: AllocateAddress -> Constr #

dataTypeOf :: AllocateAddress -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AllocateAddress) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AllocateAddress) #

gmapT :: (forall b. Data b => b -> b) -> AllocateAddress -> AllocateAddress #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AllocateAddress -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AllocateAddress -> r #

gmapQ :: (forall d. Data d => d -> u) -> AllocateAddress -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AllocateAddress -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AllocateAddress -> m AllocateAddress #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AllocateAddress -> m AllocateAddress #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AllocateAddress -> m AllocateAddress #

Read AllocateAddress # 
Show AllocateAddress # 
Generic AllocateAddress # 
Hashable AllocateAddress # 
NFData AllocateAddress # 

Methods

rnf :: AllocateAddress -> () #

AWSRequest AllocateAddress # 
ToHeaders AllocateAddress # 
ToPath AllocateAddress # 
ToQuery AllocateAddress # 
type Rep AllocateAddress # 
type Rep AllocateAddress = D1 * (MetaData "AllocateAddress" "Network.AWS.EC2.AllocateAddress" "amazonka-ec2-1.6.0-Dm9BQRbqSOK72xbfLZMG4m" False) (C1 * (MetaCons "AllocateAddress'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_aaDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DomainType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_aaAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_aaDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))
type Rs AllocateAddress # 

Request Lenses

aaDomain :: Lens' AllocateAddress (Maybe DomainType) #

Set to vpc to allocate the address for use with instances in a VPC. Default: The address is for use with instances in EC2-Classic.

aaAddress :: Lens' AllocateAddress (Maybe Text) #

EC2-VPC
The Elastic IP address to recover.

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

Destructuring the Response

allocateAddressResponse #

Creates a value of AllocateAddressResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • aarsAllocationId - [EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.
  • aarsDomain - Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard ) or instances in a VPC (vpc ).
  • aarsPublicIP - The Elastic IP address.
  • aarsResponseStatus - -- | The response status code.

data AllocateAddressResponse #

Contains the output of AllocateAddress.

See: allocateAddressResponse smart constructor.

Instances

Eq AllocateAddressResponse # 
Data AllocateAddressResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AllocateAddressResponse -> c AllocateAddressResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AllocateAddressResponse #

toConstr :: AllocateAddressResponse -> Constr #

dataTypeOf :: AllocateAddressResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AllocateAddressResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AllocateAddressResponse) #

gmapT :: (forall b. Data b => b -> b) -> AllocateAddressResponse -> AllocateAddressResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AllocateAddressResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AllocateAddressResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> AllocateAddressResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AllocateAddressResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AllocateAddressResponse -> m AllocateAddressResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AllocateAddressResponse -> m AllocateAddressResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AllocateAddressResponse -> m AllocateAddressResponse #

Read AllocateAddressResponse # 
Show AllocateAddressResponse # 
Generic AllocateAddressResponse # 
NFData AllocateAddressResponse # 

Methods

rnf :: AllocateAddressResponse -> () #

type Rep AllocateAddressResponse # 
type Rep AllocateAddressResponse = D1 * (MetaData "AllocateAddressResponse" "Network.AWS.EC2.AllocateAddress" "amazonka-ec2-1.6.0-Dm9BQRbqSOK72xbfLZMG4m" False) (C1 * (MetaCons "AllocateAddressResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_aarsAllocationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_aarsDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DomainType)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_aarsPublicIP") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_aarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

aarsAllocationId :: Lens' AllocateAddressResponse (Maybe Text) #

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

aarsDomain :: Lens' AllocateAddressResponse (Maybe DomainType) #

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

aarsResponseStatus :: Lens' AllocateAddressResponse Int #

  • - | The response status code.