clusters

Creates, updates, deletes or gets a cluster resource or lists clusters in a region

Overview

Name	clusters
Type	Resource
Description	AWS Route53 Recovery Control Cluster resource schema
Id	awscc.route53recoverycontrol.clusters

Fields

get (all properties)

Name	Datatype	Description
name	string	Name of a Cluster. You can use any non-white space character in the name
cluster_arn	string	The Amazon Resource Name (ARN) of the cluster.
status	string	Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
▶cluster_endpoints	array	Endpoints for the cluster.
▶tags	array	A collection of tags associated with a resource
network_type	string	Cluster supports IPv4 endpoints and Dual-stack IPv4 and IPv6 endpoints. NetworkType can be IPV4 or DUALSTACK.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
cluster_arn	string	The Amazon Resource Name (ARN) of the cluster.
region	string	AWS region.

For more information, see AWS::Route53RecoveryControl::Cluster.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual cluster.

SELECT
  region,
  name,
  cluster_arn,
  status,
  cluster_endpoints,
  tags,
  network_type
FROM awscc.route53recoverycontrol.clusters
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ cluster_arn }}';

list (identifiers only)

Lists all clusters in a region.

SELECT
  region,
  cluster_arn
FROM awscc.route53recoverycontrol.clusters_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.route53recoverycontrol.clusters (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.route53recoverycontrol.clusters (
  Name,
  Tags,
  NetworkType,
  region
)
SELECT
  '{{ name }}',
  '{{ tags }}',
  '{{ network_type }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cluster
    props:
      - name: name
        value: '{{ name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: network_type
        value: '{{ network_type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.route53recoverycontrol.clusters
SET PatchDocument = string('{{ {
    "NetworkType": network_type
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cluster_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.route53recoverycontrol.clusters
WHERE
  Identifier = '{{ cluster_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

route53-recovery-control-config:CreateCluster,
route53-recovery-control-config:DescribeCluster,
route53-recovery-control-config:ListTagsForResource,
route53-recovery-control-config:TagResource

Read

route53-recovery-control-config:DescribeCluster,
route53-recovery-control-config:ListTagsForResource

Delete

route53-recovery-control-config:DescribeCluster,
route53-recovery-control-config:DeleteCluster

Update

route53-recovery-control-config:DescribeCluster,
route53-recovery-control-config:ListTagsForResource,
route53-recovery-control-config:UpdateCluster

List

route53-recovery-control-config:ListClusters