routing_controls

Creates, updates, deletes or gets a routing_control resource or lists routing_controls in a region

Overview

Name	routing_controls
Type	Resource
Description	AWS Route53 Recovery Control Routing Control resource schema .
Id	awscc.route53recoverycontrol.routing_controls

Fields

get (all properties)

Name	Datatype	Description
routing_control_arn	string	The Amazon Resource Name (ARN) of the routing control.
control_panel_arn	string	The Amazon Resource Name (ARN) of the control panel.
name	string	The name of the routing control. You can use any non-white space character in the name.
status	string	The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
cluster_arn	string	Arn associated with Control Panel
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
routing_control_arn	string	The Amazon Resource Name (ARN) of the routing control.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual routing_control.

SELECT
  region,
  routing_control_arn,
  control_panel_arn,
  name,
  status,
  cluster_arn
FROM awscc.route53recoverycontrol.routing_controls
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ routing_control_arn }}';

list (identifiers only)

Lists all routing_controls in a region.

SELECT
  region,
  routing_control_arn
FROM awscc.route53recoverycontrol.routing_controls_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.route53recoverycontrol.routing_controls (
  ControlPanelArn,
  Name,
  ClusterArn,
  region
)
SELECT
  '{{ control_panel_arn }}',
  '{{ name }}',
  '{{ cluster_arn }}',
  '{{ region }}';

Manifest

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

UPDATE example

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

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

DELETE example

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

Permissions

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

Create

route53-recovery-control-config:CreateRoutingControl,
route53-recovery-control-config:DescribeRoutingControl,
route53-recovery-control-config:DescribeControlPanel,
route53-recovery-control-config:DescribeCluster

Read

route53-recovery-control-config:DescribeRoutingControl

Update

route53-recovery-control-config:UpdateRoutingControl,
route53-recovery-control-config:DescribeRoutingControl,
route53-recovery-control-config:DescribeControlPanel

Delete

route53-recovery-control-config:DescribeRoutingControl,
route53-recovery-control-config:DeleteRoutingControl

List

route53-recovery-control-config:ListRoutingControls