ipams

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

Overview

Name	ipams
Type	Resource
Id	aws.ec2.ipams

Fields

The following fields are returned by SELECT queries:

describe_ipams

Name	Datatype	Description
default_resource_discovery_association_id	string	The IPAM's default resource discovery association ID.
default_resource_discovery_id	string	The IPAM's default resource discovery ID.
description	string	The description for the IPAM.
enable_private_gua	boolean	Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
ipam_arn	string	The Amazon Resource Name (ARN) of the IPAM.
ipam_id	string	The ID of the IPAM.
ipam_region	string	The Amazon Web Services Region of the IPAM.
metered_account	string	A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide. Possible values: ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
operating_regions	string	The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
owner_id	string	The Amazon Web Services account ID of the owner of the IPAM.
private_default_scope_id	string	The ID of the IPAM's default private scope.
public_default_scope_id	string	The ID of the IPAM's default public scope.
resource_discovery_association_count	integer	The IPAM's resource discovery association count.
scope_count	integer	The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
state	string	The state of the IPAM.
state_message	string	The state message.
tags	string	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.
tier	string	IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ipams	select	region	DryRun, Filter, MaxResults, NextToken, IpamId	Get information about your IPAM pools. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
create_ipam	insert	region	DryRun, Description, OperatingRegion, TagSpecification, ClientToken, Tier, EnablePrivateGua, MeteredAccount	Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
modify_ipam	update	IpamId, region	DryRun, Description, AddOperatingRegion, RemoveOperatingRegion, Tier, EnablePrivateGua, MeteredAccount	Modify the configurations of an IPAM.
delete_ipam	delete	IpamId, region	DryRun, Cascade	Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs. For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
disable_ipam_organization_admin_account	exec	DelegatedAdminAccountId, region	DryRun	Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.
disable_ipam_policy	exec	IpamPolicyId, region	DryRun, OrganizationTargetId	Disables an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
enable_ipam_internet_registry_association	exec	IpamInternetRegistryAssociationId, RpkiVersion, ServiceUri, ChildHandle, ParentHandle, ParentBpkiTa, region	DryRun, ClientToken	Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry.
enable_ipam_organization_admin_account	exec	DelegatedAdminAccountId, region	DryRun	Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.
enable_ipam_policy	exec	IpamPolicyId, region	DryRun, OrganizationTargetId	Enables an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations. For more information, see Define public IPv4 allocation strategy with IPAM policies 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.

Name	Datatype	Description
ChildHandle	string	The child handle for the BPKI certificate hierarchy from the Parent Response XML.
DelegatedAdminAccountId	string	The Organizations member account ID that you want to enable as the IPAM account.
IpamId	string	The ID of the IPAM to delete.
IpamInternetRegistryAssociationId	string	The ID of the IPAM internet registry association to enable.
IpamPolicyId	string	The ID of the IPAM policy to enable.
ParentBpkiTa	string	The parent BPKI Trust Anchor certificate in PEM format from the Parent Response XML.
ParentHandle	string	The parent handle for the BPKI certificate hierarchy from the Parent Response XML.
RpkiVersion	string	The RPKI version to use from the Parent Response XML.
ServiceUri	string	The RPKI service URI for the publication point from the Parent Response XML.
region	string	AWS region (default: us-east-1)
AddOperatingRegion	array	Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
Cascade	boolean	Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following: Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes. No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged. Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes. Deletes all IPAM pools in private scopes. Deletes all non-default private scopes in the IPAM. Deletes the default public and private scopes and the IPAM.
ClientToken	string	A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
Description	string	The description of the IPAM you want to modify.
DryRun	boolean	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 DryRunOperation. Otherwise, it is UnauthorizedOperation.
EnablePrivateGua	boolean	Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
Filter	array	One or more filters for the request. For more information about filtering, see Filtering CLI output.
IpamId	array	The IDs of the IPAMs you want information on.
MaxResults	integer	The 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.
MeteredAccount	string	A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide. Possible values: ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
NextToken	string	The token for the next page of results.
OperatingRegion	array	The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
OrganizationTargetId	string	A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied. The ID of the Amazon Web Services Organizations target for which to enable the IPAM policy. This parameter is required only when IPAM is integrated with Amazon Web Services Organizations. When IPAM is not integrated with Amazon Web Services Organizations, omit this parameter and the policy will apply to the current account.
RemoveOperatingRegion	array	The operating Regions to remove.
TagSpecification	array	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.
Tier	string	IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

SELECT examples

describe_ipams

Get information about your IPAM pools. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

