ipam_routing_policy_registrations

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

Overview

Name	ipam_routing_policy_registrations
Type	Resource
Id	aws.ec2.ipam_routing_policy_registrations

Fields

The following fields are returned by SELECT queries:

get_ipam_routing_policy_registrations

Name	Datatype	Description
asns	string	The Autonomous System Numbers (ASNs) authorized to originate the prefix.
cidr	string	The IP address prefix in CIDR notation authorized by the ROA.
description	string	The description of the routing policy registration.
latest_delta_id	string	The ID of the most recent delta that modified this registration.
max_length	integer	The maximum prefix length that the ASNs are authorized to announce.
permit_more_specific_announcements	boolean	Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false.
state	string	The state of the routing policy registration. Valid values: pending-activate | activate-failed | create-in-progress | create-complete | update-in-progress | update-complete | delete-in-progress | delete-complete.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ipam_routing_policy_registrations	select	IpamInternetRegistryAssociationId, region	DryRun, Cidr, MaxResults, NextToken	Retrieves routing policy registrations for an IPAM internet registry association. Each registration represents a Route Origin Authorization (ROA) that has been created or is pending publication to the RPKI. We recommend using pagination to ensure that the operation returns quickly and successfully.
create_ipam_routing_policy_registration	insert	IpamInternetRegistryAssociationId, region	DryRun, Cidr, Asn, PermitMoreSpecificAnnouncements, MaxLength, Description, Force, ClientToken	Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs.
modify_ipam_routing_policy_registration	update	IpamInternetRegistryAssociationId, region	DryRun, Cidr, Asn, PermitMoreSpecificAnnouncements, MaxLength, Description, Force, ClientToken	Modifies an existing routing policy registration. You can update the authorized ASNs, maximum prefix length, and other properties of a Route Origin Authorization (ROA).
delete_ipam_routing_policy_registration	delete	IpamInternetRegistryAssociationId, region	DryRun, Cidr, Force, ClientToken	Deletes a routing policy registration for a specified CIDR prefix.
batch_modify_ipam_routing_policy_registrations	exec	IpamInternetRegistryAssociationId, DeltaJson, region	DryRun, Force, ClientToken	Modifies multiple routing policy registrations in a single operation. You can create, update, or delete Route Origin Authorizations (ROAs) in batch.

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
DeltaJson	string	The batch modifications to apply, in JSON format.
IpamInternetRegistryAssociationId	string	The ID of the IPAM internet registry association.
region	string	AWS region (default: us-east-1)
Asn	array	The updated list of Autonomous System Numbers (ASNs) authorized to originate the prefix.
Cidr	string	The IP address prefix in CIDR notation identifying the routing policy registration to delete.
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	A new description for the routing policy registration.
DryRun	boolean	Checks whether you have the required permissions for the operation, 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.
Force	boolean	Forces the batch modification even if individual changes conflict with announced routes. Default: false.
MaxLength	integer	The new maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR.
MaxResults	integer	The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken	string	The token for the next page of results.
PermitMoreSpecificAnnouncements	boolean	Specifies whether to permit more specific route announcements than the CIDR prefix. Default: false.

SELECT examples

get_ipam_routing_policy_registrations

Retrieves routing policy registrations for an IPAM internet registry association. Each registration represents a Route Origin Authorization (ROA) that has been created or is pending publication to the RPKI. We recommend using pagination to ensure that the operation returns quickly and successfully.

