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 Type definition for AWS::Route53::CidrCollection.
Id	awscc.route53.cidr_collections

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	UUID of the CIDR collection.
region	string	AWS region.

For more information, see AWS::Route53::CidrCollection.

Methods

Name	Resource	Accessible by	Required Params
create_resource	cidr_collections	INSERT	Name, region
delete_resource	cidr_collections	DELETE	Identifier, region
update_resource	cidr_collections	UPDATE	Identifier, PatchDocument, region
list_resources	cidr_collections_list_only	SELECT	region
get_resource	cidr_collections	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual cidr_collection.

SELECT
  region,
  id,
  name,
  arn,
  locations
FROM awscc.route53.cidr_collections
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all cidr_collections in a region.

SELECT
  region,
  id
FROM awscc.route53.cidr_collections_list_only
WHERE
  region = 'us-east-1';

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 awscc.route53.cidr_collections (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.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:
          - location_name: '{{ location_name }}'
            cidr_list:
              - '{{ cidr_list[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.route53.cidr_collections
SET PatchDocument = string('{{ {
    "Locations": locations
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.route53.cidr_collections
WHERE
  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,
route53:ListCidrBlocks

List

route53:ListCidrCollections,
route53:ListCidrBlocks