Amazon Elastic Compute Cloud
CLI Reference (API Version 2011-12-15)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

ec2-allocate-address

Description

This command applies to both EC2 Elastic IP addresses and VPC Elastic IP addresses.

For EC2 addresses: This command acquires an Elastic IP address for use with your AWS account. For more information about EC2 Elastic IP addresses, go to Instance Addressing in the Amazon Elastic Compute Cloud User Guide.

For VPC addresses: This command acquires an Elastic IP address for use with your VPC. For information about VPC addresses and how they differ from EC2 addresses, go to the Elastic IP Addresses in the Amazon Virtual Private Cloud User Guide.

The short version of this command is ec2allocaddr.

Syntax

ec2-allocate-address [-d domain]

Options

NameDescriptionRequired

-d, --domain domain

Set to vpc to allocate the address for use with VPC instances.

Type: String

Default: Address is standard (allocated to EC2).

Valid Values: vpc

Condition: Required when allocating an address for use with VPC instances.

Example: -d vpc

Conditional

Common Options

OptionDescription

--region REGION

Overrides the Region specified in the EC2_URL environment variable and the URL specified by the -U option.

Default: The EC2_URL environment variable, or us-east-1 if the environment variable is not set.

Example: --region eu-west-1

-U, --url URL

URL is the uniform resource locator of the Amazon EC2 web service entry point.

Default: The EC2_URL environment variable, or https://ec2.amazonaws.com if the environment variable is not set.

Example: -U https://ec2.amazonaws.com

-K, --private-key EC2-PRIVATE-KEY

The private key to use when constructing requests to Amazon EC2.

Default: The value of the EC2_PRIVATE_KEY environment variable.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem

-C, --cert EC2-CERT

The X.509 certificate to use when constructing requests to Amazon EC2.

Default: The value of the EC2_CERT environment variable.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem

--connection-timeout TIMEOUT

Specifies a connection timeout (in seconds).

Example: --connection-timeout 30

--request-timeout TIMEOUT

Specifies a request timeout (in seconds).

Example: --request-timeout 45

-v, --verbose

Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.

-H, --headers

Displays column headers in the output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Do not display tags for tagged resources.

--debug

Prints internal debugging information. This is useful to assist us when troubleshooting problems.

-?, --help, -h

Displays Help.

-

If - is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another.

Example: ec2-describe-instances | grep stopped | cut -f 2 | ec2-start-instances -

Output

The command returns a table that contains the following information:

  • Output type identifier ("ADDRESS")

  • Elastic IP address for use with your account

  • The address's domain (standard or vpc)

  • Allocation ID (an ID that AWS assigns to represent the allocation of the address for use with Amazon VPC; returned only for VPC Elastic IP addresses)

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example returns an EC2 Elastic IP address for use with the account.

PROMPT> ec2-allocate-address
ADDRESS 192.0.2.1

Example Request

This example returns a VPC Elastic IP address for use with your VPC.

PROMPT> ec2-allocate-address -d vpc
ADDRESS  198.51.100.1     vpc     eipalloc-5723d13e