ipam_prefix_list_resolver_rules

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

Overview

Name	ipam_prefix_list_resolver_rules
Type	Resource
Id	aws.ec2.ipam_prefix_list_resolver_rules

Fields

The following fields are returned by SELECT queries:

get_ipam_prefix_list_resolver_rules

Name	Datatype	Description
conditions	string	The conditions that determine which CIDRs are selected by this rule. Conditions specify criteria such as resource type, tags, account IDs, and Regions.
ipam_scope_id	string	The ID of the IPAM scope from which to select CIDRs. This determines whether to select from public or private IP address space.
resource_type	string	For rules of type ipam-resource-cidr, this is the resource type.
rule_type	string	The type of CIDR selection rule. Valid values include include for selecting CIDRs that match the conditions, and exclude for excluding CIDRs that match the conditions.
static_cidr	string	A fixed list of CIDRs that do not change (like a manual list replicated across Regions).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ipam_prefix_list_resolver_rules	select	IpamPrefixListResolverId, region	DryRun, Filter, MaxResults, NextToken	Retrieves the CIDR selection rules for an IPAM prefix list resolver. Use this operation to view the business logic that determines which CIDRs are selected for synchronization with prefix lists.

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
IpamPrefixListResolverId	string	The ID of the IPAM prefix list resolver whose rules you want to retrieve.
region	string	AWS region (default: us-east-1)
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.
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.

SELECT examples

get_ipam_prefix_list_resolver_rules

Retrieves the CIDR selection rules for an IPAM prefix list resolver. Use this operation to view the business logic that determines which CIDRs are selected for synchronization with prefix lists.

SELECT
conditions,
ipam_scope_id,
resource_type,
rule_type,
static_cidr
FROM aws.ec2.ipam_prefix_list_resolver_rules
WHERE IpamPrefixListResolverId = '{{ IpamPrefixListResolverId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;