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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.route53.cidr_collections (
  Name,
  Locations,
  region
)
SELECT
  '{{ name }}',
  '{{ locations }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.route53.cidr_collections
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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