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 EC2 User Guide.
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. To attempt to recover an Elastic IP address that you released, specify it in this operation.
For more information, see Elastic IP Addresses in the Amazon EC2 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
Amazon.Runtime.AmazonWebServiceRequest
Amazon.EC2.AmazonEC2Request
Amazon.EC2.Model.AllocateAddressRequest
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
Syntax
public class AllocateAddressRequest : AmazonEC2Request IAmazonWebServiceRequest
The AllocateAddressRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AllocateAddressRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Address | System.String |
Gets and sets the property Address. The Elastic IP address to recover or an IPv4 address from an address pool. |
|
|
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. |
|
|
Domain | Amazon.EC2.DomainType |
Gets and sets the property Domain.
The network ( |
|
|
DryRun | System.Nullable<System.Boolean> |
Gets and sets the property DryRun.
Checks whether you have the required permissions for the action, without actually
making the request, and provides an error response. If you have the required permissions,
the error response is |
|
|
IpamPoolId | System.String |
Gets and sets the property IpamPoolId. The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide. |
|
|
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. |
|
|
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 |
|
|
TagSpecifications | System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification> |
Gets and sets the property TagSpecifications. The tags to assign to the Elastic IP address. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
Examples
This example allocates an Elastic IP address.
To allocate an Elastic IP address
var client = new AmazonEC2Client();
var response = client.AllocateAddress(new AllocateAddressRequest
{
});
string allocationId = response.AllocationId;
string domain = response.Domain;
string networkBorderGroup = response.NetworkBorderGroup;
string publicIp = response.PublicIp;
string publicIpv4Pool = response.PublicIpv4Pool;
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer