Skip to main content

ipam_pools

Creates, updates, deletes, gets or lists an ipam_pools resource.

Overview​

Nameipam_pools
TypeResource
Idaws.ec2.ipam_pools

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
address_familystringThe address family of the pool.
allocation_default_netmask_lengthintegerThe 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.
allocation_max_netmask_lengthintegerThe 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.
allocation_min_netmask_lengthintegerThe 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.
allocation_resource_tagsstringTags 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.
auto_importbooleanIf 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.
aws_servicestringLimits 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.
descriptionstringThe description of the IPAM pool.
ipam_arnstringThe ARN of the IPAM.
ipam_pool_arnstringThe Amazon Resource Name (ARN) of the IPAM pool.
ipam_pool_idstringThe ID of the IPAM pool.
ipam_regionstringThe Amazon Web Services Region of the IPAM pool.
ipam_scope_arnstringThe ARN of the scope of the IPAM pool.
ipam_scope_typestringIn 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.
localestringThe locale of the IPAM pool. The locale for the pool should be one of the following: An Amazon Web Services Region where you want this IPAM pool to be available for allocations. The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope. 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.
owner_idstringThe Amazon Web Services account ID of the owner of the IPAM pool.
pool_depthintegerThe 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_ip_sourcestringThe IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
publicly_advertisablebooleanDetermines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.
source_ipam_pool_idstringThe ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
source_resourcestringThe resource used to provision CIDRs to a resource planning pool.
statestringThe state of the IPAM pool.
state_messagestringThe state message.
tagsstringThe 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.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_ipam_poolsselectregionDryRun, Filter, MaxResults, NextToken, IpamPoolIdGet information about your IPAM pools.
create_ipam_poolinsertIpamScopeId, AddressFamily, regionDryRun, Locale, SourceIpamPoolId, Description, AutoImport, PubliclyAdvertisable, AllocationMinNetmaskLength, AllocationMaxNetmaskLength, AllocationDefaultNetmaskLength, AllocationResourceTag, TagSpecification, ClientToken, AwsService, PublicIpSource, SourceResourceCreate an IP address pool for Amazon VPC IP Address Manager (IPAM). 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. For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
modify_ipam_poolupdateIpamPoolId, regionDryRun, Description, AutoImport, AllocationMinNetmaskLength, AllocationMaxNetmaskLength, AllocationDefaultNetmaskLength, ClearAllocationDefaultNetmaskLength, AddAllocationResourceTag, RemoveAllocationResourceTagModify the configurations of an IPAM pool. For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
delete_ipam_pooldeleteIpamPoolId, regionDryRun, CascadeDelete an IPAM pool. You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr. For more information, see Delete a pool in the Amazon VPC IPAM User Guide.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
AddressFamilystringThe IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
IpamPoolIdstringThe ID of the pool to delete.
IpamScopeIdstringThe ID of the scope in which you would like to create the IPAM pool.
regionstringAWS region (default: us-east-1)
AddAllocationResourceTagarrayAdd tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
AllocationDefaultNetmaskLengthintegerThe 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.
AllocationMaxNetmaskLengthintegerThe maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.
AllocationMinNetmaskLengthintegerThe minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.
AllocationResourceTagarrayTags 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.
AutoImportbooleanIf true, 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.
AwsServicestringLimits 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.
CascadebooleanEnables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools. You can only use this option to delete pools in the private scope or pools in the public scope with a source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
ClearAllocationDefaultNetmaskLengthbooleanClear the default netmask length allocation rule for this pool.
ClientTokenstringA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
DescriptionstringThe description of the IPAM pool you want to modify.
DryRunbooleanA 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 DryRunOperation. Otherwise, it is UnauthorizedOperation.
FilterarrayOne or more filters for the request. For more information about filtering, see Filtering CLI output.
IpamPoolIdarrayThe IDs of the IPAM pools you would like information on.
LocalestringThe locale for the pool should be one of the following: An Amazon Web Services Region where you want this IPAM pool to be available for allocations. The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope. Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone. Default is none and means any locale.
MaxResultsintegerThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
NextTokenstringThe token for the next page of results.
PublicIpSourcestringThe IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
PubliclyAdvertisablebooleanDetermines if the pool is publicly advertisable. The request can only contain PubliclyAdvertisable if AddressFamily is ipv6 and PublicIpSource is byoip.
RemoveAllocationResourceTagarrayRemove tag allocation rules from a pool.
SourceIpamPoolIdstringThe ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.
SourceResourceobjectThe resource used to provision CIDRs to a resource planning pool.
TagSpecificationarrayThe 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.

SELECT examples​

Get information about your IPAM pools.

SELECT
address_family,
allocation_default_netmask_length,
allocation_max_netmask_length,
allocation_min_netmask_length,
allocation_resource_tags,
auto_import,
aws_service,
description,
ipam_arn,
ipam_pool_arn,
ipam_pool_id,
ipam_region,
ipam_scope_arn,
ipam_scope_type,
locale,
owner_id,
pool_depth,
public_ip_source,
publicly_advertisable,
source_ipam_pool_id,
source_resource,
state,
state_message,
tags
FROM aws.ec2.ipam_pools
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND IpamPoolId = '{{ IpamPoolId }}'
;

INSERT examples​

Create an IP address pool for Amazon VPC IP Address Manager (IPAM). 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. For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.

INSERT INTO aws.ec2.ipam_pools (
IpamScopeId,
AddressFamily,
region,
DryRun,
Locale,
SourceIpamPoolId,
Description,
AutoImport,
PubliclyAdvertisable,
AllocationMinNetmaskLength,
AllocationMaxNetmaskLength,
AllocationDefaultNetmaskLength,
AllocationResourceTag,
TagSpecification,
ClientToken,
AwsService,
PublicIpSource,
SourceResource
)
SELECT 
'{{ IpamScopeId }}',
'{{ AddressFamily }}',
'{{ region }}',
'{{ DryRun }}',
'{{ Locale }}',
'{{ SourceIpamPoolId }}',
'{{ Description }}',
'{{ AutoImport }}',
'{{ PubliclyAdvertisable }}',
'{{ AllocationMinNetmaskLength }}',
'{{ AllocationMaxNetmaskLength }}',
'{{ AllocationDefaultNetmaskLength }}',
'{{ AllocationResourceTag }}',
'{{ TagSpecification }}',
'{{ ClientToken }}',
'{{ AwsService }}',
'{{ PublicIpSource }}',
'{{ SourceResource }}'
RETURNING
address_family,
allocation_default_netmask_length,
allocation_max_netmask_length,
allocation_min_netmask_length,
allocation_resource_tags,
auto_import,
aws_service,
description,
ipam_arn,
ipam_pool_arn,
ipam_pool_id,
ipam_region,
ipam_scope_arn,
ipam_scope_type,
locale,
owner_id,
pool_depth,
public_ip_source,
publicly_advertisable,
source_ipam_pool_id,
source_resource,
state,
state_message,
tags
;

UPDATE examples​

Modify the configurations of an IPAM pool. For more information, see Modify a pool in the Amazon VPC IPAM User Guide.

UPDATE aws.ec2.ipam_pools
SET 
-- No updatable properties
WHERE 
IpamPoolId = '{{ IpamPoolId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND Description = '{{ Description}}'
AND AutoImport = {{ AutoImport}}
AND AllocationMinNetmaskLength = '{{ AllocationMinNetmaskLength}}'
AND AllocationMaxNetmaskLength = '{{ AllocationMaxNetmaskLength}}'
AND AllocationDefaultNetmaskLength = '{{ AllocationDefaultNetmaskLength}}'
AND ClearAllocationDefaultNetmaskLength = {{ ClearAllocationDefaultNetmaskLength}}
AND AddAllocationResourceTag = '{{ AddAllocationResourceTag}}'
AND RemoveAllocationResourceTag = '{{ RemoveAllocationResourceTag}}'
RETURNING
address_family,
allocation_default_netmask_length,
allocation_max_netmask_length,
allocation_min_netmask_length,
allocation_resource_tags,
auto_import,
aws_service,
description,
ipam_arn,
ipam_pool_arn,
ipam_pool_id,
ipam_region,
ipam_scope_arn,
ipam_scope_type,
locale,
owner_id,
pool_depth,
public_ip_source,
publicly_advertisable,
source_ipam_pool_id,
source_resource,
state,
state_message,
tags;

DELETE examples​

Delete an IPAM pool. You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr. For more information, see Delete a pool in the Amazon VPC IPAM User Guide.

DELETE FROM aws.ec2.ipam_pools
WHERE IpamPoolId = '{{ IpamPoolId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
AND Cascade = '{{ Cascade }}'
;
Last updated on