Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.
With Route 53 ARC, you can use routing control with extreme reliability to recover applications by rerouting traffic across Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you can run API calls to get or update the state of routing controls. To implement failover, you set one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region to another.
Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations to get or update routing control states in Route 53 ARC. In addition, you must specify the US West (Oregon) Region for Route 53 ARC API calls. For example, use the parameter --region us-west-2 with AWS CLI commands. For more information, see Get and update routing control states using the API in the Amazon Route 53 Application Recovery Controller Developer Guide.
This API guide includes information about the API operations for how to get and update routing control states in Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control panels, and routing controls) using the recovery cluster configuration API.
For more information about working with routing control in Route 53 ARC, see the following:
Create clusters, control panels, and routing controls by using API operations. For more information, see the Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller.
Learn about the components in recovery control, including clusters, routing controls, and control panels, and how to work with Route 53 ARC in the Amazon Web Services console. For more information, see Recovery control components in the Amazon Route 53 Application Recovery Controller Developer Guide.
Route 53 ARC also provides readiness checks that continually audit resources to help make sure that your applications are scaled and ready to handle failover traffic. For more information about the related API operations, see the Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller.
For more information about creating resilient applications and preparing for recovery readiness with Route 53 ARC, see the Amazon Route 53 Application Recovery Controller Developer Guide.
Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is 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 get or update routing control states in Route 53 ARC.
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide.
Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:
', 'ListRoutingControls' => '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 On, traffic flows to a cell. When the state is 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:
', 'UpdateRoutingControlState' => 'Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When the state is Off, traffic does not flow.
With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you\'ve configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.
The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC.
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide.
', 'UpdateRoutingControlStates' => 'Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it\'s Off, traffic does not flow.
With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you\'ve configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.
The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC.
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You don\'t have sufficient permissions to perform this action.
', 'refs' => [], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'Arns$member' => NULL, 'GetRoutingControlStateRequest$RoutingControlArn' => 'The Amazon Resource Name (ARN) for the routing control that you want to get the state for.
', 'GetRoutingControlStateResponse$RoutingControlArn' => 'The Amazon Resource Name (ARN) of the response.
', 'ListRoutingControlsRequest$ControlPanelArn' => 'The Amazon Resource Name (ARN) of the control panel of the routing controls to list.
', 'RoutingControl$ControlPanelArn' => 'The Amazon Resource Name (ARN) of the control panel where the routing control is located.
', 'RoutingControl$RoutingControlArn' => 'The Amazon Resource Name (ARN) of the routing control.
', 'UpdateRoutingControlStateEntry$RoutingControlArn' => 'The Amazon Resource Name (ARN) for a routing control state entry.
', 'UpdateRoutingControlStateRequest$RoutingControlArn' => 'The Amazon Resource Name (ARN) for the routing control that you want to update the state for.
', ], ], 'Arns' => [ 'base' => NULL, 'refs' => [ 'UpdateRoutingControlStateRequest$SafetyRulesToOverride' => 'The Amazon Resource Names (ARNs) for the safety rules that you want to override when you\'re updating the state of a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.
For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
', 'UpdateRoutingControlStatesRequest$SafetyRulesToOverride' => 'The Amazon Resource Names (ARNs) for the safety rules that you want to override when you\'re updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.
For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
', ], ], 'ConflictException' => [ 'base' => 'There was a conflict with this request. Try again.
', 'refs' => [], ], 'ControlPanelName' => [ 'base' => NULL, 'refs' => [ 'RoutingControl$ControlPanelName' => 'The name of the control panel where the routing control is located.
', ], ], 'EndpointTemporarilyUnavailableException' => [ 'base' => 'The cluster endpoint isn\'t available. Try another cluster endpoint.
', 'refs' => [], ], 'GetRoutingControlStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRoutingControlStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'InternalServerException' => [ 'base' => 'There was an unexpected error during processing of the request.
', 'refs' => [], ], 'ListRoutingControlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRoutingControlsResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListRoutingControlsRequest$MaxResults' => 'The number of routing controls objects that you want to return with this call. The default value is 500.
', ], ], 'PageToken' => [ 'base' => NULL, 'refs' => [ 'ListRoutingControlsRequest$NextToken' => 'The token for the next set of results. You receive this token from a previous call.
', 'ListRoutingControlsResponse$NextToken' => 'The token for the next set of results. You receive this token from a previous call.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The request references a routing control or control panel that was not found.
', 'refs' => [], ], 'RetryAfterSeconds' => [ 'base' => 'Advice to clients on when the call can be safely retried', 'refs' => [ 'InternalServerException$retryAfterSeconds' => NULL, 'ThrottlingException$retryAfterSeconds' => NULL, ], ], 'RoutingControl' => [ 'base' => 'A routing control, which is a simple on/off switch that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.
', 'refs' => [ 'RoutingControls$member' => NULL, ], ], 'RoutingControlName' => [ 'base' => NULL, 'refs' => [ 'GetRoutingControlStateResponse$RoutingControlName' => 'The routing control name.
', 'RoutingControl$RoutingControlName' => 'The name of the routing control.
', ], ], 'RoutingControlState' => [ 'base' => NULL, 'refs' => [ 'GetRoutingControlStateResponse$RoutingControlState' => 'The state of the routing control.
', 'RoutingControl$RoutingControlState' => 'The current state of the routing control. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.
', 'UpdateRoutingControlStateEntry$RoutingControlState' => 'The routing control state in a set of routing control state entries.
', 'UpdateRoutingControlStateRequest$RoutingControlState' => 'The state of the routing control. You can set the value to be On or Off.
', ], ], 'RoutingControls' => [ 'base' => NULL, 'refs' => [ 'ListRoutingControlsResponse$RoutingControls' => 'The list of routing controls.
', ], ], 'ServiceLimitExceededException' => [ 'base' => 'The request can\'t update that many routing control states at the same time. Try again with fewer routing control states.
', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => 'Description of the ConflictException error', 'ConflictException$resourceId' => 'Identifier of the resource in use', 'ConflictException$resourceType' => 'Type of the resource in use', 'EndpointTemporarilyUnavailableException$message' => NULL, 'InternalServerException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ResourceNotFoundException$resourceId' => 'Hypothetical resource identifier that was not found', 'ResourceNotFoundException$resourceType' => 'Hypothetical resource type that was not found', 'ServiceLimitExceededException$message' => NULL, 'ServiceLimitExceededException$resourceId' => 'The resource identifier of the limit that was exceeded.
', 'ServiceLimitExceededException$resourceType' => 'The resource type of the limit that was exceeded.
', 'ServiceLimitExceededException$limitCode' => 'The code of the limit that was exceeded.
', 'ServiceLimitExceededException$serviceCode' => 'The service code of the limit that was exceeded.
', 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, 'ValidationExceptionField$name' => 'The field that had the validation exception.
', 'ValidationExceptionField$message' => 'Information about the validation exception.
', ], ], 'ThrottlingException' => [ 'base' => 'The request was denied because of request throttling.
', 'refs' => [], ], 'UpdateRoutingControlStateEntries' => [ 'base' => NULL, 'refs' => [ 'UpdateRoutingControlStatesRequest$UpdateRoutingControlStateEntries' => 'A set of routing control entries that you want to update.
', ], ], 'UpdateRoutingControlStateEntry' => [ 'base' => 'A routing control state entry.
', 'refs' => [ 'UpdateRoutingControlStateEntries$member' => NULL, ], ], 'UpdateRoutingControlStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingControlStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingControlStatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingControlStatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'There was a validation error on the request.
', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => 'There was a validation error on the request.
', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => 'The fields that caused the error, if applicable', 'refs' => [ 'ValidationException$fields' => NULL, ], ], 'ValidationExceptionReason' => [ 'base' => 'Reason the request failed validation', 'refs' => [ 'ValidationException$reason' => NULL, ], ], ],];