ipam_prefix_list_resolvers

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

Overview

Name	ipam_prefix_list_resolvers
Type	Resource
Id	aws.ec2.ipam_prefix_list_resolvers

Fields

The following fields are returned by SELECT queries:

describe_ipam_prefix_list_resolvers

Name	Datatype	Description
address_family	string	The address family (IPv4 or IPv6) for the IPAM prefix list resolver.
description	string	The description of the IPAM prefix list resolver.
ipam_arn	string	The Amazon Resource Name (ARN) of the IPAM associated with this resolver.
ipam_prefix_list_resolver_arn	string	The Amazon Resource Name (ARN) of the IPAM prefix list resolver.
ipam_prefix_list_resolver_id	string	The ID of the IPAM prefix list resolver.
ipam_region	string	The Amazon Web Services Region where the associated IPAM is located.
last_version_creation_status	string	The status for the last time a version was created. Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
last_version_creation_status_message	string	The status message for the last time a version was created. Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
owner_id	string	The ID of the Amazon Web Services account that owns the IPAM prefix list resolver.
state	string	The current state of the IPAM prefix list resolver. Valid values include create-in-progress, create-complete, create-failed, modify-in-progress, modify-complete, modify-failed, delete-in-progress, delete-complete, and delete-failed.
tags	string	The tags assigned to the IPAM prefix list resolver.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ipam_prefix_list_resolvers	select	region	DryRun, Filter, MaxResults, NextToken, IpamPrefixListResolverId	Describes one or more IPAM prefix list resolvers. Use this operation to view the configuration, status, and properties of your resolvers.
create_ipam_prefix_list_resolver	insert	IpamId, AddressFamily, region	DryRun, Description, Rule, TagSpecification, ClientToken	Creates an IPAM prefix list resolver. An IPAM prefix list resolver is a component that manages the synchronization between IPAM's CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM's database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups. For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.
modify_ipam_prefix_list_resolver	update	IpamPrefixListResolverId, region	DryRun, Description, Rule	Modifies an IPAM prefix list resolver. You can update the description and CIDR selection rules. Changes to rules will trigger re-evaluation and potential updates to associated prefix lists.
delete_ipam_prefix_list_resolver	delete	IpamPrefixListResolverId, region	DryRun	Deletes an IPAM prefix list resolver. Before deleting a resolver, you must first delete all resolver targets associated with it.

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
AddressFamily	string	The address family for the IPAM prefix list resolver. Valid values are ipv4 and ipv6. You must create separate resolvers for IPv4 and IPv6 CIDRs as they cannot be mixed in the same resolver.
IpamId	string	The ID of the IPAM that will serve as the source of the IP address database for CIDR selection. The IPAM must be in the Advanced tier to use this feature.
IpamPrefixListResolverId	string	The ID of the IPAM prefix list resolver to delete.
region	string	AWS region (default: us-east-1)
ClientToken	string	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Description	string	A new description for the IPAM prefix list resolver.
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.
Filter	array	One or more filters to limit the results.
IpamPrefixListResolverId	array	The IDs of the IPAM prefix list resolvers to describe. If not specified, all resolvers in your account are described.
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.
NextToken	string	The token for the next page of results.
Rule	array	The updated CIDR selection rules for the resolver. These rules replace the existing rules entirely.
TagSpecification	array	The tags to apply to the IPAM prefix list resolver during creation. Tags help you organize and manage your Amazon Web Services resources.

SELECT examples

describe_ipam_prefix_list_resolvers

Describes one or more IPAM prefix list resolvers. Use this operation to view the configuration, status, and properties of your resolvers.

SELECT
address_family,
description,
ipam_arn,
ipam_prefix_list_resolver_arn,
ipam_prefix_list_resolver_id,
ipam_region,
last_version_creation_status,
last_version_creation_status_message,
owner_id,
state,
tags
FROM aws.ec2.ipam_prefix_list_resolvers
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND IpamPrefixListResolverId = '{{ IpamPrefixListResolverId }}'
;

INSERT examples

create_ipam_prefix_list_resolver

Creates an IPAM prefix list resolver. An IPAM prefix list resolver is a component that manages the synchronization between IPAM's CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM's database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups. For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.

INSERT INTO aws.ec2.ipam_prefix_list_resolvers (
IpamId,
AddressFamily,
region,
DryRun,
Description,
Rule,
TagSpecification,
ClientToken
)
SELECT 
'{{ IpamId }}',
'{{ AddressFamily }}',
'{{ region }}',
'{{ DryRun }}',
'{{ Description }}',
'{{ Rule }}',
'{{ TagSpecification }}',
'{{ ClientToken }}'
RETURNING
address_family,
description,
ipam_arn,
ipam_prefix_list_resolver_arn,
ipam_prefix_list_resolver_id,
ipam_region,
last_version_creation_status,
last_version_creation_status_message,
owner_id,
state,
tags
;

Manifest

# Description fields are for documentation purposes
- name: ipam_prefix_list_resolvers
props:
  - name: IpamId
    value: "{{ IpamId }}"
    description: Required parameter for the ipam_prefix_list_resolvers resource.
  - name: AddressFamily
    value: "{{ AddressFamily }}"
    description: Required parameter for the ipam_prefix_list_resolvers resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ipam_prefix_list_resolvers 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 prefix list resolver to help you identify its purpose and configuration.
    description: A description for the IPAM prefix list resolver to help you identify its purpose and configuration.
  - name: Rule
    value: "{{ Rule }}"
    description: The CIDR selection rules for the resolver. CIDR selection rules define the business logic for selecting CIDRs from IPAM. If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without any CIDR selection rules, but it will generate empty versions (containing no CIDRs) until you add rules.
    description: The CIDR selection rules for the resolver. CIDR selection rules define the business logic for selecting CIDRs from IPAM. If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without any CIDR selection rules, but it will generate empty versions (containing no CIDRs) until you add rules.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the IPAM prefix list resolver during creation. Tags help you organize and manage your Amazon Web Services resources.
    description: The tags to apply to the IPAM prefix list resolver during creation. Tags help you organize and manage your Amazon Web Services resources.
  - 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.

UPDATE examples

modify_ipam_prefix_list_resolver

Modifies an IPAM prefix list resolver. You can update the description and CIDR selection rules. Changes to rules will trigger re-evaluation and potential updates to associated prefix lists.

UPDATE aws.ec2.ipam_prefix_list_resolvers
SET 
-- No updatable properties
WHERE 
IpamPrefixListResolverId = '{{ IpamPrefixListResolverId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND Description = '{{ Description}}'
AND Rule = '{{ Rule}}'
RETURNING
address_family,
description,
ipam_arn,
ipam_prefix_list_resolver_arn,
ipam_prefix_list_resolver_id,
ipam_region,
last_version_creation_status,
last_version_creation_status_message,
owner_id,
state,
tags;

DELETE examples

delete_ipam_prefix_list_resolver

Deletes an IPAM prefix list resolver. Before deleting a resolver, you must first delete all resolver targets associated with it.

DELETE FROM aws.ec2.ipam_prefix_list_resolvers
WHERE IpamPrefixListResolverId = '{{ IpamPrefixListResolverId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;