ipam_prefix_list_resolver_targets

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

Overview

Name	ipam_prefix_list_resolver_targets
Type	Resource
Id	aws.ec2.ipam_prefix_list_resolver_targets

Fields

The following fields are returned by SELECT queries:

describe_ipam_prefix_list_resolver_targets

Name	Datatype	Description
desired_version	integer	The desired version of the prefix list that this target should synchronize with.
ipam_prefix_list_resolver_id	string	The ID of the IPAM prefix list resolver associated with this target.
ipam_prefix_list_resolver_target_arn	string	The Amazon Resource Name (ARN) of the IPAM prefix list resolver target.
ipam_prefix_list_resolver_target_id	string	The ID of the IPAM prefix list resolver target.
last_synced_version	integer	The version of the prefix list that was last successfully synchronized by this target.
owner_id	string	The ID of the Amazon Web Services account that owns the IPAM prefix list resolver target.
prefix_list_id	string	The ID of the managed prefix list associated with this target.
prefix_list_region	string	The Amazon Web Services Region where the prefix list associated with this target is located.
state	string	The current state of the IPAM prefix list resolver target. 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.
state_message	string	A message describing the current state of the IPAM prefix list resolver target, including any error information.
tags	string	The tags assigned to the IPAM prefix list resolver target.
track_latest_version	boolean	Indicates whether this target automatically tracks the latest version of the prefix list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ipam_prefix_list_resolver_targets	select	region	DryRun, Filter, MaxResults, NextToken, IpamPrefixListResolverTargetId, IpamPrefixListResolverId	Describes one or more IPAM prefix list resolver Targets. Use this operation to view the configuration and status of resolver targets.
create_ipam_prefix_list_resolver_target	insert	IpamPrefixListResolverId, PrefixListId, PrefixListRegion, TrackLatestVersion, region	DryRun, DesiredVersion, TagSpecification, ClientToken	Creates an IPAM prefix list resolver target. An IPAM prefix list resolver target is an association between a specific customer-managed prefix list and an IPAM prefix list resolver. The target enables the resolver to synchronize CIDRs selected by its rules into the specified prefix list, which can then be referenced in Amazon Web Services resources. 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_target	update	IpamPrefixListResolverTargetId, region	DryRun, DesiredVersion, TrackLatestVersion, ClientToken	Modifies an IPAM prefix list resolver target. You can update version tracking settings and the desired version of the target prefix list.
delete_ipam_prefix_list_resolver_target	delete	IpamPrefixListResolverTargetId, region	DryRun	Deletes an IPAM prefix list resolver target. This removes the association between the resolver and the managed prefix list, stopping automatic CIDR synchronization. For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM 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
IpamPrefixListResolverId	string	The ID of the IPAM prefix list resolver that will manage the synchronization of CIDRs to the target prefix list.
IpamPrefixListResolverTargetId	string	The ID of the IPAM prefix list resolver target to delete.
PrefixListId	string	The ID of the managed prefix list that will be synchronized with CIDRs selected by the IPAM prefix list resolver. This prefix list becomes an IPAM managed prefix list. An IPAM-managed prefix list is a customer-managed prefix list that has been associated with an IPAM prefix list resolver target. When a prefix list becomes IPAM managed, its CIDRs are automatically synchronized based on the IPAM prefix list resolver's CIDR selection rules, and direct CIDR modifications are restricted.
PrefixListRegion	string	The Amazon Web Services Region where the prefix list is located. This is required when referencing a prefix list in a different Region.
TrackLatestVersion	boolean	Indicates whether the resolver target should automatically track the latest version of the prefix list. When enabled, the target will always synchronize with the most current version of the prefix list. Choose this for automatic updates when you want your prefix lists to stay current with infrastructure changes without manual intervention.
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.
DesiredVersion	integer (int64)	The desired version of the prefix list to target. This allows you to pin the target to a specific version.
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	string	The ID of the IPAM prefix list resolver to filter targets by. Only targets associated with this resolver will be returned.
IpamPrefixListResolverTargetId	array	The IDs of the IPAM prefix list resolver Targets to describe. If not specified, all targets 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.
TagSpecification	array	The tags to apply to the IPAM prefix list resolver target during creation. Tags help you organize and manage your Amazon Web Services resources.
TrackLatestVersion	boolean	Indicates whether the resolver target should automatically track the latest version of the prefix list. When enabled, the target will always synchronize with the most current version. Choose this for automatic updates when you want your prefix lists to stay current with infrastructure changes without manual intervention.

