AbstractAWSRoute53RecoveryControlConfig (AWS Java SDK for AWS Route53 Recovery Control Config 1.12.563 API)

java.lang.Object
- com.amazonaws.services.route53recoverycontrolconfig.AbstractAWSRoute53RecoveryControlConfig

All Implemented Interfaces:

AWSRoute53RecoveryControlConfig

Direct Known Subclasses:

AbstractAWSRoute53RecoveryControlConfigAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSRoute53RecoveryControlConfig
extends Object
implements AWSRoute53RecoveryControlConfig
```
Abstract implementation of AWSRoute53RecoveryControlConfig. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.route53recoverycontrolconfig.AWSRoute53RecoveryControlConfig
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAWSRoute53RecoveryControlConfig()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAWSRoute53RecoveryControlConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateClusterResult`	`createCluster(CreateClusterRequest request)` Create a new cluster.
`CreateControlPanelResult`	`createControlPanel(CreateControlPanelRequest request)` Creates a new control panel.
`CreateRoutingControlResult`	`createRoutingControl(CreateRoutingControlRequest request)` Creates a new routing control.
`CreateSafetyRuleResult`	`createSafetyRule(CreateSafetyRuleRequest request)` Creates a safety rule in a control panel.
`DeleteClusterResult`	`deleteCluster(DeleteClusterRequest request)` Delete a cluster.
`DeleteControlPanelResult`	`deleteControlPanel(DeleteControlPanelRequest request)` Deletes a control panel.
`DeleteRoutingControlResult`	`deleteRoutingControl(DeleteRoutingControlRequest request)` Deletes a routing control.
`DeleteSafetyRuleResult`	`deleteSafetyRule(DeleteSafetyRuleRequest request)` Deletes a safety rule.
`DescribeClusterResult`	`describeCluster(DescribeClusterRequest request)` Display the details about a cluster.
`DescribeControlPanelResult`	`describeControlPanel(DescribeControlPanelRequest request)` Displays details about a control panel.
`DescribeRoutingControlResult`	`describeRoutingControl(DescribeRoutingControlRequest request)` Displays details about a routing control.
`DescribeSafetyRuleResult`	`describeSafetyRule(DescribeSafetyRuleRequest request)` 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.
`ListAssociatedRoute53HealthChecksResult`	`listAssociatedRoute53HealthChecks(ListAssociatedRoute53HealthChecksRequest request)` Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
`ListClustersResult`	`listClusters(ListClustersRequest request)` Returns an array of all the clusters in an account.
`ListControlPanelsResult`	`listControlPanels(ListControlPanelsRequest request)` Returns an array of control panels in an account or in a cluster.
`ListRoutingControlsResult`	`listRoutingControls(ListRoutingControlsRequest request)` Returns an array of routing controls for a control panel.
`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.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags for a resource.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds a tag to a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes a tag from a resource.
`UpdateControlPanelResult`	`updateControlPanel(UpdateControlPanelRequest request)` Updates a control panel.
`UpdateRoutingControlResult`	`updateRoutingControl(UpdateRoutingControlRequest request)` Updates a routing control.
`UpdateSafetyRuleResult`	`updateSafetyRule(UpdateSafetyRuleRequest request)` Update a safety rule (an assertion rule or gating rule).
`AWSRoute53RecoveryControlConfigWaiters`	`waiters()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAWSRoute53RecoveryControlConfig
```
protected AbstractAWSRoute53RecoveryControlConfig()
```
- Method Detail
  - createCluster
