routing_controls
Creates, updates, deletes, gets or lists a routing_controls resource.
Overview
| Name | routing_controls |
| Type | Resource |
| Id | aws.route53_recovery_cluster.routing_controls |
Fields
The following fields are returned by SELECT queries:
- list_routing_controls
| Name | Datatype | Description |
|---|---|---|
control_panel_arn | string | The Amazon Resource Name (ARN) of the control panel where the routing control is located. (pattern: <code>^[A-Za-z0-9:./_-]*$</code>) |
control_panel_name | string | The name of the control panel where the routing control is located. Only ASCII characters are supported for control panel names. (pattern: <code>^\S+$</code>) |
owner | string | The Amazon Web Services account ID of the routing control owner. (pattern: <code>^\S+$</code>) |
routing_control_arn | string | The Amazon Resource Name (ARN) of the routing control. (pattern: <code>^[A-Za-z0-9:./_-]*$</code>) |
routing_control_name | string | The name of the routing control. (pattern: <code>^\S+$</code>) |
routing_control_state | string | The current state of the routing control. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow. (On, Off) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_routing_controls | select | region | List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster. A routing control is a simple on/off switch in Route 53 ARC that you can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow. Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application. You must specify Regional endpoints when you work with API cluster operations to use this API operation to list routing controls in Route 53 ARC. Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide: Viewing and updating routing control states Working with routing controls in Route 53 ARC |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_routing_controls
List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster. A routing control is a simple on/off switch in Route 53 ARC that you can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow. Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application. You must specify Regional endpoints when you work with API cluster operations to use this API operation to list routing controls in Route 53 ARC. Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide: Viewing and updating routing control states Working with routing controls in Route 53 ARC
SELECT
control_panel_arn,
control_panel_name,
owner,
routing_control_arn,
routing_control_name,
routing_control_state
FROM aws.route53_recovery_cluster.routing_controls
WHERE region = '{{ region }}' -- required
;