| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
AssociateAddress
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 don't 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
AllowReassociation parameter.
This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.
Request Parameters
PublicIpThe Elastic IP address.
Type: String
Default: None
Required: Conditional
Condition: Required for Elastic IP addresses for EC2-Classic.
InstanceIdThe ID of the instance.
Type: String
Default: None
Required: Conditional
Condition: Required for EC2-Classic. For a VPC, you can specify either an instance ID or a network interface ID, but not both.
AllocationId[EC2-VPC] The allocation ID.
Type: String
Default: None
Required: Conditional
Condition: Required for a VPC.
NetworkInterfaceId[EC2-VPC] The ID of the network interface. Association fails when specifying an instance ID unless exactly one interface is attached.
Type: String
Default: None
Required: Conditional
Condition: If the instance has more than one network interface, you must specify a network interface ID.
PrivateIpAddress[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
AllowReassociation[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. If the Elastic IP address is associated, and this option is not specified, the operation fails.
Type: Boolean
Default:
falseif not specifiedRequired: No
Response Elements
The following elements are returned in an
AssociateAddressResponse element.
requestIdThe ID of the request.
Type: xsd:string
returnReturns
trueif the request succeeds. Otherwise, returns an error.Type: xsd:boolean
associationId[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
Type: xsd:string
Examples
Example Request
This example associates an Elastic IP address with an instance in EC2-Classic.
https://ec2.amazonaws.com/?Action=AssociateAddress &InstanceId=i-2ea64347 &PublicIp=192.0.2.1 &AUTHPARAMS
Example Response
<AssociateAddressResponse xmlns="http://ec2.amazonaws.com/doc/2013-02-01/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <return>true</return> </AssociateAddressResponse>
Example Request
This example associates a Elastic IP address with an instance in a VPC and allows the Elastic IP address to be re-assigned to this instance if it's currently assigned to another instance or network interface.
https://ec2.amazonaws.com/?Action=AssociateAddress &InstanceId=i-4fd2431a &AllocationId=eipalloc-5723d13e &AllowReassignment=true &AUTHPARAMS
Example Response
<AssociateAddressResponse xmlns="http://ec2.amazonaws.com/doc/2013-02-01/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <return>true</return> <associationId>eipassoc-fc5ca095</associationId> </AssociateAddressResponse>