```
public CreateClusterResult createCluster(CreateClusterRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    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.
    
    Specified by:
    
    createCluster in interface AWSRoute53RecoveryControlConfig
    
    Parameters:
    
    request - Creates a cluster.
    
    Returns:
    
    Result of the CreateCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createControlPanel
```
public CreateControlPanelResult createControlPanel(CreateControlPanelRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    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.
    
    Specified by:
    
    createControlPanel in interface AWSRoute53RecoveryControlConfig
    
    Parameters:
    
    request - The details of the control panel that you're creating.
    
    Returns:
    
    Result of the CreateControlPanel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createRoutingControl
```
public CreateRoutingControlResult createRoutingControl(CreateRoutingControlRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    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.
    
    Specified by:
    
    createRoutingControl in interface AWSRoute53RecoveryControlConfig
    
    Parameters:
    
    request - The details of the routing control that you're creating.
    
    Returns:
    
    Result of the CreateRoutingControl operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createSafetyRule
```
public CreateSafetyRuleResult createSafetyRule(CreateSafetyRuleRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    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.
    
    Specified by:
    
    createSafetyRule in interface AWSRoute53RecoveryControlConfig
    
    Parameters:
    
    request - The request body that you include when you create a safety rule.
    
    Returns:
    
    Result of the CreateSafetyRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCluster
```
public DeleteClusterResult deleteCluster(DeleteClusterRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Delete a cluster.
    
    Specified by:
    
    deleteCluster in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the DeleteCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteControlPanel
```
public DeleteControlPanelResult deleteControlPanel(DeleteControlPanelRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Deletes a control panel.
    
    Specified by:
    
    deleteControlPanel in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the DeleteControlPanel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRoutingControl
```
public DeleteRoutingControlResult deleteRoutingControl(DeleteRoutingControlRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Deletes a routing control.
    
    Specified by:
    
    deleteRoutingControl in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the DeleteRoutingControl operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSafetyRule
```
public DeleteSafetyRuleResult deleteSafetyRule(DeleteSafetyRuleRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Deletes a safety rule.
    />
    
    Specified by:
    
    deleteSafetyRule in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the DeleteSafetyRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCluster
```
public DescribeClusterResult describeCluster(DescribeClusterRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
    
    Specified by:
    
    describeCluster in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the DescribeCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeControlPanel
```
public DescribeControlPanelResult describeControlPanel(DescribeControlPanelRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Displays details about a control panel.
    
    Specified by:
    
    describeControlPanel in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the DescribeControlPanel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRoutingControl
```
public DescribeRoutingControlResult describeRoutingControl(DescribeRoutingControlRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    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.
    
    Specified by:
    
    describeRoutingControl in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the DescribeRoutingControl operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSafetyRule
```
public DescribeSafetyRuleResult describeSafetyRule(DescribeSafetyRuleRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Returns information about a safety rule.
    
    Specified by:
    
    describeSafetyRule in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the DescribeSafetyRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedRoute53HealthChecks
```
public ListAssociatedRoute53HealthChecksResult listAssociatedRoute53HealthChecks(ListAssociatedRoute53HealthChecksRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
    
    Specified by:
    
    listAssociatedRoute53HealthChecks in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the ListAssociatedRoute53HealthChecks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listClusters
```
public ListClustersResult listClusters(ListClustersRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Returns an array of all the clusters in an account.
    
    Specified by:
    
    listClusters in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the ListClusters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listControlPanels
```
public ListControlPanelsResult listControlPanels(ListControlPanelsRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Returns an array of control panels in an account or in a cluster.
    
    Specified by:
    
    listControlPanels in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the ListControlPanels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRoutingControls
```
public ListRoutingControlsResult listRoutingControls(ListRoutingControlsRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    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.
    
    Specified by:
    
    listRoutingControls in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the ListRoutingControls operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSafetyRules
```
public ListSafetyRulesResult listSafetyRules(ListSafetyRulesRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
    
    Specified by:
    
    listSafetyRules in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the ListSafetyRules operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Lists the tags for a resource.
    
    Specified by:
    
    listTagsForResource in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Adds a tag to a resource.
    
    Specified by:
    
    tagResource in interface AWSRoute53RecoveryControlConfig
    
    Parameters:
    
    request - Request of adding tag to the resource
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Removes a tag from a resource.
    
    Specified by:
    
    untagResource in interface AWSRoute53RecoveryControlConfig
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateControlPanel
```
public UpdateControlPanelResult updateControlPanel(UpdateControlPanelRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.
    
    Specified by:
    
    updateControlPanel in interface AWSRoute53RecoveryControlConfig
    
    Parameters:
    
    request - The details of the control panel that you're updating.
    
    Returns:
    
    Result of the UpdateControlPanel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateRoutingControl
```
public UpdateRoutingControlResult updateRoutingControl(UpdateRoutingControlRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    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.
    
    Specified by:
    
    updateRoutingControl in interface AWSRoute53RecoveryControlConfig
    
    Parameters:
    
    request - The details of the routing control that you're updating.
    
    Returns:
    
    Result of the UpdateRoutingControl operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSafetyRule
```
public UpdateSafetyRuleResult updateSafetyRule(UpdateSafetyRuleRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    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.
    
    Specified by:
    
    updateSafetyRule in interface AWSRoute53RecoveryControlConfig
    
    Parameters:
    
    request - A rule that you add to Application Recovery Controller to ensure that recovery actions don't accidentally impair your application's availability.
    
    Returns:
    
    Result of the UpdateSafetyRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    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.
    
    Specified by:
    
    shutdown in interface AWSRoute53RecoveryControlConfig
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSRoute53RecoveryControlConfig
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSRoute53RecoveryControlConfig
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AWSRoute53RecoveryControlConfigWaiters waiters()
```
    Specified by:
    
    waiters in interface AWSRoute53RecoveryControlConfig

Class AbstractAWSRoute53RecoveryControlConfig

Field Summary

Fields inherited from interface com.amazonaws.services.route53recoverycontrolconfig.AWSRoute53RecoveryControlConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAWSRoute53RecoveryControlConfig

Method Detail

createCluster

createControlPanel

createRoutingControl

createSafetyRule

deleteCluster

deleteControlPanel

deleteRoutingControl

deleteSafetyRule

describeCluster

describeControlPanel

describeRoutingControl

describeSafetyRule

listAssociatedRoute53HealthChecks

listClusters

listControlPanels

listRoutingControls

listSafetyRules

listTagsForResource

tagResource

untagResource

updateControlPanel

updateRoutingControl

updateSafetyRule

shutdown

getCachedResponseMetadata

waiters