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 AllocateAddress operation. Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

Inheritance Hierarchy

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

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

Syntax

C#
public class AllocateAddressRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The AllocateAddressRequest type exposes the following members

Constructors

NameDescription
Public Method AllocateAddressRequest()

Properties

NameTypeDescription
Public Property Address System.String

Gets and sets the property Address.

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Public Property CustomerOwnedIpv4Pool System.String

Gets and sets the property CustomerOwnedIpv4Pool.

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Public Property Domain Amazon.EC2.DomainType

Gets and sets the property Domain.

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

Public Property NetworkBorderGroup System.String

Gets and sets the property NetworkBorderGroup.

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.

Public Property PublicIpv4Pool System.String

Gets and sets the property PublicIpv4Pool.

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Public Property TagSpecifications System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification>

Gets and sets the property TagSpecifications.

The tags to assign to the Elastic IP address.

Examples

This example allocates an Elastic IP address to use with an instance in a VPC.

To allocate an Elastic IP address for EC2-VPC


var client = new AmazonEC2Client();
var response = client.AllocateAddress(new AllocateAddressRequest 
{
    Domain = "vpc"
});

string allocationId = response.AllocationId;
string domain = response.Domain;
string publicIp = response.PublicIp;

            

This example allocates an Elastic IP address to use with an instance in EC2-Classic.

To allocate an Elastic IP address for EC2-Classic


var client = new AmazonEC2Client();
var response = client.AllocateAddress(new AllocateAddressRequest 
{
});

string domain = response.Domain;
string publicIp = response.PublicIp;

            

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