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 Amazon Route 53 Application Recovery Controller API Reference Guide for Recovery Control Data Plane .

Recovery control in Route 53 Application Recovery Controller includes extremely reliable routing controls that enable you to recover applications by rerouting traffic, for example, across Availability Zones or AWS Regions. Routing controls are simple on/off switches hosted on a cluster. A cluster is a set of five redundant regional endpoints against which you can execute API calls to update or get the state of routing controls. You use routing controls to failover traffic to recover your application across Availability Zones or Regions.

This API guide includes information about how to get and update routing control states in Route 53 Application Recovery Controller.

For more information about Route 53 Application Recovery Controller, see the following:

• You can create clusters, routing controls, and control panels by using the control plane API for Recovery Control. For more information, see Amazon Route 53 Application Recovery Controller Recovery Control API Reference.

• Route 53 Application Recovery Controller also provides continuous readiness checks to ensure that your applications are scaled to handle failover traffic. For more information about the related API actions, see Amazon Route 53 Application Recovery Controller Recovery Readiness API Reference.

• For more information about creating resilient applications and preparing for recovery readiness with Route 53 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 first must create a cluster to host the control. For more information, see CreateCluster. Access one of the endpoints for the cluster to get or update the routing control state to redirect traffic.

For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.

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.

For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.

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.

For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.

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.