SELECT examples

describe_ipam_prefix_list_resolver_targets

Describes one or more IPAM prefix list resolver Targets. Use this operation to view the configuration and status of resolver targets.

SELECT
desired_version,
ipam_prefix_list_resolver_id,
ipam_prefix_list_resolver_target_arn,
ipam_prefix_list_resolver_target_id,
last_synced_version,
owner_id,
prefix_list_id,
prefix_list_region,
state,
state_message,
tags,
track_latest_version
FROM aws.ec2.ipam_prefix_list_resolver_targets
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND IpamPrefixListResolverTargetId = '{{ IpamPrefixListResolverTargetId }}'
AND IpamPrefixListResolverId = '{{ IpamPrefixListResolverId }}'
;

INSERT examples

create_ipam_prefix_list_resolver_target

Creates an IPAM prefix list resolver target. An IPAM prefix list resolver target is an association between a specific customer-managed prefix list and an IPAM prefix list resolver. The target enables the resolver to synchronize CIDRs selected by its rules into the specified prefix list, which can then be referenced in Amazon Web Services resources. 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_resolver_targets (
IpamPrefixListResolverId,
PrefixListId,
PrefixListRegion,
TrackLatestVersion,
region,
DryRun,
DesiredVersion,
TagSpecification,
ClientToken
)
SELECT 
'{{ IpamPrefixListResolverId }}',
'{{ PrefixListId }}',
'{{ PrefixListRegion }}',
'{{ TrackLatestVersion }}',
'{{ region }}',
'{{ DryRun }}',
'{{ DesiredVersion }}',
'{{ TagSpecification }}',
'{{ ClientToken }}'
RETURNING
desired_version,
ipam_prefix_list_resolver_id,
ipam_prefix_list_resolver_target_arn,
ipam_prefix_list_resolver_target_id,
last_synced_version,
owner_id,
prefix_list_id,
prefix_list_region,
state,
state_message,
tags,
track_latest_version
;

Manifest

# Description fields are for documentation purposes
- name: ipam_prefix_list_resolver_targets
props:
  - name: IpamPrefixListResolverId
    value: "{{ IpamPrefixListResolverId }}"
    description: Required parameter for the ipam_prefix_list_resolver_targets resource.
  - name: PrefixListId
    value: "{{ PrefixListId }}"
    description: Required parameter for the ipam_prefix_list_resolver_targets resource.
  - name: PrefixListRegion
    value: "{{ PrefixListRegion }}"
    description: Required parameter for the ipam_prefix_list_resolver_targets resource.
  - name: TrackLatestVersion
    value: {{ TrackLatestVersion }}
    description: Required parameter for the ipam_prefix_list_resolver_targets resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ipam_prefix_list_resolver_targets 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: DesiredVersion
    value: "{{ DesiredVersion }}"
    description: The specific version of the prefix list to target. If not specified, the resolver will target the latest version.
    description: The specific version of the prefix list to target. If not specified, the resolver will target the latest version.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the IPAM prefix list resolver target during creation. Tags help you organize and manage your Amazon Web Services resources.
    description: The tags to apply to the IPAM prefix list resolver target 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_target

Modifies an IPAM prefix list resolver target. You can update version tracking settings and the desired version of the target prefix list.

UPDATE aws.ec2.ipam_prefix_list_resolver_targets
SET 
-- No updatable properties
WHERE 
IpamPrefixListResolverTargetId = '{{ IpamPrefixListResolverTargetId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND DesiredVersion = '{{ DesiredVersion}}'
AND TrackLatestVersion = {{ TrackLatestVersion}}
AND ClientToken = '{{ ClientToken}}'
RETURNING
desired_version,
ipam_prefix_list_resolver_id,
ipam_prefix_list_resolver_target_arn,
ipam_prefix_list_resolver_target_id,
last_synced_version,
owner_id,
prefix_list_id,
prefix_list_region,
state,
state_message,
tags,
track_latest_version;

DELETE examples

delete_ipam_prefix_list_resolver_target

Deletes an IPAM prefix list resolver target. This removes the association between the resolver and the managed prefix list, stopping automatic CIDR synchronization. For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.

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