com.amazonaws.services.route53recoverycluster

Interface AWSRoute53RecoveryCluster

All Known Subinterfaces:

AWSRoute53RecoveryClusterAsync

All Known Implementing Classes:

AbstractAWSRoute53RecoveryCluster, AbstractAWSRoute53RecoveryClusterAsync, AWSRoute53RecoveryClusterAsyncClient, AWSRoute53RecoveryClusterClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSRoute53RecoveryCluster

Interface for accessing Route53 Recovery Cluster.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSRoute53RecoveryCluster instead.

Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.

With Amazon Route 53 Application Recovery Controller, you can use routing control with extreme reliability to recover applications by rerouting traffic across Availability Zones or AWS Regions. Routing controls are simple on/off switches hosted on a highly available cluster in Application Recovery Controller. A cluster provides a set of five redundant Regional endpoints against which you can run API calls to get or update the state of routing controls. To implement failover, you set one routing control on and another one off, to reroute traffic from one Availability Zone or Amazon Web Services Region to another.

Be aware that you must specify the Regional endpoints for a cluster when you work with API cluster operations to get or update routing control states in Application Recovery Controller. In addition, you must specify the US West (Oregon) Region for Application Recovery Controller 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 Application Recovery Controller. You also must set up the structures to support routing controls: clusters and control panels.

For more information about working with routing control in Application Recovery Controller, see the following:

• To create clusters, routing controls, and control panels by using the control plane API for routing control, see the Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller.

• Learn about the components in recovery control configuration, including clusters, routing controls, and control panels. For more information, see Recovery control components in the Amazon Route 53 Application Recovery Controller Developer Guide.

• Application Recovery Controller also provides readiness checks that run continually to help make sure that your applications are scaled and ready to handle failover traffic. For more information about the related API actions, 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 Application Recovery Controller, see the Amazon Route 53 Application Recovery Controller Developer Guide.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
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 getRoutingControlStateRequest) Get the state for a routing control.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateRoutingControlStateResult	updateRoutingControlState(UpdateRoutingControlStateRequest updateRoutingControlStateRequest) Set the state of the routing control to reroute traffic.
UpdateRoutingControlStatesResult	updateRoutingControlStates(UpdateRoutingControlStatesRequest updateRoutingControlStatesRequest) Set multiple routing control states.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

getRoutingControlState

GetRoutingControlStateResult 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 the state is On, traffic flows to a cell. When it's Off, traffic does not flow.

Before you can create a routing control, you must first create a cluster to host the control in a control panel. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. Then you access one of the endpoints for the cluster to get or update the routing control state to redirect traffic.

You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Application Recovery Controller.

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 overall

Parameters:

getRoutingControlStateRequest -

Returns:

Result of the GetRoutingControlState operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient permissions to query the routing control state.

InternalServerException - There was an unexpected error during processing of the request.

ResourceNotFoundException - The request references a routing control 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

UpdateRoutingControlStateResult updateRoutingControlState(UpdateRoutingControlStateRequest updateRoutingControlStateRequest)

Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow.

With Application Recovery Controller, 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 Application Recovery Controller.

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 query the routing control state.

InternalServerException - There was an unexpected error during processing of the request.

ResourceNotFoundException - The request references a routing control 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

UpdateRoutingControlStatesResult 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 Application Recovery Controller, 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 Application Recovery Controller.

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 query the routing control state.

InternalServerException - There was an unexpected error during processing of the request.

ResourceNotFoundException - The request references a routing control 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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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