Skip to content

/AWS1/CL_EC2=>ALLOCATEADDRESS()

About AllocateAddress

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.

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. To attempt to recover an Elastic IP address that you released, specify it in this operation.

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

Method Signature

IMPORTING

Optional arguments:

IV_DOMAIN TYPE /AWS1/EC2DOMAINTYPE /AWS1/EC2DOMAINTYPE

The network (vpc).

IV_ADDRESS TYPE /AWS1/EC2PUBLICIPADDRESS /AWS1/EC2PUBLICIPADDRESS

The Elastic IP address to recover or an IPv4 address from an address pool.

IV_PUBLICIPV4POOL TYPE /AWS1/EC2IPV4POOLEC2ID /AWS1/EC2IPV4POOLEC2ID

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.

IV_NETWORKBORDERGROUP TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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.

IV_CUSTOMEROWNEDIPV4POOL TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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.

IV_DRYRUN TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST TT_TAGSPECIFICATIONLIST

The tags to assign to the Elastic IP address.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_EC2ALLOCATEADDRESSRS /AWS1/CL_EC2ALLOCATEADDRESSRS