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

Description

Releases the specified Elastic IP address.

EC2-Classic, default VPC
Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

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.

Nondefault VPC
You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.

EC2-VPC
After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.

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

Synopsis

Creating a Request

data ReleaseAddress Source #

See: newReleaseAddress smart constructor.

Constructors

ReleaseAddress' 

Fields

  • allocationId :: Maybe Text
    EC2-VPC
    The allocation ID. Required for EC2-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

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

    If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

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

  • publicIp :: Maybe Text
    EC2-Classic
    The Elastic IP address. Required for EC2-Classic.

Instances

Instances details
ToHeaders ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

ToPath ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

ToQuery ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

AWSRequest ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

Associated Types

type AWSResponse ReleaseAddress #

Generic ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

Associated Types

type Rep ReleaseAddress :: Type -> Type #

Read ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

Show ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

NFData ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

Methods

rnf :: ReleaseAddress -> () #

Eq ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

Hashable ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

type AWSResponse ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

type Rep ReleaseAddress Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

type Rep ReleaseAddress = D1 ('MetaData "ReleaseAddress" "Amazonka.EC2.ReleaseAddress" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ReleaseAddress'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allocationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "networkBorderGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "publicIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newReleaseAddress :: ReleaseAddress Source #

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

ReleaseAddress, releaseAddress_allocationId - [EC2-VPC] The allocation ID. Required for EC2-VPC.

$sel:dryRun:ReleaseAddress', releaseAddress_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.

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

If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

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

ReleaseAddress, releaseAddress_publicIp - [EC2-Classic] The Elastic IP address. Required for EC2-Classic.

Request Lenses

releaseAddress_allocationId :: Lens' ReleaseAddress (Maybe Text) Source #

EC2-VPC
The allocation ID. Required for EC2-VPC.

releaseAddress_dryRun :: Lens' ReleaseAddress (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.

releaseAddress_networkBorderGroup :: Lens' ReleaseAddress (Maybe Text) Source #

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

If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

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

releaseAddress_publicIp :: Lens' ReleaseAddress (Maybe Text) Source #

EC2-Classic
The Elastic IP address. Required for EC2-Classic.

Destructuring the Response

data ReleaseAddressResponse Source #

See: newReleaseAddressResponse smart constructor.

Instances

Instances details
Generic ReleaseAddressResponse Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

Associated Types

type Rep ReleaseAddressResponse :: Type -> Type #

Read ReleaseAddressResponse Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

Show ReleaseAddressResponse Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

NFData ReleaseAddressResponse Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

Methods

rnf :: ReleaseAddressResponse -> () #

Eq ReleaseAddressResponse Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

type Rep ReleaseAddressResponse Source # 
Instance details

Defined in Amazonka.EC2.ReleaseAddress

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

newReleaseAddressResponse :: ReleaseAddressResponse Source #

Create a value of ReleaseAddressResponse with all optional fields omitted.

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