Package software.amazon.awssdk.services.route53recoverycluster

Interface Route53RecoveryClusterClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface Route53RecoveryClusterClient
extends AwsClient

Service client for accessing Route53 Recovery Cluster. This can be created using the static 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

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static Route53RecoveryClusterClientBuilder	builder()	Create a builder that can be used to configure and create a Route53RecoveryClusterClient.
static Route53RecoveryClusterClient	create()	Create a Route53RecoveryClusterClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
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)	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(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 Route53RecoveryClusterServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default UpdateRoutingControlStateResponse	updateRoutingControlState(Consumer<UpdateRoutingControlStateRequest.Builder> updateRoutingControlStateRequest)	Set the state of the routing control to reroute traffic.
default UpdateRoutingControlStateResponse	updateRoutingControlState(UpdateRoutingControlStateRequest updateRoutingControlStateRequest)	Set the state of the routing control to reroute traffic.
default UpdateRoutingControlStatesResponse	updateRoutingControlStates(Consumer<UpdateRoutingControlStatesRequest.Builder> updateRoutingControlStatesRequest)	Set multiple routing control states.
default UpdateRoutingControlStatesResponse	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 Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

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:

• Viewing and updating routing control states

• Working with routing controls in Route 53 ARC

Parameters:

getRoutingControlStateRequest -

Returns:

Result of the GetRoutingControlState operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

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:

• Viewing and updating routing control states

• Working with routing controls in Route 53 ARC

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:

Result of the GetRoutingControlState operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

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:

• Viewing and updating routing control states

• Working with routing controls in Route 53 ARC

Parameters:

listRoutingControlsRequest -

Returns:

Result of the ListRoutingControls operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

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:

• Viewing and updating routing control states

• Working with routing controls in Route 53 ARC

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:

Result of the ListRoutingControls operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listRoutingControlsPaginator

default ListRoutingControlsIterable listRoutingControlsPaginator(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:

• Viewing and updating routing control states

• Working with routing controls in Route 53 ARC

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 Stream

 
 software.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsIterable responses = client.listRoutingControlsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listRoutingControlsPaginator

default ListRoutingControlsIterable listRoutingControlsPaginator(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:

• Viewing and updating routing control states

• Working with routing controls in Route 53 ARC

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 Stream

 
 software.amazon.awssdk.services.route53recoverycluster.paginators.ListRoutingControlsIterable responses = client.listRoutingControlsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

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

Parameters:

listRoutingControlsRequest - A Consumer that will call methods on ListRoutingControlsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

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.

• Viewing and updating routing control states

• Working with routing controls overall

Parameters:

updateRoutingControlStateRequest -

Returns:

Result of the UpdateRoutingControlState operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

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.

• Viewing and updating routing control states

• Working with routing controls overall

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:

Result of the UpdateRoutingControlState operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

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.

• Viewing and updating routing control states

• Working with routing controls overall

Parameters:

updateRoutingControlStatesRequest -

Returns:

Result of the UpdateRoutingControlStates operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

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.

• Viewing and updating routing control states

• Working with routing controls overall

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:

Result of the UpdateRoutingControlStates operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

create

static Route53RecoveryClusterClient create()

Create a Route53RecoveryClusterClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static Route53RecoveryClusterClientBuilder builder()

Create a builder that can be used to configure and create a Route53RecoveryClusterClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default Route53RecoveryClusterServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient