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 = '{{ region }}' 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 = '{{ region }}';

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

All Properties

/*+ create */
INSERT INTO awscc.route53recoverycontrol.routing_controls (
  ControlPanelArn,
  Name,
  ClusterArn,
  region
)
SELECT
  '{{ control_panel_arn }}',
  '{{ name }}',
  '{{ cluster_arn }}',
  '{{ 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: 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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.route53recoverycontrol.routing_controls
WHERE
  Identifier = '{{ routing_control_arn }}' AND
  region = '{{ region }}'
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 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