software.amazon.awssdk.services.route53recoverycluster

Interface Route53RecoveryClusterClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

Service client for accessing Route53 Recovery Cluster. This can be created using the static builder() method.

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	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and 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.
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.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

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

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.

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

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

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

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

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

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

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

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.

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

For more information about working with routing controls, see Routing control in the 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:

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.

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

serviceMetadata

static ServiceMetadata serviceMetadata()