AWS.Route53RecoveryControlConfig — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

route53recoverycontrolconfig

API Version:

2020-11-02

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using Route53RecoveryControlConfig

var route53recoverycontrolconfig = new AWS.Route53RecoveryControlConfig();
route53recoverycontrolconfig.createCluster(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Route53RecoveryControlConfig object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var route53recoverycontrolconfig = new AWS.Route53RecoveryControlConfig({apiVersion: '2020-11-02'});

You can also set the API version globally in AWS.config.apiVersions using the route53recoverycontrolconfig service identifier:

AWS.config.apiVersions = {
  route53recoverycontrolconfig: '2020-11-02',
  // other service API versions
};

var route53recoverycontrolconfig = new AWS.Route53RecoveryControlConfig();

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

clusterCreated, clusterDeleted, controlPanelCreated, controlPanelDeleted, routingControlCreated, routingControlDeleted

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.Route53RecoveryControlConfig(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createCluster(params = {}, callback) ⇒ AWS.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.

createControlPanel(params = {}, callback) ⇒ AWS.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.

createRoutingControl(params = {}, callback) ⇒ AWS.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.

createSafetyRule(params = {}, callback) ⇒ AWS.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.

deleteCluster(params = {}, callback) ⇒ AWS.Request

deleteControlPanel(params = {}, callback) ⇒ AWS.Request

deleteRoutingControl(params = {}, callback) ⇒ AWS.Request

Deletes a routing control.

deleteSafetyRule(params = {}, callback) ⇒ AWS.Request

Deletes a safety rule.

/>

describeCluster(params = {}, callback) ⇒ AWS.Request

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

describeControlPanel(params = {}, callback) ⇒ AWS.Request

Displays details about a control panel.

describeRoutingControl(params = {}, callback) ⇒ AWS.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.

describeSafetyRule(params = {}, callback) ⇒ AWS.Request

Returns information about a safety rule.

getResourcePolicy(params = {}, callback) ⇒ AWS.Request

Get information about the resource policy for a cluster.

listAssociatedRoute53HealthChecks(params = {}, callback) ⇒ AWS.Request

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

listClusters(params = {}, callback) ⇒ AWS.Request

Returns an array of all the clusters in an account.

listControlPanels(params = {}, callback) ⇒ AWS.Request

Returns an array of control panels in an account or in a cluster.

listRoutingControls(params = {}, callback) ⇒ AWS.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.

listSafetyRules(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for a resource.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds a tag to a resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag from a resource.

updateControlPanel(params = {}, callback) ⇒ AWS.Request

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

updateRoutingControl(params = {}, callback) ⇒ AWS.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.

updateSafetyRule(params = {}, callback) ⇒ AWS.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.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Route53RecoveryControlConfig resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Waiter Resource Details

route53recoverycontrolconfig.waitFor('clusterCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the clusterCreated state by periodically calling the underlyingRoute53RecoveryControlConfig.describeCluster() operation every 5 seconds (at most 26 times).

route53recoverycontrolconfig.waitFor('clusterDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the clusterDeleted state by periodically calling the underlyingRoute53RecoveryControlConfig.describeCluster() operation every 5 seconds (at most 26 times).

route53recoverycontrolconfig.waitFor('controlPanelCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the controlPanelCreated state by periodically calling the underlyingRoute53RecoveryControlConfig.describeControlPanel() operation every 5 seconds (at most 26 times).

route53recoverycontrolconfig.waitFor('controlPanelDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the controlPanelDeleted state by periodically calling the underlyingRoute53RecoveryControlConfig.describeControlPanel() operation every 5 seconds (at most 26 times).

route53recoverycontrolconfig.waitFor('routingControlCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the routingControlCreated state by periodically calling the underlyingRoute53RecoveryControlConfig.describeRoutingControl() operation every 5 seconds (at most 26 times).

route53recoverycontrolconfig.waitFor('routingControlDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the routingControlDeleted state by periodically calling the underlyingRoute53RecoveryControlConfig.describeRoutingControl() operation every 5 seconds (at most 26 times).