com.amazonaws.services.route53recoverycluster

Class AWSRoute53RecoveryClusterClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.route53recoverycluster.AWSRoute53RecoveryClusterClient

All Implemented Interfaces:

AWSRoute53RecoveryCluster

Direct Known Subclasses:

AWSRoute53RecoveryClusterAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSRoute53RecoveryClusterClient
extends AmazonWebServiceClient
implements AWSRoute53RecoveryCluster

Client for accessing Route53 Recovery Cluster. All service calls made using this client are blocking, and will not return until the service call completes.

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 and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.route53recoverycluster.AWSRoute53RecoveryCluster

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSRoute53RecoveryClusterClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetRoutingControlStateResult	getRoutingControlState(GetRoutingControlStateRequest request) Get the state for a routing control.
ListRoutingControlsResult	listRoutingControls(ListRoutingControlsRequest request) 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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateRoutingControlStateResult	updateRoutingControlState(UpdateRoutingControlStateRequest request) Set the state of the routing control to reroute traffic.
UpdateRoutingControlStatesResult	updateRoutingControlStates(UpdateRoutingControlStatesRequest request) Set multiple routing control states.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSRoute53RecoveryClusterClientBuilder builder()

getRoutingControlState

public GetRoutingControlStateResult getRoutingControlState(GetRoutingControlStateRequest request)

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

Specified by:

getRoutingControlState in interface AWSRoute53RecoveryCluster

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.

See Also:

AWS API Documentation

listRoutingControls

public ListRoutingControlsResult listRoutingControls(ListRoutingControlsRequest request)

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

Specified by:

listRoutingControls in interface AWSRoute53RecoveryCluster

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.

See Also:

AWS API Documentation

updateRoutingControlState

public UpdateRoutingControlStateResult updateRoutingControlState(UpdateRoutingControlStateRequest request)

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

Specified by:

updateRoutingControlState in interface AWSRoute53RecoveryCluster

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.

See Also:

AWS API Documentation

updateRoutingControlStates

public UpdateRoutingControlStatesResult updateRoutingControlStates(UpdateRoutingControlStatesRequest request)

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

Specified by:

updateRoutingControlStates in interface AWSRoute53RecoveryCluster

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSRoute53RecoveryCluster

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AWSRoute53RecoveryCluster

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSRoute53RecoveryCluster

Overrides:

shutdown in class AmazonWebServiceClient