AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the AssociateAddress operation. Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.

[VPC in an EC2-Classic account] 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 allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.AssociateAddressRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class AssociateAddressRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The AssociateAddressRequest type exposes the following members

Constructors

NameDescription
Public Method AssociateAddressRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method AssociateAddressRequest(string, string)

Instantiates AssociateAddressRequest with the parameterized properties

Properties

NameTypeDescription
Public Property AllocationId System.String

Gets and sets the property AllocationId.

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

Public Property AllowReassociation System.Boolean

Gets and sets the property AllowReassociation.

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

Public Property NetworkInterfaceId System.String

Gets and sets the property NetworkInterfaceId.

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

Public Property PrivateIpAddress System.String

Gets and sets the property 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.

Public Property PublicIp System.String

Gets and sets the property PublicIp.

The Elastic IP address. This is required for EC2-Classic.

Examples

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

To associate an Elastic IP address in EC2-VPC


var response = client.AssociateAddress(new AssociateAddressRequest 
{
    AllocationId = "eipalloc-64d5890a",
    InstanceId = "i-0b263919b6498b123"
});

string associationId = response.AssociationId;

            

This example associates the specified Elastic IP address with the specified network interface.

To associate an Elastic IP address with a network interface


var response = client.AssociateAddress(new AssociateAddressRequest 
{
    AllocationId = "eipalloc-64d5890a",
    NetworkInterfaceId = "eni-1a2b3c4d"
});

string associationId = response.AssociationId;

            

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

To associate an Elastic IP address in EC2-Classic


var response = client.AssociateAddress(new AssociateAddressRequest 
{
    InstanceId = "i-07ffe74c7330ebf53",
    PublicIp = "198.51.100.0"
});


            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms