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	aws.route53recoverycontrol.control_panels

Fields

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.

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 control_panels in a region.

SELECT
region,
cluster_arn,
control_panel_arn,
name,
status,
default_control_panel,
routing_control_count,
tags
FROM aws.route53recoverycontrol.control_panels
WHERE region = 'us-east-1';

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 aws.route53recoverycontrol.control_panels
WHERE region = 'us-east-1' AND data__Identifier = '<ControlPanelArn>';

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 aws.route53recoverycontrol.control_panels (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.route53recoverycontrol.control_panels (
 ClusterArn,
 Name,
 Tags,
 region
)
SELECT 
 '{{ ClusterArn }}',
 '{{ 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: ClusterArn
        value: '{{ ClusterArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.route53recoverycontrol.control_panels
WHERE data__Identifier = '<ControlPanelArn>'
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