com.amazonaws.services.route53recoverycontrolconfig

Interface AWSRoute53RecoveryControlConfig

All Known Subinterfaces:

AWSRoute53RecoveryControlConfigAsync

All Known Implementing Classes:

AbstractAWSRoute53RecoveryControlConfig, AbstractAWSRoute53RecoveryControlConfigAsync, AWSRoute53RecoveryControlConfigAsyncClient, AWSRoute53RecoveryControlConfigClient

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

Interface for accessing AWS Route53 Recovery Control Config.

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

Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller

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
CreateClusterResult	createCluster(CreateClusterRequest createClusterRequest) Create a new cluster.
CreateControlPanelResult	createControlPanel(CreateControlPanelRequest createControlPanelRequest) Creates a new control panel.
CreateRoutingControlResult	createRoutingControl(CreateRoutingControlRequest createRoutingControlRequest) Creates a new routing control.
CreateSafetyRuleResult	createSafetyRule(CreateSafetyRuleRequest createSafetyRuleRequest) Creates a safety rule in a control panel.
DeleteClusterResult	deleteCluster(DeleteClusterRequest deleteClusterRequest) Delete a cluster.
DeleteControlPanelResult	deleteControlPanel(DeleteControlPanelRequest deleteControlPanelRequest) Deletes a control panel.
DeleteRoutingControlResult	deleteRoutingControl(DeleteRoutingControlRequest deleteRoutingControlRequest) Deletes a routing control.
DeleteSafetyRuleResult	deleteSafetyRule(DeleteSafetyRuleRequest deleteSafetyRuleRequest) Deletes a safety rule.
DescribeClusterResult	describeCluster(DescribeClusterRequest describeClusterRequest) Display the details about a cluster.
DescribeControlPanelResult	describeControlPanel(DescribeControlPanelRequest describeControlPanelRequest) Displays details about a control panel.
DescribeRoutingControlResult	describeRoutingControl(DescribeRoutingControlRequest describeRoutingControlRequest) Displays details about a routing control.
DescribeSafetyRuleResult	describeSafetyRule(DescribeSafetyRuleRequest describeSafetyRuleRequest) Describes the safety rules (that is, the assertion rules and gating rules) for the routing controls in a control panel.
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.
ListAssociatedRoute53HealthChecksResult	listAssociatedRoute53HealthChecks(ListAssociatedRoute53HealthChecksRequest listAssociatedRoute53HealthChecksRequest) Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
ListClustersResult	listClusters(ListClustersRequest listClustersRequest) Returns an array of all the clusters in an account.
ListControlPanelsResult	listControlPanels(ListControlPanelsRequest listControlPanelsRequest) Returns an array of control panels for a cluster.
ListRoutingControlsResult	listRoutingControls(ListRoutingControlsRequest listRoutingControlsRequest) Returns an array of routing controls for a control panel.
ListSafetyRulesResult	listSafetyRules(ListSafetyRulesRequest listSafetyRulesRequest) List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateControlPanelResult	updateControlPanel(UpdateControlPanelRequest updateControlPanelRequest) Updates a control panel.
UpdateRoutingControlResult	updateRoutingControl(UpdateRoutingControlRequest updateRoutingControlRequest) Updates a routing control.
UpdateSafetyRuleResult	updateSafetyRule(UpdateSafetyRuleRequest updateSafetyRuleRequest) Update a safety rule (an assertion rule or gating rule) for the routing controls in a control panel.
AWSRoute53RecoveryControlConfigWaiters	waiters()

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

createCluster

CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)

Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the Amazon Route 53 Application Recovery Controller cluster data plane.

Parameters:

createClusterRequest - Creates a cluster.

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

ServiceQuotaExceededException - 402 response

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

createControlPanel

CreateControlPanelResult createControlPanel(CreateControlPanelRequest createControlPanelRequest)

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or AWS Region.

Parameters:

createControlPanelRequest - The details of the control panel that you're creating.

Returns:

Result of the CreateControlPanel operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

ServiceQuotaExceededException - 402 response

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

createRoutingControl

CreateRoutingControlResult createRoutingControl(CreateRoutingControlRequest createRoutingControlRequest)

Creates a new routing control.

A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Parameters:

createRoutingControlRequest - The details of the routing control that you're creating.

Returns:

Result of the CreateRoutingControl operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

ServiceQuotaExceededException - 402 response

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

createSafetyRule

CreateSafetyRuleResult createSafetyRule(CreateSafetyRuleRequest createSafetyRuleRequest)

Creates a safety rule in a control panel. Safety rules let you add safeguards around enabling and disabling routing controls, to help prevent unexpected outcomes.

There are two types of safety rules: assertion rules and gating rules.

Assertion rule: An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.

Gating rule: A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.

Parameters:

createSafetyRuleRequest - The request body that you include when you create a safety rule.

Returns:

Result of the CreateSafetyRule operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

See Also:

AWS API Documentation

deleteCluster

DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)

Delete a cluster.

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

deleteControlPanel

DeleteControlPanelResult deleteControlPanel(DeleteControlPanelRequest deleteControlPanelRequest)

Deletes a control panel.

Parameters:

deleteControlPanelRequest -

Returns:

Result of the DeleteControlPanel operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

deleteRoutingControl

DeleteRoutingControlResult deleteRoutingControl(DeleteRoutingControlRequest deleteRoutingControlRequest)

Deletes a routing control.

Parameters:

deleteRoutingControlRequest -

Returns:

Result of the DeleteRoutingControl operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

deleteSafetyRule

DeleteSafetyRuleResult deleteSafetyRule(DeleteSafetyRuleRequest deleteSafetyRuleRequest)

Deletes a safety rule.

/>

Parameters:

deleteSafetyRuleRequest -

Returns:

Result of the DeleteSafetyRule operation returned by the service.

Throws:

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

See Also:

AWS API Documentation

describeCluster

DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest)

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

Parameters:

describeClusterRequest -

Returns:

Result of the DescribeCluster operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

describeControlPanel

DescribeControlPanelResult describeControlPanel(DescribeControlPanelRequest describeControlPanelRequest)

Displays details about a control panel.

Parameters:

describeControlPanelRequest -

Returns:

Result of the DescribeControlPanel operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

describeRoutingControl

DescribeRoutingControlResult describeRoutingControl(DescribeRoutingControlRequest describeRoutingControlRequest)

Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Parameters:

describeRoutingControlRequest -

Returns:

Result of the DescribeRoutingControl operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

describeSafetyRule

DescribeSafetyRuleResult describeSafetyRule(DescribeSafetyRuleRequest describeSafetyRuleRequest)

Describes the safety rules (that is, the assertion rules and gating rules) for the routing controls in a control panel.

Parameters:

describeSafetyRuleRequest -

Returns:

Result of the DescribeSafetyRule operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

See Also:

AWS API Documentation

listAssociatedRoute53HealthChecks

ListAssociatedRoute53HealthChecksResult listAssociatedRoute53HealthChecks(ListAssociatedRoute53HealthChecksRequest listAssociatedRoute53HealthChecksRequest)

Returns an array of all Amazon Route 53 health checks associated with a specific routing control.

Parameters:

listAssociatedRoute53HealthChecksRequest -

Returns:

Result of the ListAssociatedRoute53HealthChecks operation returned by the service.

Throws:

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

See Also:

AWS API Documentation

listClusters

ListClustersResult listClusters(ListClustersRequest listClustersRequest)

Returns an array of all the clusters in an account.

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

Throws:

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

See Also:

AWS API Documentation

listControlPanels

ListControlPanelsResult listControlPanels(ListControlPanelsRequest listControlPanelsRequest)

Returns an array of control panels for a cluster.

Parameters:

listControlPanelsRequest -

Returns:

Result of the ListControlPanels operation returned by the service.

Throws:

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

See Also:

AWS API Documentation

listRoutingControls

ListRoutingControlsResult listRoutingControls(ListRoutingControlsRequest listRoutingControlsRequest)

Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

Parameters:

listRoutingControlsRequest -

Returns:

Result of the ListRoutingControls operation returned by the service.

Throws:

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

See Also:

AWS API Documentation

listSafetyRules

ListSafetyRulesResult listSafetyRules(ListSafetyRulesRequest listSafetyRulesRequest)

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

Parameters:

listSafetyRulesRequest -

Returns:

Result of the ListSafetyRules operation returned by the service.

Throws:

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

See Also:

AWS API Documentation

updateControlPanel

UpdateControlPanelResult updateControlPanel(UpdateControlPanelRequest updateControlPanelRequest)

Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.

Parameters:

updateControlPanelRequest - The details of the control panel that you're updating.

Returns:

Result of the UpdateControlPanel operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

updateRoutingControl

UpdateRoutingControlResult updateRoutingControl(UpdateRoutingControlRequest updateRoutingControlRequest)

Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Parameters:

updateRoutingControlRequest - The details of the routing control that you're updating.

Returns:

Result of the UpdateRoutingControl operation returned by the service.

Throws:

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException - 403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException - 429 response - LimitExceededException or TooManyRequestsException.

ConflictException - 409 response - ConflictException. You might be using a predefined variable.

See Also:

AWS API Documentation

updateSafetyRule

UpdateSafetyRuleResult updateSafetyRule(UpdateSafetyRuleRequest updateSafetyRuleRequest)

Update a safety rule (an assertion rule or gating rule) for the routing controls in a control panel. You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new safety rule.

Parameters:

updateSafetyRuleRequest -

Returns:

Result of the UpdateSafetyRule operation returned by the service.

Throws:

ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ValidationException - 400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.

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.

waiters

AWSRoute53RecoveryControlConfigWaiters waiters()