SELECT
asns,
cidr,
description,
latest_delta_id,
max_length,
permit_more_specific_announcements,
state
FROM aws.ec2.ipam_routing_policy_registrations
WHERE IpamInternetRegistryAssociationId = '{{ IpamInternetRegistryAssociationId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Cidr = '{{ Cidr }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_ipam_routing_policy_registration

Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs.

INSERT INTO aws.ec2.ipam_routing_policy_registrations (
IpamInternetRegistryAssociationId,
region,
DryRun,
Cidr,
Asn,
PermitMoreSpecificAnnouncements,
MaxLength,
Description,
Force,
ClientToken
)
SELECT 
'{{ IpamInternetRegistryAssociationId }}',
'{{ region }}',
'{{ DryRun }}',
'{{ Cidr }}',
'{{ Asn }}',
'{{ PermitMoreSpecificAnnouncements }}',
'{{ MaxLength }}',
'{{ Description }}',
'{{ Force }}',
'{{ ClientToken }}'
RETURNING
delta_id,
delta_json,
state,
state_message
;

Manifest

# Description fields are for documentation purposes
- name: ipam_routing_policy_registrations
props:
  - name: IpamInternetRegistryAssociationId
    value: "{{ IpamInternetRegistryAssociationId }}"
    description: Required parameter for the ipam_routing_policy_registrations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ipam_routing_policy_registrations resource.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the operation, 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: Checks whether you have the required permissions for the operation, 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: Cidr
    value: "{{ Cidr }}"
    description: The IP address prefix in CIDR notation to authorize in the ROA.
    description: The IP address prefix in CIDR notation to authorize in the ROA.
  - name: Asn
    value: "{{ Asn }}"
    description: The Autonomous System Numbers (ASNs) authorized to originate the prefix.
    description: The Autonomous System Numbers (ASNs) authorized to originate the prefix.
  - name: PermitMoreSpecificAnnouncements
    value: {{ PermitMoreSpecificAnnouncements }}
    description: Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false.
    description: Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false.
  - name: MaxLength
    value: {{ MaxLength }}
    description: The maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR. If not specified, defaults to the prefix length of the CIDR (exact match only).
    description: The maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR. If not specified, defaults to the prefix length of the CIDR (exact match only).
  - name: Description
    value: "{{ Description }}"
    description: A description for the routing policy registration.
    description: A description for the routing policy registration.
  - name: Force
    value: {{ Force }}
    description: Forces the creation of the routing policy registration even if it conflicts with an announced route. Default: false.
    description: Forces the creation of the routing policy registration even if it conflicts with an announced route. Default: false.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: 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: 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.

UPDATE examples

modify_ipam_routing_policy_registration

Modifies an existing routing policy registration. You can update the authorized ASNs, maximum prefix length, and other properties of a Route Origin Authorization (ROA).

UPDATE aws.ec2.ipam_routing_policy_registrations
SET 
-- No updatable properties
WHERE 
IpamInternetRegistryAssociationId = '{{ IpamInternetRegistryAssociationId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND Cidr = '{{ Cidr}}'
AND Asn = '{{ Asn}}'
AND PermitMoreSpecificAnnouncements = {{ PermitMoreSpecificAnnouncements}}
AND MaxLength = '{{ MaxLength}}'
AND Description = '{{ Description}}'
AND Force = {{ Force}}
AND ClientToken = '{{ ClientToken}}'
RETURNING
delta_id,
delta_json,
state,
state_message;

DELETE examples

delete_ipam_routing_policy_registration

Deletes a routing policy registration for a specified CIDR prefix.

DELETE FROM aws.ec2.ipam_routing_policy_registrations
WHERE IpamInternetRegistryAssociationId = '{{ IpamInternetRegistryAssociationId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
AND Cidr = '{{ Cidr }}'
AND Force = '{{ Force }}'
AND ClientToken = '{{ ClientToken }}'
;

Lifecycle Methods

batch_modify_ipam_routing_policy_registrations

Modifies multiple routing policy registrations in a single operation. You can create, update, or delete Route Origin Authorizations (ROAs) in batch.

EXEC aws.ec2.ipam_routing_policy_registrations.batch_modify_ipam_routing_policy_registrations 
@IpamInternetRegistryAssociationId='{{ IpamInternetRegistryAssociationId }}' --required, 
@DeltaJson='{{ DeltaJson }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}, 
@Force={{ Force }}, 
@ClientToken='{{ ClientToken }}'
;