routing_controls

Creates, updates, deletes, gets or lists a routing_controls resource.

Overview

Name	routing_controls
Type	Resource
Id	aws.route53_recovery_control_config.routing_controls

Fields

The following fields are returned by SELECT queries:

describe_routing_control

Name	Datatype	Description
control_panel_arn	string	The Amazon Resource Name (ARN) of the control panel that includes the routing control. (pattern: <code>^[A-Za-z0-9:/_-]*$</code>)
name	string	The name of the routing control. (pattern: <code>^\S+$</code>)
owner	string	The Amazon Web Services account ID of the routing control owner. (pattern: <code>^\d{12}$</code>)
routing_control_arn	string	The Amazon Resource Name (ARN) of the routing control. (pattern: <code>^[A-Za-z0-9:/_-]*$</code>)
status	string	The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION. (PENDING, DEPLOYED, PENDING_DELETION)

list_routing_controls

Name	Datatype	Description
control_panel_arn	string	The Amazon Resource Name (ARN) of the control panel that includes the routing control. (pattern: <code>^[A-Za-z0-9:/_-]*$</code>)
name	string	The name of the routing control. (pattern: <code>^\S+$</code>)
owner	string	The Amazon Web Services account ID of the routing control owner. (pattern: <code>^\d{12}$</code>)
routing_control_arn	string	The Amazon Resource Name (ARN) of the routing control. (pattern: <code>^[A-Za-z0-9:/_-]*$</code>)
status	string	The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION. (PENDING, DEPLOYED, PENDING_DELETION)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_routing_control	select	routing_control_arn, region		Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
list_routing_controls	select	control_panel_arn, region	MaxResults, NextToken	Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.
create_routing_control	insert	region, ClusterArn, RoutingControlName		Creates a new routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
update_routing_control	update	region, RoutingControlArn, RoutingControlName		Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
delete_routing_control	delete	routing_control_arn, region		Deletes a routing control.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
control_panel_arn	string	The Amazon Resource Name (ARN) of the control panel.
region	string	AWS region (default: us-east-1)
routing_control_arn	string	The Amazon Resource Name (ARN) of the routing control that you're deleting.
MaxResults	integer	The number of objects that you want to return with this call.
NextToken	string	The token that identifies which batch of results you want to see.

SELECT examples

describe_routing_control

Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

SELECT
control_panel_arn,
name,
owner,
routing_control_arn,
status
FROM aws.route53_recovery_control_config.routing_controls
WHERE routing_control_arn = '{{ routing_control_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_routing_controls

Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

SELECT
control_panel_arn,
name,
owner,
routing_control_arn,
status
FROM aws.route53_recovery_control_config.routing_controls
WHERE control_panel_arn = '{{ control_panel_arn }}' -- required
AND region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_routing_control

Creates a new routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

INSERT INTO aws.route53_recovery_control_config.routing_controls (
ClientToken,
ClusterArn,
ControlPanelArn,
RoutingControlName,
region
)
SELECT 
'{{ ClientToken }}',
'{{ ClusterArn }}' /* required */,
'{{ ControlPanelArn }}',
'{{ RoutingControlName }}' /* required */,
'{{ region }}'
RETURNING
routing_control
;

Manifest

# Description fields are for documentation purposes
- name: routing_controls
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the routing_controls resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: ClusterArn
    value: "{{ ClusterArn }}"
  - name: ControlPanelArn
    value: "{{ ControlPanelArn }}"
  - name: RoutingControlName
    value: "{{ RoutingControlName }}"

UPDATE examples

update_routing_control

Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

UPDATE aws.route53_recovery_control_config.routing_controls
SET 
RoutingControlArn = '{{ RoutingControlArn }}',
RoutingControlName = '{{ RoutingControlName }}'
WHERE 
region = '{{ region }}' --required
AND RoutingControlArn = '{{ RoutingControlArn }}' --required
AND RoutingControlName = '{{ RoutingControlName }}' --required
RETURNING
routing_control;

DELETE examples

delete_routing_control

Deletes a routing control.

DELETE FROM aws.route53_recovery_control_config.routing_controls
WHERE routing_control_arn = '{{ routing_control_arn }}' --required
AND region = '{{ region }}' --required
;