Container for the parameters to the AllocateIpamPoolCidr operation. Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.
This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.EC2.AmazonEC2Request
Amazon.EC2.Model.AllocateIpamPoolCidrRequest
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
Syntax
public class AllocateIpamPoolCidrRequest : AmazonEC2Request IAmazonWebServiceRequest
The AllocateIpamPoolCidrRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AllocateIpamPoolCidrRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AllowedCidrs | System.Collections.Generic.List<System.String> |
Gets and sets the property AllowedCidrs. Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation. 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. |
|
|
Cidr | System.String |
Gets and sets the property Cidr. The CIDR you would like to allocate from the IPAM pool. Note the following:
Possible values: Any available IPv4 or IPv6 CIDR. |
|
|
ClientToken | System.String |
Gets and sets the property ClientToken. A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. |
|
|
Description | System.String |
Gets and sets the property Description. A description for the allocation. |
|
|
DisallowedCidrs | System.Collections.Generic.List<System.String> |
Gets and sets the property DisallowedCidrs. Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation. 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. |
|
|
DryRun | System.Nullable<System.Boolean> |
Gets and sets the property DryRun.
A check for 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 the IPAM pool from which you would like to allocate a CIDR. |
|
|
NetmaskLength | System.Nullable<System.Int32> |
Gets and sets the property NetmaskLength. The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. |
|
|
PreviewNextCidr | System.Nullable<System.Boolean> |
Gets and sets the property PreviewNextCidr. A preview of the next available CIDR in a pool. |
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