Interface Route53RecoveryClusterClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,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 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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aRoute53RecoveryClusterClient
.static Route53RecoveryClusterClient
create()
Create aRoute53RecoveryClusterClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default GetRoutingControlStateResponse
getRoutingControlState
(Consumer<GetRoutingControlStateRequest.Builder> getRoutingControlStateRequest) Get the state for a routing control.default GetRoutingControlStateResponse
getRoutingControlState
(GetRoutingControlStateRequest getRoutingControlStateRequest) Get the state for a routing control.default 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 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 ListRoutingControlsIterable
listRoutingControlsPaginator
(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest) This is a variant oflistRoutingControls(software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsRequest)
operation.default ListRoutingControlsIterable
listRoutingControlsPaginator
(ListRoutingControlsRequest listRoutingControlsRequest) This is a variant oflistRoutingControls(software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
updateRoutingControlState
(Consumer<UpdateRoutingControlStateRequest.Builder> updateRoutingControlStateRequest) Set the state of the routing control to reroute traffic.updateRoutingControlState
(UpdateRoutingControlStateRequest updateRoutingControlStateRequest) Set the state of the routing control to reroute traffic.updateRoutingControlStates
(Consumer<UpdateRoutingControlStatesRequest.Builder> updateRoutingControlStatesRequest) Set multiple routing control states.updateRoutingControlStates
(UpdateRoutingControlStatesRequest updateRoutingControlStatesRequest) Set multiple routing control states.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
getRoutingControlState
default GetRoutingControlStateResponse getRoutingControlState(GetRoutingControlStateRequest getRoutingControlStateRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, EndpointTemporarilyUnavailableException, AwsServiceException, SdkClientException, Route53RecoveryClusterException 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 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 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:
- Parameters:
getRoutingControlStateRequest
-- Returns:
- Result of the GetRoutingControlState operation returned by the service.
- See Also:
-
getRoutingControlState
default GetRoutingControlStateResponse getRoutingControlState(Consumer<GetRoutingControlStateRequest.Builder> getRoutingControlStateRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, EndpointTemporarilyUnavailableException, AwsServiceException, SdkClientException, Route53RecoveryClusterException 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 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 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 viaGetRoutingControlStateRequest.builder()
- Parameters:
getRoutingControlStateRequest
- AConsumer
that will call methods onGetRoutingControlStateRequest.Builder
to create a request.- Returns:
- Result of the GetRoutingControlState operation returned by the service.
- See Also:
-
listRoutingControls
default ListRoutingControlsResponse listRoutingControls(ListRoutingControlsRequest listRoutingControlsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, EndpointTemporarilyUnavailableException, AwsServiceException, SdkClientException, Route53RecoveryClusterException 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:
- Parameters:
listRoutingControlsRequest
-- Returns:
- Result of the ListRoutingControls operation returned by the service.
- See Also:
-
listRoutingControls
default ListRoutingControlsResponse listRoutingControls(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, EndpointTemporarilyUnavailableException, AwsServiceException, SdkClientException, Route53RecoveryClusterException 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:
This is a convenience which creates an instance of the
ListRoutingControlsRequest.Builder
avoiding the need to create one manually viaListRoutingControlsRequest.builder()
- Parameters:
listRoutingControlsRequest
- AConsumer
that will call methods onListRoutingControlsRequest.Builder
to create a request.- Returns:
- Result of the ListRoutingControls operation returned by the service.
- See Also:
-
listRoutingControlsPaginator
default ListRoutingControlsIterable listRoutingControlsPaginator(ListRoutingControlsRequest listRoutingControlsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, EndpointTemporarilyUnavailableException, AwsServiceException, SdkClientException, Route53RecoveryClusterException This is a variant of
listRoutingControls(software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsIterable responses = client.listRoutingControlsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsIterable responses = client .listRoutingControlsPaginator(request); for (software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsIterable responses = client.listRoutingControlsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
listRoutingControlsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRoutingControlsPaginator
default ListRoutingControlsIterable listRoutingControlsPaginator(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, EndpointTemporarilyUnavailableException, AwsServiceException, SdkClientException, Route53RecoveryClusterException This is a variant of
listRoutingControls(software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsIterable responses = client.listRoutingControlsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsIterable responses = client .listRoutingControlsPaginator(request); for (software.amazon.awssdk.services.route53recoverycluster.model.ListRoutingControlsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsIterable responses = client.listRoutingControlsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListRoutingControlsRequest.builder()
- Parameters:
listRoutingControlsRequest
- AConsumer
that will call methods onListRoutingControlsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
updateRoutingControlState
default UpdateRoutingControlStateResponse updateRoutingControlState(UpdateRoutingControlStateRequest updateRoutingControlStateRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, EndpointTemporarilyUnavailableException, ConflictException, AwsServiceException, SdkClientException, Route53RecoveryClusterException Set 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 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.
- Parameters:
updateRoutingControlStateRequest
-- Returns:
- Result of the UpdateRoutingControlState operation returned by the service.
- See Also:
-
updateRoutingControlState
default UpdateRoutingControlStateResponse updateRoutingControlState(Consumer<UpdateRoutingControlStateRequest.Builder> updateRoutingControlStateRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, EndpointTemporarilyUnavailableException, ConflictException, AwsServiceException, SdkClientException, Route53RecoveryClusterException Set 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 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 viaUpdateRoutingControlStateRequest.builder()
- Parameters:
updateRoutingControlStateRequest
- AConsumer
that will call methods onUpdateRoutingControlStateRequest.Builder
to create a request.- Returns:
- Result of the UpdateRoutingControlState operation returned by the service.
- See Also:
-
updateRoutingControlStates
default UpdateRoutingControlStatesResponse updateRoutingControlStates(UpdateRoutingControlStatesRequest updateRoutingControlStatesRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, EndpointTemporarilyUnavailableException, ConflictException, ServiceLimitExceededException, AwsServiceException, SdkClientException, Route53RecoveryClusterException 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.
- Parameters:
updateRoutingControlStatesRequest
-- Returns:
- Result of the UpdateRoutingControlStates operation returned by the service.
- See Also:
-
updateRoutingControlStates
default UpdateRoutingControlStatesResponse updateRoutingControlStates(Consumer<UpdateRoutingControlStatesRequest.Builder> updateRoutingControlStatesRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, EndpointTemporarilyUnavailableException, ConflictException, ServiceLimitExceededException, AwsServiceException, SdkClientException, Route53RecoveryClusterException 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 viaUpdateRoutingControlStatesRequest.builder()
- Parameters:
updateRoutingControlStatesRequest
- AConsumer
that will call methods onUpdateRoutingControlStatesRequest.Builder
to create a request.- Returns:
- Result of the UpdateRoutingControlStates operation returned by the service.
- See Also:
-
create
Create aRoute53RecoveryClusterClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRoute53RecoveryClusterClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-