Amazon Elastic Compute Cloud
CLI Reference (API Version 2013-02-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

ec2-associate-address

Description

Associates an Elastic IP address with an instance or a network interface. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, default VPC] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[EC2-VPC] If you do not specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you specify the -–allow-reassociation option.

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] [--private-ip-address] [--allow-reassociation]

Options

NameDescription

-i, --instance instance_id

The ID of the instance.

Type: String

Default: None

Required: Conditional

Condition: Required for EC2-Classic. For EC2-VPC, you can specify either an instance ID or a network interface ID, but not both.

Example: -i i-43a4412a

ip_address

The Elastic IP address.

Type: String

Default: None

Required: Conditional

Condition: Required for EC2-Classic.

Example: 192.0.2.1

-a, --allocation-id allocation_id

The allocation ID.

Type: String

Default: None

Required: Conditional

Condition: Required for EC2-VPC.

Example: -a eipalloc-5723d13e

-n, --network-interface interface_id

[EC2-VPC] The network interface.

Type: String

Default: None

Required: Conditional

Condition: Specify either an instance ID or a network interface ID, but not both.

Example: -n eni-bc7299d4

-p, --private-ip-address private_IP_address

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

Type: String

Default: None

Required: No

Example: -p 10.0.0.45

--allow-reassociation

[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or a network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.

Type: Boolean

Default: The operation fails if the address is already associated.

Required: No

Example: --allow-reassociation

Common Options

OptionDescription

--region REGION

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

Default: The value of the EC2_URL environment variable, or us-east-1 if EC2_URL isn't set.

Example: --region eu-west-1

-U, --url URL

The uniform resource locator (URL) of the Amazon EC2 web service entry point.

Default: The value of the EC2_URL environment variable, or https://ec2.amazonaws.com if EC2_URL isn't set.

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

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

The private key that identifies you to Amazon EC2. For more information, see Tell the Tools Who You Are.

Default: The value of the EC2_PRIVATE_KEY environment variable. If EC2_PRIVATE_KEY isn't set, you must specify this option.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate that identifies you to Amazon EC2.

Default: The value of the EC2_CERT environment variable. If EC2_CERT isn't set, you must specify this option.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-O, --aws-access-key AWS_ACCESS_KEY

The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are.

Default: The value of the AWS_ACCESS_KEY environment variable. If AWS_ACCESS_KEY isn't set, you must specify this option.

Example: -O AKIAIOSFODNN7EXAMPLE

Note

For more information, see the following section, Deprecated Options.

-W, --aws-secret-key AWS_SECRET_KEY

The secret access key associated with your AWS account.

Default: The value of the AWS_SECRET_KEY environment variable. If AWS_SECRET_KEY isn't set, you must specify this option.

Example: -W wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Note

For more information, see the following section, Deprecated Options.

-T, --security-token TOKEN AWS_DELEGATION_TOKEN

The AWS delegation token.

Default: The value of the environment variable (if set).

--connection-timeout TIMEOUT

The connection timeout, in seconds.

Example: --connection-timeout 30

--request-timeout TIMEOUT

The request timeout, in seconds.

Example: --request-timeout 45

-v, --verbose

Displays verbose output, including the API request and response on the command line. This is useful if you are building tools to talk directly to our Query API.

-H, --headers

Includes column headers in the command output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Omits tags for tagged resources.

--debug

Displays internal debugging information. This can assist us when helping you troubleshooting problems.

-?, --help, -h

Displays usage information for the command.

-

Reads arguments from standard input. This is useful when piping the output from one command to the input of another.

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

Deprecated Options

For a limited time, you can still use the private key and X.509 certificate instead of your access key ID and secret access key. However, we recommend that you start using your access key ID (-O, --aws-access-key) and secret access key (-W, --aws-secret-key) now, as the private key (-K, --private-key) and X.509 certificate (-C, --cert) won't be supported after the transition period elapses. For more information, see Tell the Tools Who You Are.

OptionDescription

-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-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.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-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

Output

This command returns a table that contains the following information:

  • The ADDRESS identifier

  • The Elastic IP address

  • The instance or network interface to which the Elastic IP address is associated

  • [EC2-VPC] The allocation ID

  • [EC2-VPC] If specified, the private IP address associated with the Elastic IP address

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example associates an Elastic IP address with an instance in EC2-Classic.

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

Example Request

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

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

Example Request

This example associates an Elastic IP address with a network interface.

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

Example Request

This example associates an Elastic IP address with a private IP address for the specified instance in a VPC. The allow-reassociation option allows the Elastic IP address to be associated with the specified instance even if it's already associated with a different instance or a network interface.

PROMPT> ec2-associate-address -a eipalloc-bf66dcd6 -i i-ba6a0dee  -p 10.0.0.85 --allow-reassociation

ADDRESS         i-ba6a0dee      eipalloc-bf66dcd6       eipassoc-9c66dcf5         10.0.0.85