ipam_internet_registry_associations

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

Overview

Name	ipam_internet_registry_associations
Type	Resource
Id	aws.ec2.ipam_internet_registry_associations

Fields

The following fields are returned by SELECT queries:

describe_ipam_internet_registry_associations

Name	Datatype	Description
child_request_xml	string	The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
description	string	The description of the internet registry association.
ipam_id	string	The ID of the associated IPAM.
ipam_internet_registry_association_arn	string	The Amazon Resource Name (ARN) of the internet registry association.
ipam_internet_registry_association_id	string	The ID of the internet registry association.
ipam_region	string	The Amazon Web Services Region of the IPAM.
organization_handle	string	The organization handle at the internet registry.
owner_id	string	The ID of the Amazon Web Services account that owns the internet registry association.
rir	string	The Regional Internet Registry. Possible values: ripe - RIPE NCC (Europe, the Middle East, and Central Asia). apnic - APNIC (Asia Pacific). arin - ARIN (North America). lacnic - LACNIC (Latin America and the Caribbean).
state	string	The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
tags	string	The tags assigned to the internet registry association.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ipam_internet_registry_associations	select	region	DryRun, IpamInternetRegistryAssociationId, MaxResults, NextToken, Filter	Describes one or more IPAM internet registry associations. We recommend using pagination to ensure that the operation returns quickly and successfully.
create_ipam_internet_registry_association	insert	IpamId, OrganizationHandle, region	DryRun, Rir, Description, TagSpecification, ClientToken	Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature.
delete_ipam_internet_registry_association	delete	IpamInternetRegistryAssociationId, region	DryRun	Deletes an IPAM internet registry association. Before deleting, you must remove all routing policy registrations associated with the internet registry.

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
IpamId	string	The ID of the IPAM to associate with the internet registry.
IpamInternetRegistryAssociationId	string	The ID of the IPAM internet registry association to delete.
OrganizationHandle	string	The organization handle at the internet registry (for example, a RIPE NCC organization ID or ARIN Org ID).
region	string	AWS region (default: us-east-1)
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 description for the internet registry association.
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.
Filter	array	One or more filters to apply to the results.
IpamInternetRegistryAssociationId	array	The IDs of the internet registry associations to describe.
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.
Rir	string	The Regional Internet Registry to associate with. Possible values: ripe - RIPE NCC (Europe, the Middle East, and Central Asia). apnic - APNIC (Asia Pacific). arin - ARIN (North America). lacnic - LACNIC (Latin America and the Caribbean).
TagSpecification	array	The tags to assign to the internet registry association.

SELECT examples

describe_ipam_internet_registry_associations

Describes one or more IPAM internet registry associations. We recommend using pagination to ensure that the operation returns quickly and successfully.

SELECT
child_request_xml,
description,
ipam_id,
ipam_internet_registry_association_arn,
ipam_internet_registry_association_id,
ipam_region,
organization_handle,
owner_id,
rir,
state,
tags
FROM aws.ec2.ipam_internet_registry_associations
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND IpamInternetRegistryAssociationId = '{{ IpamInternetRegistryAssociationId }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Filter = '{{ Filter }}'
;

INSERT examples

create_ipam_internet_registry_association

Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature.

INSERT INTO aws.ec2.ipam_internet_registry_associations (
IpamId,
OrganizationHandle,
region,
DryRun,
Rir,
Description,
TagSpecification,
ClientToken
)
SELECT 
'{{ IpamId }}',
'{{ OrganizationHandle }}',
'{{ region }}',
'{{ DryRun }}',
'{{ Rir }}',
'{{ Description }}',
'{{ TagSpecification }}',
'{{ ClientToken }}'
RETURNING
child_request_xml,
description,
ipam_id,
ipam_internet_registry_association_arn,
ipam_internet_registry_association_id,
ipam_region,
organization_handle,
owner_id,
rir,
state,
tags
;

Manifest

# Description fields are for documentation purposes
- name: ipam_internet_registry_associations
props:
  - name: IpamId
    value: "{{ IpamId }}"
    description: Required parameter for the ipam_internet_registry_associations resource.
  - name: OrganizationHandle
    value: "{{ OrganizationHandle }}"
    description: Required parameter for the ipam_internet_registry_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ipam_internet_registry_associations 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: Rir
    value: "{{ Rir }}"
    description: The Regional Internet Registry to associate with. Possible values: ripe - RIPE NCC (Europe, the Middle East, and Central Asia). apnic - APNIC (Asia Pacific). arin - ARIN (North America). lacnic - LACNIC (Latin America and the Caribbean).
    description: The Regional Internet Registry to associate with. Possible values: ripe - RIPE NCC (Europe, the Middle East, and Central Asia). apnic - APNIC (Asia Pacific). arin - ARIN (North America). lacnic - LACNIC (Latin America and the Caribbean).
  - name: Description
    value: "{{ Description }}"
    description: A description for the internet registry association.
    description: A description for the internet registry association.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to assign to the internet registry association.
    description: The tags to assign to the internet registry association.
  - 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.

DELETE examples

delete_ipam_internet_registry_association

Deletes an IPAM internet registry association. Before deleting, you must remove all routing policy registrations associated with the internet registry.

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