SELECT
default_resource_discovery_association_id,
default_resource_discovery_id,
description,
enable_private_gua,
ipam_arn,
ipam_id,
ipam_region,
metered_account,
operating_regions,
owner_id,
private_default_scope_id,
public_default_scope_id,
resource_discovery_association_count,
scope_count,
state,
state_message,
tags,
tier
FROM aws.ec2.ipams
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND IpamId = '{{ IpamId }}'
;

INSERT examples

create_ipam

Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.

INSERT INTO aws.ec2.ipams (
region,
DryRun,
Description,
OperatingRegion,
TagSpecification,
ClientToken,
Tier,
EnablePrivateGua,
MeteredAccount
)
SELECT 
'{{ region }}',
'{{ DryRun }}',
'{{ Description }}',
'{{ OperatingRegion }}',
'{{ TagSpecification }}',
'{{ ClientToken }}',
'{{ Tier }}',
'{{ EnablePrivateGua }}',
'{{ MeteredAccount }}'
RETURNING
default_resource_discovery_association_id,
default_resource_discovery_id,
description,
enable_private_gua,
ipam_arn,
ipam_id,
ipam_region,
metered_account,
operating_regions,
owner_id,
private_default_scope_id,
public_default_scope_id,
resource_discovery_association_count,
scope_count,
state,
state_message,
tags,
tier
;

Manifest

# Description fields are for documentation purposes
- name: ipams
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ipams resource.
  - name: DryRun
    value: {{ DryRun }}
    description: 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 DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: 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 DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - name: Description
    value: "{{ Description }}"
    description: A description for the IPAM.
    description: A description for the IPAM.
  - name: OperatingRegion
    value: "{{ OperatingRegion }}"
    description: The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
    description: The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: 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.
    description: 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.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
    description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
  - name: Tier
    value: "{{ Tier }}"
    description: IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
    description: IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
  - name: EnablePrivateGua
    value: {{ EnablePrivateGua }}
    description: Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
    description: Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
  - name: MeteredAccount
    value: "{{ MeteredAccount }}"
    description: A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide. Possible values: ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
    description: A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide. Possible values: ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.

UPDATE examples

modify_ipam

Modify the configurations of an IPAM.

UPDATE aws.ec2.ipams
SET 
-- No updatable properties
WHERE 
IpamId = '{{ IpamId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND Description = '{{ Description}}'
AND AddOperatingRegion = '{{ AddOperatingRegion}}'
AND RemoveOperatingRegion = '{{ RemoveOperatingRegion}}'
AND Tier = '{{ Tier}}'
AND EnablePrivateGua = {{ EnablePrivateGua}}
AND MeteredAccount = '{{ MeteredAccount}}'
RETURNING
default_resource_discovery_association_id,
default_resource_discovery_id,
description,
enable_private_gua,
ipam_arn,
ipam_id,
ipam_region,
metered_account,
operating_regions,
owner_id,
private_default_scope_id,
public_default_scope_id,
resource_discovery_association_count,
scope_count,
state,
state_message,
tags,
tier;

DELETE examples

delete_ipam

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs. For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.

DELETE FROM aws.ec2.ipams
WHERE IpamId = '{{ IpamId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
AND Cascade = '{{ Cascade }}'
;

Lifecycle Methods

disable_ipam_organization_admin_account

Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.

EXEC aws.ec2.ipams.disable_ipam_organization_admin_account 
@DelegatedAdminAccountId='{{ DelegatedAdminAccountId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

disable_ipam_policy

Disables an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.

EXEC aws.ec2.ipams.disable_ipam_policy 
@IpamPolicyId='{{ IpamPolicyId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}, 
@OrganizationTargetId='{{ OrganizationTargetId }}'
;

enable_ipam_internet_registry_association

Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry.

EXEC aws.ec2.ipams.enable_ipam_internet_registry_association 
@IpamInternetRegistryAssociationId='{{ IpamInternetRegistryAssociationId }}' --required, 
@RpkiVersion='{{ RpkiVersion }}' --required, 
@ServiceUri='{{ ServiceUri }}' --required, 
@ChildHandle='{{ ChildHandle }}' --required, 
@ParentHandle='{{ ParentHandle }}' --required, 
@ParentBpkiTa='{{ ParentBpkiTa }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}, 
@ClientToken='{{ ClientToken }}'
;

enable_ipam_organization_admin_account

Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.

EXEC aws.ec2.ipams.enable_ipam_organization_admin_account 
@DelegatedAdminAccountId='{{ DelegatedAdminAccountId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

enable_ipam_policy

Enables an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations. For more information, see Define public IPv4 allocation strategy with IPAM policies in the Amazon VPC IPAM User Guide.

EXEC aws.ec2.ipams.enable_ipam_policy 
@IpamPolicyId='{{ IpamPolicyId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}, 
@OrganizationTargetId='{{ OrganizationTargetId }}'
;