cidr_collections

Creates, updates, deletes, gets or lists a cidr_collections resource.

Overview

Name	cidr_collections
Type	Resource
Id	aws.route53.cidr_collections

Fields

The following fields are returned by SELECT queries:

list_cidr_collections

Name	Datatype	Description
arn	string	The ARN of the collection summary. Can be used to reference the collection in IAM policy or cross-account.
id	string	Unique ID for the CIDR collection.
name	string	The name of a CIDR collection.
version	integer	A sequential counter that Route 53 sets to 1 when you create a CIDR collection and increments by 1 each time you update settings for the CIDR collection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_cidr_collections	select	region	nexttoken, maxresults	Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).
create_cidr_collection	insert	region, CallerReference		Creates a CIDR collection in the current Amazon Web Services account.
delete_cidr_collection	delete	cidr_collection_id, region		Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted.

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
cidr_collection_id	string	The UUID of the collection to delete.
region	string	AWS region (default: us-east-1)
maxresults	string	The maximum number of CIDR collections to return in the response.
nexttoken	string	An opaque pagination token to indicate where the service is to begin enumerating results. If no value is provided, the listing of results starts from the beginning.

SELECT examples

list_cidr_collections

Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).

SELECT
arn,
id,
name,
version
FROM aws.route53.cidr_collections
WHERE region = '{{ region }}' -- required
AND nexttoken = '{{ nexttoken }}'
AND maxresults = '{{ maxresults }}'
;

INSERT examples

create_cidr_collection

Creates a CIDR collection in the current Amazon Web Services account.

INSERT INTO aws.route53.cidr_collections (
Name,
CallerReference,
region
)
SELECT 
'{{ Name }}',
'{{ CallerReference }}' /* required */,
'{{ region }}'
RETURNING
collection,
location
;

Manifest

# Description fields are for documentation purposes
- name: cidr_collections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cidr_collections resource.
  - name: Name
    value: "{{ Name }}"
  - name: CallerReference
    value: "{{ CallerReference }}"

DELETE examples

delete_cidr_collection

Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted.

DELETE FROM aws.route53.cidr_collections
WHERE cidr_collection_id = '{{ cidr_collection_id }}' --required
AND region = '{{ region }}' --required
;