cidr_collections

Creates, updates, deletes or gets a cidr_collection resource or lists cidr_collections in a region

Overview

Name	cidr_collections
Type	Resource
Description	Resource schema for AWS::Route53::CidrCollection.
Id	aws.route53.cidr_collections

Fields

Name	Datatype	Description
id	string	UUID of the CIDR collection.
name	string	A unique name for the CIDR collection.
arn	string	The Amazon resource name (ARN) to uniquely identify the AWS resource.
locations	array	A complex type that contains information about the list of CIDR locations.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all cidr_collections in a region.

SELECT
region,
id,
name,
arn,
locations
FROM aws.route53.cidr_collections
;

Gets all properties from an individual cidr_collection.

SELECT
region,
id,
name,
arn,
locations
FROM aws.route53.cidr_collections
WHERE data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new cidr_collection resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.route53.cidr_collections (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.route53.cidr_collections (
 Name,
 Locations,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Locations }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cidr_collection
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Locations
        value:
          - LocationName: '{{ LocationName }}'
            CidrList:
              - '{{ CidrList[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.route53.cidr_collections
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the cidr_collections resource, the following permissions are required:

Create

route53:CreateCidrCollection,
route53:ChangeCidrCollection

Read

route53:ListCidrCollections,
route53:ListCidrBlocks

Update

route53:ChangeCidrCollection

Delete

route53:DeleteCidrCollection,
route53:ChangeCidrCollection

List

route53:ListCidrCollections,
route53:ListCidrBlocks