You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Route53RecoveryControlConfig

Inherits:
AWS.Service show all
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();

Version:

  • 2020-11-02

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 Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a Route53RecoveryControlConfig object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Route53RecoveryControlConfig.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Route53RecoveryControlConfig.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Route53RecoveryControlConfig.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    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.

Service Reference:

Examples:

Calling the createCluster operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
route53recoverycontrolconfig.createCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientToken — (String)

      A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • ClusterName — (String)

      The name of the cluster.

    • Tags — (map<String>)

      The tags associated with the cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        The cluster that was created.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • ClusterEndpoints — (Array<map>)

          Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

          To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Endpoint — (String)

            A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

            To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Region — (String)

            The Amazon Web Services Region for a cluster endpoint.

        • Name — (String)

          The name of the cluster.

        • Status — (String)

          Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the createControlPanel operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  ControlPanelName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
route53recoverycontrolconfig.createControlPanel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientToken — (String)

      A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) of the cluster for the control panel.

    • ControlPanelName — (String)

      The name of the control panel.

    • Tags — (map<String>)

      The tags associated with the control panel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ControlPanel — (map)

        Information about a control panel.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster that includes the control panel.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • DefaultControlPanel — (Boolean)

          A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.

        • Name — (String)

          The name of the control panel. You can use any non-white space character in the name.

        • RoutingControlCount — (Integer)

          The number of routing controls in the control panel.

        • Status — (String)

          The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the createRoutingControl operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  RoutingControlName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  ControlPanelArn: 'STRING_VALUE'
};
route53recoverycontrolconfig.createRoutingControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientToken — (String)

      A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) of the cluster that includes the routing control.

    • ControlPanelArn — (String)

      The Amazon Resource Name (ARN) of the control panel that includes the routing control.

    • RoutingControlName — (String)

      The name of the routing control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RoutingControl — (map)

        The routing control that is created.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel that includes the routing control.

        • Name — (String)

          The name of the routing control.

        • RoutingControlArn — (String)

          The Amazon Resource Name (ARN) of the routing control.

        • Status — (String)

          The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 transation 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.

Service Reference:

Examples:

Calling the createSafetyRule operation

