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 AssignPrivateIpAddresses operation. Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.

Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.

You must specify either the IP addresses or the IP address count in the request.

You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

Inheritance Hierarchy

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

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

Syntax

C#
public class AssignPrivateIpAddressesRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The AssignPrivateIpAddressesRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AllowReassignment System.Boolean

Gets and sets the property AllowReassignment.

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

Public Property Ipv4PrefixCount System.Int32

Gets and sets the property Ipv4PrefixCount.

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

Public Property Ipv4Prefixes System.Collections.Generic.List<System.String>

Gets and sets the property Ipv4Prefixes.

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

Public Property NetworkInterfaceId System.String

Gets and sets the property NetworkInterfaceId.

The ID of the network interface.

Public Property PrivateIpAddresses System.Collections.Generic.List<System.String>

Gets and sets the property PrivateIpAddresses.

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

Public Property SecondaryPrivateIpAddressCount System.Int32

Gets and sets the property SecondaryPrivateIpAddressCount.

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

Examples

This example assigns the specified secondary private IP address to the specified network interface.

To assign a specific secondary private IP address to an interface


var client = new AmazonEC2Client();
var response = client.AssignPrivateIpAddresses(new AssignPrivateIpAddressesRequest 
{
    NetworkInterfaceId = "eni-e5aa89a3",
    PrivateIpAddresses = new List<string> {
        "10.0.0.82"
    }
});


            

This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with.

To assign secondary private IP addresses that Amazon EC2 selects to an interface


var client = new AmazonEC2Client();
var response = client.AssignPrivateIpAddresses(new AssignPrivateIpAddressesRequest 
{
    NetworkInterfaceId = "eni-e5aa89a3",
    SecondaryPrivateIpAddressCount = 2
});


            

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