Route53 Recovery Cluster
Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller. With Route 53 ARC, you can use…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 to ON and another one to 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 .
Endpoints 4
- POSTGet routing control state
/#X-Amz-Target=ToggleCustomerAPI.GetRoutingControlStateGet 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… - POSTList routing controls
/#X-Amz-Target=ToggleCustomerAPI.ListRoutingControlsList 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… - POSTUpdate routing control state
/#X-Amz-Target=ToggleCustomerAPI.UpdateRoutingControlStateSet the state of the routing control to reroute traffic. You can set the value to ON or OFF. When the state is ON, traffic flows to a cell. When the state is… - POSTUpdate routing control states
/#X-Amz-Target=ToggleCustomerAPI.UpdateRoutingControlStatesSet 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,…
API details
- Base URL
https://route53-recovery-cluster.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 4 operations on 4 pathsPOST 4
- Description format
- AWS Smithy model, API version
2019-12-02 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Route53 Recovery Cluster in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Route53 Recovery Cluster collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get routing control state” (POST /#X-Amz-Target=ToggleCustomerAPI.GetRoutingControlState), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Route53 Recovery Cluster?
Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller. With Route 53 ARC, you can use… It is listed under Developer tools and has 4 endpoints.
Who publishes the Route53 Recovery Cluster?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Route53 Recovery Cluster?
Requests go to https://route53-recovery-cluster.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Route53 Recovery Cluster?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Route53 Recovery Cluster have?
4 operations on 4 paths (4 POST).
Is forking the Route53 Recovery Cluster free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.