Package software.amazon.awssdk.services.route53recoverycluster

Interface Route53RecoveryClusterAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface Route53RecoveryClusterAsyncClient extends AwsClient
Service client for accessing Route53 Recovery Cluster asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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:

  • Field Details

  • Method Details

    • getRoutingControlState

      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 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:
      A Java Future containing the result of the GetRoutingControlState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient permissions to perform this action.
      • InternalServerException There was an unexpected error during processing of the request.
      • ResourceNotFoundException The request references a routing control or control panel that was not found.
      • ValidationException There was a validation error on the request.
      • ThrottlingException The request was denied because of request throttling.
      • EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • Route53RecoveryClusterException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRoutingControlState

      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 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 via GetRoutingControlStateRequest.builder()

      Parameters:
      getRoutingControlStateRequest - A Consumer that will call methods on GetRoutingControlStateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRoutingControlState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient permissions to perform this action.
      • InternalServerException There was an unexpected error during processing of the request.
      • ResourceNotFoundException The request references a routing control or control panel that was not found.
      • ValidationException There was a validation error on the request.
      • ThrottlingException The request was denied because of request throttling.
      • EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • Route53RecoveryClusterException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingControls

      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 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:
      A Java Future containing the result of the ListRoutingControls operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient permissions to perform this action.
      • InternalServerException There was an unexpected error during processing of the request.
      • ResourceNotFoundException The request references a routing control or control panel that was not found.
      • ValidationException There was a validation error on the request.
      • ThrottlingException The request was denied because of request throttling.
      • EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • Route53RecoveryClusterException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingControls

      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 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 via ListRoutingControlsRequest.builder()

      Parameters:
      listRoutingControlsRequest - A Consumer that will call methods on ListRoutingControlsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRoutingControls operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient permissions to perform this action.
      • InternalServerException There was an unexpected error during processing of the request.
      • ResourceNotFoundException The request references a routing control or control panel that was not found.
      • ValidationException There was a validation error on the request.
      • ThrottlingException The request was denied because of request throttling.
      • EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • Route53RecoveryClusterException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingControlsPaginator

      default ListRoutingControlsPublisher listRoutingControlsPaginator(ListRoutingControlsRequest listRoutingControlsRequest)

      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.

      Parameters:
      listRoutingControlsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient permissions to perform this action.
      • InternalServerException There was an unexpected error during processing of the request.
      • ResourceNotFoundException The request references a routing control or control panel that was not found.
      • ValidationException There was a validation error on the request.
      • ThrottlingException The request was denied because of request throttling.
      • EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • Route53RecoveryClusterException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingControlsPaginator

      default ListRoutingControlsPublisher listRoutingControlsPaginator(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest)

      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()

      Parameters:
      listRoutingControlsRequest - A Consumer that will call methods on ListRoutingControlsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient permissions to perform this action.
      • InternalServerException There was an unexpected error during processing of the request.
      • ResourceNotFoundException The request references a routing control or control panel that was not found.
      • ValidationException There was a validation error on the request.
      • ThrottlingException The request was denied because of request throttling.
      • EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • Route53RecoveryClusterException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingControlState

      default CompletableFuture<UpdateRoutingControlStateResponse> updateRoutingControlState(UpdateRoutingControlStateRequest updateRoutingControlStateRequest)

      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:
      A Java Future containing the result of the UpdateRoutingControlState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient permissions to perform this action.
      • InternalServerException There was an unexpected error during processing of the request.
      • ResourceNotFoundException The request references a routing control or control panel that was not found.
      • ValidationException There was a validation error on the request.
      • ThrottlingException The request was denied because of request throttling.
      • EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
      • ConflictException There was a conflict with this request. Try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • Route53RecoveryClusterException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingControlState

      default CompletableFuture<UpdateRoutingControlStateResponse> updateRoutingControlState(Consumer<UpdateRoutingControlStateRequest.Builder> updateRoutingControlStateRequest)

      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 via UpdateRoutingControlStateRequest.builder()

      Parameters:
      updateRoutingControlStateRequest - A Consumer that will call methods on UpdateRoutingControlStateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRoutingControlState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient permissions to perform this action.
      • InternalServerException There was an unexpected error during processing of the request.
      • ResourceNotFoundException The request references a routing control or control panel that was not found.
      • ValidationException There was a validation error on the request.
      • ThrottlingException The request was denied because of request throttling.
      • EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
      • ConflictException There was a conflict with this request. Try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • Route53RecoveryClusterException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingControlStates

      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.

      Parameters:
      updateRoutingControlStatesRequest -
      Returns:
      A Java Future containing the result of the UpdateRoutingControlStates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient permissions to perform this action.
      • InternalServerException There was an unexpected error during processing of the request.
      • ResourceNotFoundException The request references a routing control or control panel that was not found.
      • ValidationException There was a validation error on the request.
      • ThrottlingException The request was denied because of request throttling.
      • EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
      • ConflictException There was a conflict with this request. Try again.
      • ServiceLimitExceededException The request can't update that many routing control states at the same time. Try again with fewer routing control states.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • Route53RecoveryClusterException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingControlStates

      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()

      Parameters:
      updateRoutingControlStatesRequest - A Consumer that will call methods on UpdateRoutingControlStatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRoutingControlStates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient permissions to perform this action.
      • InternalServerException There was an unexpected error during processing of the request.
      • ResourceNotFoundException The request references a routing control or control panel that was not found.
      • ValidationException There was a validation error on the request.
      • ThrottlingException The request was denied because of request throttling.
      • EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
      • ConflictException There was a conflict with this request. Try again.
      • ServiceLimitExceededException The request can't update that many routing control states at the same time. Try again with fewer routing control states.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • Route53RecoveryClusterException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default Route53RecoveryClusterServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static Route53RecoveryClusterAsyncClient create()
      Create a Route53RecoveryClusterAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static Route53RecoveryClusterAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a Route53RecoveryClusterAsyncClient.