control_panels

Creates, updates, deletes or gets a control_panel resource or lists control_panels in a region

Overview

Name	control_panels
Type	Resource
Description	AWS Route53 Recovery Control Control Panel resource schema .
Id	awscc.route53recoverycontrol.control_panels

Fields

get (all properties)

Name	Datatype	Description
cluster_arn	string	Cluster to associate with the Control Panel
control_panel_arn	string	The Amazon Resource Name (ARN) of the cluster.
name	string	The name of the control panel. You can use any non-white space character in the name.
status	string	The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
default_control_panel	boolean	A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
routing_control_count	integer	Count of associated routing controls
▶tags	array	A collection of tags associated with a resource
region	string	AWS region.

list (identifiers only)

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

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual control_panel.

SELECT
  region,
  cluster_arn,
  control_panel_arn,
  name,
  status,
  default_control_panel,
  routing_control_count,
  tags
FROM awscc.route53recoverycontrol.control_panels
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ control_panel_arn }}';

list (identifiers only)

Lists all control_panels in a region.

SELECT
  region,
  control_panel_arn
FROM awscc.route53recoverycontrol.control_panels_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.route53recoverycontrol.control_panels (
  ClusterArn,
  Name,
  Tags,
  region
)
SELECT
  '{{ cluster_arn }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

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

UPDATE example

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

/*+ update */
UPDATE awscc.route53recoverycontrol.control_panels
SET PatchDocument = string('{{ {
    "Name": name
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ control_panel_arn }}';

DELETE example

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

Permissions

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

Create

route53-recovery-control-config:CreateControlPanel,
route53-recovery-control-config:DescribeCluster,
route53-recovery-control-config:DescribeControlPanel,
route53-recovery-control-config:ListTagsForResource,
route53-recovery-control-config:TagResource

Read

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

Update

route53-recovery-control-config:UpdateControlPanel,
route53-recovery-control-config:DescribeControlPanel,
route53-recovery-control-config:ListTagsForResource,
route53-recovery-control-config:TagResource,
route53-recovery-control-config:UntagResource

Delete

route53-recovery-control-config:DeleteControlPanel,
route53-recovery-control-config:DescribeControlPanel

List

route53-recovery-control-config:ListControlPanels