@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSRoute53RecoveryControlConfigClient extends AmazonWebServiceClient implements AWSRoute53RecoveryControlConfig
Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSRoute53RecoveryControlConfigClientBuilder builder()
public CreateClusterResult createCluster(CreateClusterRequest request)
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.
createCluster in interface AWSRoute53RecoveryControlConfigcreateClusterRequest - 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.public CreateControlPanelResult createControlPanel(CreateControlPanelRequest request)
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.
createControlPanel in interface AWSRoute53RecoveryControlConfigcreateControlPanelRequest - 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.public CreateRoutingControlResult createRoutingControl(CreateRoutingControlRequest request)
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.
createRoutingControl in interface AWSRoute53RecoveryControlConfigcreateRoutingControlRequest - 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.public CreateSafetyRuleResult createSafetyRule(CreateSafetyRuleRequest request)
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.
createSafetyRule in interface AWSRoute53RecoveryControlConfigcreateSafetyRuleRequest - 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.public DeleteClusterResult deleteCluster(DeleteClusterRequest request)
Delete a cluster.
deleteCluster in interface AWSRoute53RecoveryControlConfigdeleteClusterRequest - 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.public DeleteControlPanelResult deleteControlPanel(DeleteControlPanelRequest request)
Deletes a control panel.
deleteControlPanel in interface AWSRoute53RecoveryControlConfigdeleteControlPanelRequest - 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.public DeleteRoutingControlResult deleteRoutingControl(DeleteRoutingControlRequest request)
Deletes a routing control.
deleteRoutingControl in interface AWSRoute53RecoveryControlConfigdeleteRoutingControlRequest - 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.public DeleteSafetyRuleResult deleteSafetyRule(DeleteSafetyRuleRequest request)
Deletes a safety rule.
/>deleteSafetyRule in interface AWSRoute53RecoveryControlConfigdeleteSafetyRuleRequest - 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.public DescribeClusterResult describeCluster(DescribeClusterRequest request)
Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
describeCluster in interface AWSRoute53RecoveryControlConfigdescribeClusterRequest - 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.public DescribeControlPanelResult describeControlPanel(DescribeControlPanelRequest request)
Displays details about a control panel.
describeControlPanel in interface AWSRoute53RecoveryControlConfigdescribeControlPanelRequest - 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.public DescribeRoutingControlResult describeRoutingControl(DescribeRoutingControlRequest request)
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.
describeRoutingControl in interface AWSRoute53RecoveryControlConfigdescribeRoutingControlRequest - 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.public DescribeSafetyRuleResult describeSafetyRule(DescribeSafetyRuleRequest request)
Returns information about a safety rule.
describeSafetyRule in interface AWSRoute53RecoveryControlConfigdescribeSafetyRuleRequest - 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.public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)
Get information about the resource policy for a cluster.
getResourcePolicy in interface AWSRoute53RecoveryControlConfiggetResourcePolicyRequest - 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.public ListAssociatedRoute53HealthChecksResult listAssociatedRoute53HealthChecks(ListAssociatedRoute53HealthChecksRequest request)
Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
listAssociatedRoute53HealthChecks in interface AWSRoute53RecoveryControlConfiglistAssociatedRoute53HealthChecksRequest - 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.public ListClustersResult listClusters(ListClustersRequest request)
Returns an array of all the clusters in an account.
listClusters in interface AWSRoute53RecoveryControlConfiglistClustersRequest - 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.public ListControlPanelsResult listControlPanels(ListControlPanelsRequest request)
Returns an array of control panels in an account or in a cluster.
listControlPanels in interface AWSRoute53RecoveryControlConfiglistControlPanelsRequest - 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.public ListRoutingControlsResult listRoutingControls(ListRoutingControlsRequest request)
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.
listRoutingControls in interface AWSRoute53RecoveryControlConfiglistRoutingControlsRequest - 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.public ListSafetyRulesResult listSafetyRules(ListSafetyRulesRequest request)
List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
listSafetyRules in interface AWSRoute53RecoveryControlConfiglistSafetyRulesRequest - 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for a resource.
listTagsForResource in interface AWSRoute53RecoveryControlConfiglistTagsForResourceRequest - 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.public TagResourceResult tagResource(TagResourceRequest request)
Adds a tag to a resource.
tagResource in interface AWSRoute53RecoveryControlConfigtagResourceRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag from a resource.
untagResource in interface AWSRoute53RecoveryControlConfiguntagResourceRequest - 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.public UpdateControlPanelResult updateControlPanel(UpdateControlPanelRequest request)
Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.
updateControlPanel in interface AWSRoute53RecoveryControlConfigupdateControlPanelRequest - 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.public UpdateRoutingControlResult updateRoutingControl(UpdateRoutingControlRequest request)
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.
updateRoutingControl in interface AWSRoute53RecoveryControlConfigupdateRoutingControlRequest - 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.public UpdateSafetyRuleResult updateSafetyRule(UpdateSafetyRuleRequest request)
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.
updateSafetyRule in interface AWSRoute53RecoveryControlConfigupdateSafetyRuleRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AWSRoute53RecoveryControlConfigrequest - The originally executed requestpublic AWSRoute53RecoveryControlConfigWaiters waiters()
waiters in interface AWSRoute53RecoveryControlConfigpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSRoute53RecoveryControlConfigshutdown in class AmazonWebServiceClient