@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSRoute53RecoveryControlConfig
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
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| 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)
Returns information about a safety rule.
|
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.
|
GetResourcePolicyResult |
getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Get information about the resource policy for a cluster.
|
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 in an account or in 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.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for a resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds a tag to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a resource.
|
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).
|
AWSRoute53RecoveryControlConfigWaiters |
waiters() |
static final String ENDPOINT_PREFIX
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 cluster data plane.
createClusterRequest - Creates a cluster.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 responseAccessDeniedException - 403 response - AccessDeniedException. You do not have 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.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 Amazon Web Services Region.
createControlPanelRequest - The details of the control panel that you're creating.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 responseAccessDeniedException - 403 response - AccessDeniedException. You do not have 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.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.
createRoutingControlRequest - The details of the routing control that you're creating.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 responseAccessDeniedException - 403 response - AccessDeniedException. You do not have 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.CreateSafetyRuleResult createSafetyRule(CreateSafetyRuleRequest createSafetyRuleRequest)
Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for 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 you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.
Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.
For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.
createSafetyRuleRequest - The request body that you include when you create a safety rule.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.DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)
Delete a cluster.
deleteClusterRequest - 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 have 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.DeleteControlPanelResult deleteControlPanel(DeleteControlPanelRequest deleteControlPanelRequest)
Deletes a control panel.
deleteControlPanelRequest - 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 have 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.DeleteRoutingControlResult deleteRoutingControl(DeleteRoutingControlRequest deleteRoutingControlRequest)
Deletes a routing control.
deleteRoutingControlRequest - 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 have 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.DeleteSafetyRuleResult deleteSafetyRule(DeleteSafetyRuleRequest deleteSafetyRuleRequest)
Deletes a safety rule.
/>deleteSafetyRuleRequest - 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.DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest)
Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
describeClusterRequest - 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 have 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.DescribeControlPanelResult describeControlPanel(DescribeControlPanelRequest describeControlPanelRequest)
Displays details about a control panel.
describeControlPanelRequest - 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 have 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.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.
describeRoutingControlRequest - 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 have 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.DescribeSafetyRuleResult describeSafetyRule(DescribeSafetyRuleRequest describeSafetyRuleRequest)
Returns information about a safety rule.
describeSafetyRuleRequest - 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.GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Get information about the resource policy for a cluster.
getResourcePolicyRequest - ResourceNotFoundException - 404 response - MalformedQueryString. The query string contains a syntax error or resource not found.InternalServerException - 500 response - InternalServiceError. Temporary service error. Retry the request.ListAssociatedRoute53HealthChecksResult listAssociatedRoute53HealthChecks(ListAssociatedRoute53HealthChecksRequest listAssociatedRoute53HealthChecksRequest)
Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
listAssociatedRoute53HealthChecksRequest - 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.ListClustersResult listClusters(ListClustersRequest listClustersRequest)
Returns an array of all the clusters in an account.
listClustersRequest - 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 have sufficient access to perform this action.ListControlPanelsResult listControlPanels(ListControlPanelsRequest listControlPanelsRequest)
Returns an array of control panels in an account or in a cluster.
listControlPanelsRequest - 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 have sufficient access to perform this action.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.
listRoutingControlsRequest - 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 have sufficient access to perform this action.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.
listSafetyRulesRequest - 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 have sufficient access to perform this action.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for a resource.
listTagsForResourceRequest - 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds a tag to a resource.
tagResourceRequest - Request of adding tag to the resourceResourceNotFoundException - 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a resource.
untagResourceRequest - 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.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.
updateControlPanelRequest - The details of the control panel that you're updating.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 have 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.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.
updateRoutingControlRequest - The details of the routing control that you're updating.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 have 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.UpdateSafetyRuleResult updateSafetyRule(UpdateSafetyRuleRequest updateSafetyRuleRequest)
Update a safety rule (an assertion rule or gating rule). 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 one.
updateSafetyRuleRequest - A rule that you add to Application Recovery Controller to ensure that recovery actions don't accidentally
impair your application's availability.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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.AWSRoute53RecoveryControlConfigWaiters waiters()