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, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your 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.

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.

You cannot associate an Elastic IP address with an interface in a different network border group.

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.

The allocation ID. This is required.

Public Property AllowReassociation System.Boolean

Gets and sets the property AllowReassociation.

Reassociation is automatic, but 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. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both.

Public Property NetworkInterfaceId System.String

Gets and sets the property NetworkInterfaceId.

The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

You can specify either the instance ID or the network interface ID, but not both.

Public Property PrivateIpAddress System.String

Gets and sets the property PrivateIpAddress.

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.

Deprecated.

Examples

This example associates the specified Elastic IP address with the specified instance.

To associate an Elastic IP address


var client = new AmazonEC2Client();
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 client = new AmazonEC2Client();
var response = client.AssociateAddress(new AssociateAddressRequest 
{
    AllocationId = "eipalloc-64d5890a",
    NetworkInterfaceId = "eni-1a2b3c4d"
});

string associationId = response.AssociationId;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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