@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface Route53RecoveryClusterAsyncClient extends SdkClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static Route53RecoveryClusterAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
Route53RecoveryClusterAsyncClient. |
static Route53RecoveryClusterAsyncClient |
create()
Create a
Route53RecoveryClusterAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<GetRoutingControlStateResponse> |
getRoutingControlState(Consumer<GetRoutingControlStateRequest.Builder> getRoutingControlStateRequest)
Get the state for a routing control.
|
default CompletableFuture<GetRoutingControlStateResponse> |
getRoutingControlState(GetRoutingControlStateRequest getRoutingControlStateRequest)
Get the state for a routing control.
|
default CompletableFuture<ListRoutingControlsResponse> |
listRoutingControls(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest)
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.
|
default CompletableFuture<ListRoutingControlsResponse> |
listRoutingControls(ListRoutingControlsRequest listRoutingControlsRequest)
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.
|
default ListRoutingControlsPublisher |
listRoutingControlsPaginator(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest)
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.
|
default ListRoutingControlsPublisher |
listRoutingControlsPaginator(ListRoutingControlsRequest listRoutingControlsRequest)
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.
|
default CompletableFuture<UpdateRoutingControlStateResponse> |
updateRoutingControlState(Consumer<UpdateRoutingControlStateRequest.Builder> updateRoutingControlStateRequest)
Set the state of the routing control to reroute traffic.
|
default CompletableFuture<UpdateRoutingControlStateResponse> |
updateRoutingControlState(UpdateRoutingControlStateRequest updateRoutingControlStateRequest)
Set the state of the routing control to reroute traffic.
|
default CompletableFuture<UpdateRoutingControlStatesResponse> |
updateRoutingControlStates(Consumer<UpdateRoutingControlStatesRequest.Builder> updateRoutingControlStatesRequest)
Set multiple routing control states.
|
default CompletableFuture<UpdateRoutingControlStatesResponse> |
updateRoutingControlStates(UpdateRoutingControlStatesRequest updateRoutingControlStatesRequest)
Set multiple routing control states.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static Route53RecoveryClusterAsyncClient create()
Route53RecoveryClusterAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static Route53RecoveryClusterAsyncClientBuilder builder()
Route53RecoveryClusterAsyncClient.default CompletableFuture<GetRoutingControlStateResponse> getRoutingControlState(GetRoutingControlStateRequest getRoutingControlStateRequest)
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:
getRoutingControlStateRequest - default CompletableFuture<GetRoutingControlStateResponse> getRoutingControlState(Consumer<GetRoutingControlStateRequest.Builder> getRoutingControlStateRequest)
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:
This is a convenience which creates an instance of the GetRoutingControlStateRequest.Builder avoiding the
need to create one manually via GetRoutingControlStateRequest.builder()
getRoutingControlStateRequest - A Consumer that will call methods on GetRoutingControlStateRequest.Builder to create a
request.default CompletableFuture<ListRoutingControlsResponse> listRoutingControls(ListRoutingControlsRequest listRoutingControlsRequest)
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:
listRoutingControlsRequest - default CompletableFuture<ListRoutingControlsResponse> listRoutingControls(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest)
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:
This is a convenience which creates an instance of the ListRoutingControlsRequest.Builder avoiding the
need to create one manually via ListRoutingControlsRequest.builder()
listRoutingControlsRequest - A Consumer that will call methods on ListRoutingControlsRequest.Builder to create a
request.default ListRoutingControlsPublisher listRoutingControlsPaginator(ListRoutingControlsRequest listRoutingControlsRequest)
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:
This is a variant of
listRoutingControls(software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsPublisher publisher = client.listRoutingControlsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsPublisher publisher = client.listRoutingControlsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoutingControls(software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsRequest)
operation.
listRoutingControlsRequest - default ListRoutingControlsPublisher listRoutingControlsPaginator(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest)
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:
This is a variant of
listRoutingControls(software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsPublisher publisher = client.listRoutingControlsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsPublisher publisher = client.listRoutingControlsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoutingControls(software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsRequest)
operation.
This is a convenience which creates an instance of the ListRoutingControlsRequest.Builder avoiding the
need to create one manually via ListRoutingControlsRequest.builder()
listRoutingControlsRequest - A Consumer that will call methods on ListRoutingControlsRequest.Builder to create a
request.default CompletableFuture<UpdateRoutingControlStateResponse> updateRoutingControlState(UpdateRoutingControlStateRequest updateRoutingControlStateRequest)
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.
updateRoutingControlStateRequest - default CompletableFuture<UpdateRoutingControlStateResponse> updateRoutingControlState(Consumer<UpdateRoutingControlStateRequest.Builder> updateRoutingControlStateRequest)
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.
This is a convenience which creates an instance of the UpdateRoutingControlStateRequest.Builder avoiding
the need to create one manually via UpdateRoutingControlStateRequest.builder()
updateRoutingControlStateRequest - A Consumer that will call methods on UpdateRoutingControlStateRequest.Builder to create a
request.default CompletableFuture<UpdateRoutingControlStatesResponse> updateRoutingControlStates(UpdateRoutingControlStatesRequest updateRoutingControlStatesRequest)
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.
updateRoutingControlStatesRequest - default CompletableFuture<UpdateRoutingControlStatesResponse> updateRoutingControlStates(Consumer<UpdateRoutingControlStatesRequest.Builder> updateRoutingControlStatesRequest)
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.
This is a convenience which creates an instance of the UpdateRoutingControlStatesRequest.Builder avoiding
the need to create one manually via UpdateRoutingControlStatesRequest.builder()
updateRoutingControlStatesRequest - A Consumer that will call methods on UpdateRoutingControlStatesRequest.Builder to create a
request.Copyright © 2022. All rights reserved.