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 

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceClient

    LOGGING_AWS_REQUEST_METRIC

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

    ENDPOINT_PREFIX

• Method Summary

  All Methods

  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, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

  • Methods inherited from class java.lang.Object

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

• 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 class: AmazonWebServiceClient
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. 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