paws.compute (version 0.1.12)

ec2_release_address: Releases the specified Elastic IP address

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

[Nondefault VPC] You must use disassociate_address 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 AWS 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 allocate_address.

Usage

ec2_release_address(AllocationId, PublicIp, NetworkBorderGroup, DryRun)

Value

An empty list.

Arguments

AllocationId

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

PublicIp

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

NetworkBorderGroup

The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound error. For more information, see Error Codes.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

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.

Request syntax

svc$release_address(
  AllocationId = "string",
  PublicIp = "string",
  NetworkBorderGroup = "string",
  DryRun = TRUE|FALSE
)

Examples

if (FALSE) {
# This example releases an Elastic IP address for use with instances in a
# VPC.
svc$release_address(
  AllocationId = "eipalloc-64d5890a"
)

# This example releases an Elastic IP address for use with instances in
# EC2-Classic.
svc$release_address(
  PublicIp = "198.51.100.0"
)
}