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.

In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

Inheritance Hierarchy

System.Object
  Amazon.EC2.Model.IpamPool

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

Syntax

C#
public class IpamPool

The IpamPool type exposes the following members

Constructors

NameDescription
Public Method IpamPool()

Properties

NameTypeDescription
Public Property AddressFamily Amazon.EC2.AddressFamily

Gets and sets the property AddressFamily.

The address family of the pool.

Public Property AllocationDefaultNetmaskLength System.Int32

Gets and sets the property AllocationDefaultNetmaskLength.

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Public Property AllocationMaxNetmaskLength System.Int32

Gets and sets the property AllocationMaxNetmaskLength.

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Public Property AllocationMinNetmaskLength System.Int32

Gets and sets the property AllocationMinNetmaskLength.

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Public Property AllocationResourceTags System.Collections.Generic.List<Amazon.EC2.Model.IpamResourceTag>

Gets and sets the property AllocationResourceTags.

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

Public Property AutoImport System.Boolean

Gets and sets the property AutoImport.

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Public Property AwsService Amazon.EC2.IpamPoolAwsService

Gets and sets the property AwsService.

Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

Public Property Description System.String

Gets and sets the property Description.

The description of the IPAM pool.

Public Property IpamArn System.String

Gets and sets the property IpamArn.

The ARN of the IPAM.

Public Property IpamPoolArn System.String

Gets and sets the property IpamPoolArn.

The ARN of the IPAM pool.

Public Property IpamPoolId System.String

Gets and sets the property IpamPoolId.

The ID of the IPAM pool.

Public Property IpamRegion System.String

Gets and sets the property IpamRegion.

The Amazon Web Services Region of the IPAM pool.

Public Property IpamScopeArn System.String

Gets and sets the property IpamScopeArn.

The ARN of the scope of the IPAM pool.

Public Property IpamScopeType Amazon.EC2.IpamScopeType

Gets and sets the property IpamScopeType.

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

Public Property Locale System.String

Gets and sets the property Locale.

The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

Public Property OwnerId System.String

Gets and sets the property OwnerId.

The Amazon Web Services account ID of the owner of the IPAM pool.

Public Property PoolDepth System.Int32

Gets and sets the property PoolDepth.

The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

Public Property PubliclyAdvertisable System.Boolean

Gets and sets the property PubliclyAdvertisable.

Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

Public Property SourceIpamPoolId System.String

Gets and sets the property SourceIpamPoolId.

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

Public Property State Amazon.EC2.IpamPoolState

Gets and sets the property State.

The state of the IPAM pool.

Public Property StateMessage System.String

Gets and sets the property StateMessage.

A message related to the failed creation of an IPAM pool.

Public Property Tags System.Collections.Generic.List<Amazon.EC2.Model.Tag>

Gets and sets the property Tags.

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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