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-associate-address

Description

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

For EC2 addresses: This action associates an Elastic IP address with an instance in your AWS account. If the IP address is currently assigned to another instance, the IP address is assigned to the new instance. For more information about EC2 Elastic IP addresses, go to Instance Addressing in the Amazon Elastic Compute Cloud User Guide.

For VPC addresses: This action associates a VPC Elastic IP address with an instance or a network interface in your VPC. If the IP address is currently assigned to another instance or a network interface, Amazon EC2 returns an error. 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.

This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.

The short version of this command is ec2assocaddr.

Syntax

ec2-associate-address [-i instance_id | -n network interface] [ip_address | -a allocation_id]

Options

NameDescriptionRequired

-i, --instance instance_id

The instance to associate with the IP address.

Type: String

Default: None

Example: -i i-43a4412a

Yes

ip_address

EC2 Elastic IP address to assign to the instance.

Type: String

Default: None

Condition: Required for EC2 Elastic IP addresses.

Example: 192.0.2.1

Conditional

-a, --allocation-id allocation_id

The allocation ID that AWS returned when you allocated the Elastic IP address to your VPC.

Type: String

Default: None

Condition: Required for VPC Elastic IP addresses.

Example: -a eipalloc-5723d13e

Conditional

-n, --network-interface interface_id

The interface to associate with the IP address. This is only available in Amazon VPC.

Type: String

Default: None

Condition: Conditional

Example: -n eni-bc7299d4

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 that you are assigning to the instance

  • Instance to which the IP address is assigned

  • Association ID (returned only for VPC addresses)

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example associates an EC2 Elastic IP address with an instance.

PROMPT> ec2-associate-address 192.0.2.1 -i i-43a4412a 
ADDRESS 192.0.2.1 i-43a4412a

Example Request

This example associates a VPC Elastic IP address with an instance running in your VPC.

PROMPT> ec2-associate-address -a eipalloc-5723d13e -i i-4fd2431a 
ADDRESS   i-43a4412a   eipalloc-5723d13e   eipassoc-fc5ca095

Example Request

This example associates a VPC Elastic IP address with a network interface in your VPC.

PROMPT> ec2-associate-address -a eipalloc-4a4c6c23 -n eni-1001fa78 
ADDRESS   i-1ae1ae78   eipalloc-4a4c6c23   eipassoc-1841907a