var params = {
  AssertionRule: {
    AssertedControls: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    ControlPanelArn: 'STRING_VALUE', /* required */
    Name: 'STRING_VALUE', /* required */
    RuleConfig: { /* required */
      Inverted: true || false, /* required */
      Threshold: 'NUMBER_VALUE', /* required */
      Type: ATLEAST | AND | OR /* required */
    },
    WaitPeriodMs: 'NUMBER_VALUE' /* required */
  },
  ClientToken: 'STRING_VALUE',
  GatingRule: {
    ControlPanelArn: 'STRING_VALUE', /* required */
    GatingControls: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Name: 'STRING_VALUE', /* required */
    RuleConfig: { /* required */
      Inverted: true || false, /* required */
      Threshold: 'NUMBER_VALUE', /* required */
      Type: ATLEAST | AND | OR /* required */
    },
    TargetControls: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    WaitPeriodMs: 'NUMBER_VALUE' /* required */
  },
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
route53recoverycontrolconfig.createSafetyRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AssertionRule — (map)

      The assertion rule requested.

      • AssertedControlsrequired — (Array<String>)

        The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

      • ControlPanelArnrequired — (String)

        The Amazon Resource Name (ARN) for the control panel.

      • Namerequired — (String)

        The name of the assertion rule. You can use any non-white space character in the name.

      • RuleConfigrequired — (map)

        The criteria that you set for specific assertion controls (routing controls) that designate how many control states must be ON as the result of a transaction. For example, if you have three assertion controls, you might specify ATLEAST 2for your rule configuration. This means that at least two assertion controls must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.

        • Invertedrequired — (Boolean)

          Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

        • Thresholdrequired — (Integer)

          The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.

        • Typerequired — (String)

          A rule can be one of the following: ATLEAST, AND, or OR.

          Possible values include:
          • "ATLEAST"
          • "AND"
          • "OR"
      • WaitPeriodMsrequired — (Integer)

        An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

    • ClientToken — (String)

      A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • GatingRule — (map)

      The gating rule requested.

      • ControlPanelArnrequired — (String)

        The Amazon Resource Name (ARN) of the control panel.

      • GatingControlsrequired — (Array<String>)

        The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

      • Namerequired — (String)

        The name for the new gating rule.

      • RuleConfigrequired — (map)

        The criteria that you set for specific gating controls (routing controls) that designates how many control states must be ON to allow you to change (set or unset) the target control states.

        • Invertedrequired — (Boolean)

          Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

        • Thresholdrequired — (Integer)

          The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.

        • Typerequired — (String)

          A rule can be one of the following: ATLEAST, AND, or OR.

          Possible values include:
          • "ATLEAST"
          • "AND"
          • "OR"
      • TargetControlsrequired — (Array<String>)

        Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify AtLeast 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.

        In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.

      • WaitPeriodMsrequired — (Integer)

        An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

    • Tags — (map<String>)

      The tags associated with the safety rule.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssertionRule — (map)

        The assertion rule created.

        • AssertedControlsrequired — (Array<String>)

          The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

        • ControlPanelArnrequired — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • Namerequired — (String)

          Name of the assertion rule. You can use any non-white space character in the name.

        • RuleConfigrequired — (map)

          The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.

          • Invertedrequired — (Boolean)

            Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

          • Thresholdrequired — (Integer)

            The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.

          • Typerequired — (String)

            A rule can be one of the following: ATLEAST, AND, or OR.

            Possible values include:
            • "ATLEAST"
            • "AND"
            • "OR"
        • SafetyRuleArnrequired — (String)

          The Amazon Resource Name (ARN) of the assertion rule.

        • Statusrequired — (String)

          The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"
        • WaitPeriodMsrequired — (Integer)

          An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

      • GatingRule — (map)

        The gating rule created.

        • ControlPanelArnrequired — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • GatingControlsrequired — (Array<String>)

          An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.

        • Namerequired — (String)

          The name for the gating rule. You can use any non-white space character in the name.

        • RuleConfigrequired — (map)

          The criteria that you set for gating routing controls that designates how many of the routing control states must be ON to allow you to update target routing control states.

          • Invertedrequired — (Boolean)

            Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

          • Thresholdrequired — (Integer)

            The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.

          • Typerequired — (String)

            A rule can be one of the following: ATLEAST, AND, or OR.

            Possible values include:
            • "ATLEAST"
            • "AND"
            • "OR"
        • SafetyRuleArnrequired — (String)

          The Amazon Resource Name (ARN) of the gating rule.

        • Statusrequired — (String)

          The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"
        • TargetControlsrequired — (Array<String>)

          An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated fail over, for example.

        • WaitPeriodMsrequired — (Integer)

          An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Delete a cluster.

Service Reference:

Examples:

Calling the deleteCluster operation

var params = {
  ClusterArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.deleteCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) of the cluster that you're deleting.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes a control panel.

Service Reference:

Examples:

Calling the deleteControlPanel operation

var params = {
  ControlPanelArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.deleteControlPanel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ControlPanelArn — (String)

      The Amazon Resource Name (ARN) of the control panel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes a routing control.

Service Reference:

Examples:

Calling the deleteRoutingControl operation

var params = {
  RoutingControlArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.deleteRoutingControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoutingControlArn — (String)

      The Amazon Resource Name (ARN) of the routing control that you're deleting.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes a safety rule.

/>

Service Reference:

Examples:

Calling the deleteSafetyRule operation

var params = {
  SafetyRuleArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.deleteSafetyRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SafetyRuleArn — (String)

      The ARN of the safety rule.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the describeCluster operation

var params = {
  ClusterArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.describeCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) of the cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        The cluster for the DescribeCluster request.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • ClusterEndpoints — (Array<map>)

          Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

          To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Endpoint — (String)

            A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

            To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Region — (String)

            The Amazon Web Services Region for a cluster endpoint.

        • Name — (String)

          The name of the cluster.

        • Status — (String)

          Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

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

Displays details about a control panel.

Service Reference:

Examples:

Calling the describeControlPanel operation

var params = {
  ControlPanelArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.describeControlPanel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ControlPanelArn — (String)

      The Amazon Resource Name (ARN) of the control panel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ControlPanel — (map)

        Information about the control panel.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster that includes the control panel.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • DefaultControlPanel — (Boolean)

          A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.

        • Name — (String)

          The name of the control panel. You can use any non-white space character in the name.

        • RoutingControlCount — (Integer)

          The number of routing controls in the control panel.

        • Status — (String)

          The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

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.

Service Reference:

Examples:

Calling the describeRoutingControl operation

var params = {
  RoutingControlArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.describeRoutingControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoutingControlArn — (String)

      The Amazon Resource Name (ARN) of the routing control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RoutingControl — (map)

        Information about the routing control.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel that includes the routing control.

        • Name — (String)

          The name of the routing control.

        • RoutingControlArn — (String)

          The Amazon Resource Name (ARN) of the routing control.

        • Status — (String)

          The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

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

Returns information about a safety rule.

Service Reference:

Examples:

Calling the describeSafetyRule operation

var params = {
  SafetyRuleArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.describeSafetyRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SafetyRuleArn — (String)

      The ARN of the safety rule.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssertionRule — (map)

        The assertion rule in the response.

        • AssertedControlsrequired — (Array<String>)

          The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

        • ControlPanelArnrequired — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • Namerequired — (String)

          Name of the assertion rule. You can use any non-white space character in the name.

        • RuleConfigrequired — (map)

          The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.

          • Invertedrequired — (Boolean)

            Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

          • Thresholdrequired — (Integer)

            The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.

          • Typerequired — (String)

            A rule can be one of the following: ATLEAST, AND, or OR.

            Possible values include:
            • "ATLEAST"
            • "AND"
            • "OR"
        • SafetyRuleArnrequired — (String)

          The Amazon Resource Name (ARN) of the assertion rule.

        • Statusrequired — (String)

          The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"
        • WaitPeriodMsrequired — (Integer)

          An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

      • GatingRule — (map)

        The gating rule in the response.

        • ControlPanelArnrequired — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • GatingControlsrequired — (Array<String>)

          An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.

        • Namerequired — (String)

          The name for the gating rule. You can use any non-white space character in the name.

        • RuleConfigrequired — (map)

          The criteria that you set for gating routing controls that designates how many of the routing control states must be ON to allow you to update target routing control states.

          • Invertedrequired — (Boolean)

            Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

          • Thresholdrequired — (Integer)

            The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.

          • Typerequired — (String)

            A rule can be one of the following: ATLEAST, AND, or OR.

            Possible values include:
            • "ATLEAST"
            • "AND"
            • "OR"
        • SafetyRuleArnrequired — (String)

          The Amazon Resource Name (ARN) of the gating rule.

        • Statusrequired — (String)

          The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"
        • TargetControlsrequired — (Array<String>)

          An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated fail over, for example.

        • WaitPeriodMsrequired — (Integer)

          An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Examples:

Calling the listAssociatedRoute53HealthChecks operation

var params = {
  RoutingControlArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoverycontrolconfig.listAssociatedRoute53HealthChecks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The number of objects that you want to return with this call.

    • NextToken — (String)

      The token that identifies which batch of results you want to see.

    • RoutingControlArn — (String)

      The Amazon Resource Name (ARN) of the routing control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HealthCheckIds — (Array<String>)

        Identifiers for the health checks.

      • NextToken — (String)

        Next token for listing health checks.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns an array of all the clusters in an account.

Service Reference:

Examples:

Calling the listClusters operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoverycontrolconfig.listClusters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The number of objects that you want to return with this call.

    • NextToken — (String)

      The token that identifies which batch of results you want to see.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Clusters — (Array<map>)

        An array of the clusters in an account.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • ClusterEndpoints — (Array<map>)

          Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

          To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Endpoint — (String)

            A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

            To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Region — (String)

            The Amazon Web Services Region for a cluster endpoint.

        • Name — (String)

          The name of the cluster.

        • Status — (String)

          Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"
      • NextToken — (String)

        The token that identifies which batch of results you want to see.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the listControlPanels operation

var params = {
  ClusterArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoverycontrolconfig.listControlPanels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) of a cluster.

    • MaxResults — (Integer)

      The number of objects that you want to return with this call.

    • NextToken — (String)

      The token that identifies which batch of results you want to see.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ControlPanels — (Array<map>)

        The result of a successful ListControlPanel request.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster that includes the control panel.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • DefaultControlPanel — (Boolean)

          A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.

        • Name — (String)

          The name of the control panel. You can use any non-white space character in the name.

        • RoutingControlCount — (Integer)

          The number of routing controls in the control panel.

        • Status — (String)

          The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"
      • NextToken — (String)

        The token that identifies which batch of results you want to see.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listRoutingControls operation

var params = {
  ControlPanelArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoverycontrolconfig.listRoutingControls(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ControlPanelArn — (String)

      The Amazon Resource Name (ARN) of the control panel.

    • MaxResults — (Integer)

      The number of objects that you want to return with this call.

    • NextToken — (String)

      The token that identifies which batch of results you want to see.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The token that identifies which batch of results you want to see.

      • RoutingControls — (Array<map>)

        An array of routing controls.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel that includes the routing control.

        • Name — (String)

          The name of the routing control.

        • RoutingControlArn — (String)

          The Amazon Resource Name (ARN) of the routing control.

        • Status — (String)

          The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listSafetyRules operation

var params = {
  ControlPanelArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoverycontrolconfig.listSafetyRules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ControlPanelArn — (String)

      The Amazon Resource Name (ARN) of the control panel.

    • MaxResults — (Integer)

      The number of objects that you want to return with this call.

    • NextToken — (String)

      The token that identifies which batch of results you want to see.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The token that identifies which batch of results you want to see.

      • SafetyRules — (Array<map>)

        The list of safety rules in a control panel.

        • ASSERTION — (map)

          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 state is not accepted. For example, the criteria might be that at least one routing control state is On after the transation so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

          • AssertedControlsrequired — (Array<String>)

            The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

          • ControlPanelArnrequired — (String)

            The Amazon Resource Name (ARN) of the control panel.

          • Namerequired — (String)

            Name of the assertion rule. You can use any non-white space character in the name.

          • RuleConfigrequired — (map)

            The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.

            • Invertedrequired — (Boolean)

              Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

            • Thresholdrequired — (Integer)

              The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.

            • Typerequired — (String)

              A rule can be one of the following: ATLEAST, AND, or OR.

              Possible values include:
              • "ATLEAST"
              • "AND"
              • "OR"
          • SafetyRuleArnrequired — (String)

            The Amazon Resource Name (ARN) of the assertion rule.

          • Statusrequired — (String)

            The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

            Possible values include:
            • "PENDING"
            • "DEPLOYED"
            • "PENDING_DELETION"
          • WaitPeriodMsrequired — (Integer)

            An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

        • GATING — (map)

          A gating rule verifies that a gating routing control or set of gating rounting controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.

          For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.

          • ControlPanelArnrequired — (String)

            The Amazon Resource Name (ARN) of the control panel.

          • GatingControlsrequired — (Array<String>)

            An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.

          • Namerequired — (String)

            The name for the gating rule. You can use any non-white space character in the name.

          • RuleConfigrequired — (map)

            The criteria that you set for gating routing controls that designates how many of the routing control states must be ON to allow you to update target routing control states.

            • Invertedrequired — (Boolean)

              Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

            • Thresholdrequired — (Integer)

              The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.

            • Typerequired — (String)

              A rule can be one of the following: ATLEAST, AND, or OR.

              Possible values include:
              • "ATLEAST"
              • "AND"
              • "OR"
          • SafetyRuleArnrequired — (String)

            The Amazon Resource Name (ARN) of the gating rule.

          • Statusrequired — (String)

            The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

            Possible values include:
            • "PENDING"
            • "DEPLOYED"
            • "PENDING_DELETION"
          • TargetControlsrequired — (Array<String>)

            An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated fail over, for example.

          • WaitPeriodMsrequired — (Integer)

            An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the tags for a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) for the resource that's tagged.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>)

        The tags associated with the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Adds a tag to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
route53recoverycontrolconfig.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) for the resource that's tagged.

    • Tags — (map<String>)

      The tags associated with the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Removes a tag from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
route53recoverycontrolconfig.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) for the resource that's tagged.

    • TagKeys — (Array<String>)

      Keys for the tags to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the updateControlPanel operation

var params = {
  ControlPanelArn: 'STRING_VALUE', /* required */
  ControlPanelName: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.updateControlPanel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ControlPanelArn — (String)

      The Amazon Resource Name (ARN) of the control panel.

    • ControlPanelName — (String)

      The name of the control panel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ControlPanel — (map)

        The control panel to update.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster that includes the control panel.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • DefaultControlPanel — (Boolean)

          A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.

        • Name — (String)

          The name of the control panel. You can use any non-white space character in the name.

        • RoutingControlCount — (Integer)

          The number of routing controls in the control panel.

        • Status — (String)

          The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the updateRoutingControl operation

var params = {
  RoutingControlArn: 'STRING_VALUE', /* required */
  RoutingControlName: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.updateRoutingControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoutingControlArn — (String)

      The Amazon Resource Name (ARN) of the routing control.

    • RoutingControlName — (String)

      The name of the routing control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RoutingControl — (map)

        The routing control that was updated.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel that includes the routing control.

        • Name — (String)

          The name of the routing control.

        • RoutingControlArn — (String)

          The Amazon Resource Name (ARN) of the routing control.

        • Status — (String)

          The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the updateSafetyRule operation

var params = {
  AssertionRuleUpdate: {
    Name: 'STRING_VALUE', /* required */
    SafetyRuleArn: 'STRING_VALUE', /* required */
    WaitPeriodMs: 'NUMBER_VALUE' /* required */
  },
  GatingRuleUpdate: {
    Name: 'STRING_VALUE', /* required */
    SafetyRuleArn: 'STRING_VALUE', /* required */
    WaitPeriodMs: 'NUMBER_VALUE' /* required */
  }
};
route53recoverycontrolconfig.updateSafetyRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AssertionRuleUpdate — (map)

      The assertion rule to update.

      • Namerequired — (String)

        The name of the assertion rule. You can use any non-white space character in the name.

      • SafetyRuleArnrequired — (String)

        The Amazon Resource Name (ARN) of the assertion rule.

      • WaitPeriodMsrequired — (Integer)

        An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

    • GatingRuleUpdate — (map)

      The gating rule to update.

      • Namerequired — (String)

        The name for the gating rule. You can use any non-white space character in the name.

      • SafetyRuleArnrequired — (String)

        The Amazon Resource Name (ARN) of the gating rule.

      • WaitPeriodMsrequired — (Integer)

        An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssertionRule — (map)

        The assertion rule updated.

        • AssertedControlsrequired — (Array<String>)

          The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

        • ControlPanelArnrequired — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • Namerequired — (String)

          Name of the assertion rule. You can use any non-white space character in the name.

        • RuleConfigrequired — (map)

          The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.

          • Invertedrequired — (Boolean)

            Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

          • Thresholdrequired — (Integer)

            The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.

          • Typerequired — (String)

            A rule can be one of the following: ATLEAST, AND, or OR.

            Possible values include:
            • "ATLEAST"
            • "AND"
            • "OR"
        • SafetyRuleArnrequired — (String)

          The Amazon Resource Name (ARN) of the assertion rule.

        • Statusrequired — (String)

          The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"
        • WaitPeriodMsrequired — (Integer)

          An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

      • GatingRule — (map)

        The gating rule updated.

        • ControlPanelArnrequired — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • GatingControlsrequired — (Array<String>)

          An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.

        • Namerequired — (String)

          The name for the gating rule. You can use any non-white space character in the name.

        • RuleConfigrequired — (map)

          The criteria that you set for gating routing controls that designates how many of the routing control states must be ON to allow you to update target routing control states.

          • Invertedrequired — (Boolean)

            Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

          • Thresholdrequired — (Integer)

            The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.

          • Typerequired — (String)

            A rule can be one of the following: ATLEAST, AND, or OR.

            Possible values include:
            • "ATLEAST"
            • "AND"
            • "OR"
        • SafetyRuleArnrequired — (String)

          The Amazon Resource Name (ARN) of the gating rule.

        • Statusrequired — (String)

          The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"
        • TargetControlsrequired — (Array<String>)

          An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated fail over, for example.

        • WaitPeriodMsrequired — (Integer)

          An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Waiting for the clusterCreated state

var params = {
  ClusterArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.waitFor('clusterCreated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {})

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

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

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

Examples:

Waiting for the clusterCreated state

var params = {
  ClusterArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.waitFor('clusterCreated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) of the cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        The cluster for the DescribeCluster request.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • ClusterEndpoints — (Array<map>)

          Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

          To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Endpoint — (String)

            A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

            To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Region — (String)

            The Amazon Web Services Region for a cluster endpoint.

        • Name — (String)

          The name of the cluster.

        • Status — (String)

          Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

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

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

Examples:

Waiting for the clusterDeleted state

var params = {
  ClusterArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.waitFor('clusterDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) of the cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        The cluster for the DescribeCluster request.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • ClusterEndpoints — (Array<map>)

          Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

          To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Endpoint — (String)

            A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

            To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Region — (String)

            The Amazon Web Services Region for a cluster endpoint.

        • Name — (String)

          The name of the cluster.

        • Status — (String)

          Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

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

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

Examples:

Waiting for the controlPanelCreated state

var params = {
  ControlPanelArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.waitFor('controlPanelCreated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • ControlPanelArn — (String)

      The Amazon Resource Name (ARN) of the control panel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ControlPanel — (map)

        Information about the control panel.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster that includes the control panel.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • DefaultControlPanel — (Boolean)

          A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.

        • Name — (String)

          The name of the control panel. You can use any non-white space character in the name.

        • RoutingControlCount — (Integer)

          The number of routing controls in the control panel.

        • Status — (String)

          The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

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

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

Examples:

Waiting for the controlPanelDeleted state

var params = {
  ControlPanelArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.waitFor('controlPanelDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • ControlPanelArn — (String)

      The Amazon Resource Name (ARN) of the control panel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ControlPanel — (map)

        Information about the control panel.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster that includes the control panel.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel.

        • DefaultControlPanel — (Boolean)

          A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.

        • Name — (String)

          The name of the control panel. You can use any non-white space character in the name.

        • RoutingControlCount — (Integer)

          The number of routing controls in the control panel.

        • Status — (String)

          The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

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

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

Examples:

Waiting for the routingControlCreated state

var params = {
  RoutingControlArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.waitFor('routingControlCreated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • RoutingControlArn — (String)

      The Amazon Resource Name (ARN) of the routing control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RoutingControl — (map)

        Information about the routing control.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel that includes the routing control.

        • Name — (String)

          The name of the routing control.

        • RoutingControlArn — (String)

          The Amazon Resource Name (ARN) of the routing control.

        • Status — (String)

          The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

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

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

Examples:

Waiting for the routingControlDeleted state

var params = {
  RoutingControlArn: 'STRING_VALUE' /* required */
};
route53recoverycontrolconfig.waitFor('routingControlDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • RoutingControlArn — (String)

      The Amazon Resource Name (ARN) of the routing control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RoutingControl — (map)

        Information about the routing control.

        • ControlPanelArn — (String)

          The Amazon Resource Name (ARN) of the control panel that includes the routing control.

        • Name — (String)

          The name of the routing control.

        • RoutingControlArn — (String)

          The Amazon Resource Name (ARN) of the routing control.

        • Status — (String)

          The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

          Possible values include:
          • "PENDING"
          • "DEPLOYED"
          • "PENDING_DELETION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also: