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

Inherits:
AWS.Service show all
Identifier:
route53recoveryreadiness
API Version:
2019-12-02
Defined in:
(unknown)

Overview

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

Service Description

AWS Route53 Recovery Readiness

Sending a Request Using Route53RecoveryReadiness

var route53recoveryreadiness = new AWS.Route53RecoveryReadiness();
route53recoveryreadiness.createCell(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 Route53RecoveryReadiness object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var route53recoveryreadiness = new AWS.Route53RecoveryReadiness({apiVersion: '2019-12-02'});

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

AWS.config.apiVersions = {
  route53recoveryreadiness: '2019-12-02',
  // other service API versions
};

var route53recoveryreadiness = new AWS.Route53RecoveryReadiness();

Version:

  • 2019-12-02

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a Route53RecoveryReadiness object

var route53recoveryreadiness = new AWS.Route53RecoveryReadiness({apiVersion: '2019-12-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.Route53RecoveryReadiness.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Route53RecoveryReadiness.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'.

Property Details

endpoint ⇒ AWS.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

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

Creates a new Cell.

Service Reference:

Examples:

Calling the createCell operation

var params = {
  CellName: 'STRING_VALUE', /* required */
  Cells: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
route53recoveryreadiness.createCell(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: {}) —
    • CellName — (String) The name of the Cell to create
    • Cells — (Array<String>) A list of Cell arns contained within this Cell (for use in nested Cells, e.g. regions within which AZs)
    • Tags — (map<String>) A collection of tags associated with a 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. The data object has the following properties:

      • CellArn — (String) The arn for the Cell
      • CellName — (String) The name of the Cell
      • Cells — (Array<String>) A list of Cell arns
      • ParentReadinessScopes — (Array<String>) A list of Cell ARNs and/or RecoveryGroup ARNs
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Create a new cross account readiness authorization.

Service Reference:

Examples:

Calling the createCrossAccountAuthorization operation

var params = {
  CrossAccountAuthorization: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.createCrossAccountAuthorization(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: {}) —
    • CrossAccountAuthorization — (String) The cross account authorization

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:

      • CrossAccountAuthorization — (String) The cross account authorization

Returns:

  • (AWS.Request) —

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

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

Creates a new Readiness Check.

Service Reference:

Examples:

Calling the createReadinessCheck operation

var params = {
  ReadinessCheckName: 'STRING_VALUE', /* required */
  ResourceSetName: 'STRING_VALUE', /* required */
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
route53recoveryreadiness.createReadinessCheck(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: {}) —
    • ReadinessCheckName — (String) The name of the ReadinessCheck to create
    • ResourceSetName — (String) The name of the ResourceSet to check
    • Tags — (map<String>) A collection of tags associated with a 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. The data object has the following properties:

      • ReadinessCheckArn — (String) Arn associated with ReadinessCheck
      • ReadinessCheckName — (String) Name for a ReadinessCheck
      • ResourceSet — (String) Name of the ResourceSet to be checked
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Creates a new Recovery Group.

Service Reference:

Examples:

Calling the createRecoveryGroup operation

var params = {
  RecoveryGroupName: 'STRING_VALUE', /* required */
  Cells: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
route53recoveryreadiness.createRecoveryGroup(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: {}) —
    • Cells — (Array<String>) A list of Cell arns
    • RecoveryGroupName — (String) The name of the RecoveryGroup to create
    • Tags — (map<String>) A collection of tags associated with a 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. The data object has the following properties:

      • Cells — (Array<String>) A list of Cell arns
      • RecoveryGroupArn — (String) The arn for the RecoveryGroup
      • RecoveryGroupName — (String) The name of the RecoveryGroup
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Creates a new Resource Set.

Service Reference:

Examples:

Calling the createResourceSet operation

var params = {
  ResourceSetName: 'STRING_VALUE', /* required */
  ResourceSetType: 'STRING_VALUE', /* required */
  Resources: [ /* required */
    {
      ComponentId: 'STRING_VALUE',
      DnsTargetResource: {
        DomainName: 'STRING_VALUE',
        HostedZoneArn: 'STRING_VALUE',
        RecordSetId: 'STRING_VALUE',
        RecordType: 'STRING_VALUE',
        TargetResource: {
          NLBResource: {
            Arn: 'STRING_VALUE'
          },
          R53Resource: {
            DomainName: 'STRING_VALUE',
            RecordSetId: 'STRING_VALUE'
          }
        }
      },
      ReadinessScopes: [
        'STRING_VALUE',
        /* more items */
      ],
      ResourceArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
route53recoveryreadiness.createResourceSet(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: {}) —
    • ResourceSetName — (String) The name of the ResourceSet to create
    • ResourceSetType — (String) AWS Resource type of the resources in the ResourceSet
    • Resources — (Array<map>) A list of Resource objects
      • ComponentId — (String) The component id of the resource, generated by the service when dnsTargetResource is used
      • DnsTargetResource — (map) A component for DNS/Routing Control Readiness Checks
        • DomainName — (String) The DNS Name that acts as ingress point to a portion of application
        • HostedZoneArn — (String) The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
        • RecordSetId — (String) The R53 Set Id to uniquely identify a record given a Name and a Type
        • RecordType — (String) The Type of DNS Record of target resource
        • TargetResource — (map) The target resource the R53 record points to
          • NLBResource — (map) The NLB resource a DNS Target Resource points to
            • Arn — (String) An NLB resource arn
          • R53Resource — (map) The Route 53 resource a DNS Target Resource record points to
            • DomainName — (String) The DNS target name
            • RecordSetId — (String) The Resource Record set id
      • ReadinessScopes — (Array<String>) A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
      • ResourceArn — (String) The ARN of the AWS resource, can be skipped if dnsTargetResource is used
    • Tags — (map<String>) A collection of tags associated with a 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. The data object has the following properties:

      • ResourceSetArn — (String) The arn for the ResourceSet
      • ResourceSetName — (String) The name of the ResourceSet
      • ResourceSetType — (String) AWS Resource Type of the resources in the ResourceSet
      • Resources — (Array<map>) A list of Resource objects
        • ComponentId — (String) The component id of the resource, generated by the service when dnsTargetResource is used
        • DnsTargetResource — (map) A component for DNS/Routing Control Readiness Checks
          • DomainName — (String) The DNS Name that acts as ingress point to a portion of application
          • HostedZoneArn — (String) The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
          • RecordSetId — (String) The R53 Set Id to uniquely identify a record given a Name and a Type
          • RecordType — (String) The Type of DNS Record of target resource
          • TargetResource — (map) The target resource the R53 record points to
            • NLBResource — (map) The NLB resource a DNS Target Resource points to
              • Arn — (String) An NLB resource arn
            • R53Resource — (map) The Route 53 resource a DNS Target Resource record points to
              • DomainName — (String) The DNS target name
              • RecordSetId — (String) The Resource Record set id
        • ReadinessScopes — (Array<String>) A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
        • ResourceArn — (String) The ARN of the AWS resource, can be skipped if dnsTargetResource is used
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Deletes an existing Cell.

Service Reference:

Examples:

Calling the deleteCell operation

var params = {
  CellName: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.deleteCell(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: {}) —
    • CellName — (String) The Cell to delete

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.

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

Delete cross account readiness authorization

Service Reference:

Examples:

Calling the deleteCrossAccountAuthorization operation

var params = {
  CrossAccountAuthorization: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.deleteCrossAccountAuthorization(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: {}) —
    • CrossAccountAuthorization — (String) The cross account authorization

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.

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

Deletes an existing Readiness Check.

Service Reference:

Examples:

Calling the deleteReadinessCheck operation

var params = {
  ReadinessCheckName: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.deleteReadinessCheck(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: {}) —
    • ReadinessCheckName — (String) The ReadinessCheck to delete

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.

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

Deletes an existing Recovery Group.

Service Reference:

Examples:

Calling the deleteRecoveryGroup operation

var params = {
  RecoveryGroupName: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.deleteRecoveryGroup(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: {}) —
    • RecoveryGroupName — (String) The RecoveryGroup to delete

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.

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

Deletes an existing Resource Set.

Service Reference:

Examples:

Calling the deleteResourceSet operation

var params = {
  ResourceSetName: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.deleteResourceSet(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: {}) —
    • ResourceSetName — (String) The ResourceSet to delete

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.

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

Returns a collection of recommendations to improve resilliance and readiness check quality for a Recovery Group.

Service Reference:

Examples:

Calling the getArchitectureRecommendations operation

var params = {
  RecoveryGroupName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoveryreadiness.getArchitectureRecommendations(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) Upper bound on number of records to return.
    • NextToken — (String) A token that can be used to resume pagination from the end of the collection.
    • RecoveryGroupName — (String) Name of RecoveryGroup (top level resource) to be analyzed.

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:

      • LastAuditTimestamp — (Date) The time a Recovery Group was last assessed for recommendations in UTC ISO-8601 format.
      • NextToken — (String) A token that can be used to resume pagination from the end of the collection
      • Recommendations — (Array<map>) A list of recommendations for the customer's application
        • RecommendationText — required — (String) Guidance text for recommendation

Returns:

  • (AWS.Request) —

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

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

Returns information about a Cell.

Service Reference:

Examples:

Calling the getCell operation

var params = {
  CellName: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.getCell(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: {}) —
    • CellName — (String) The Cell to get

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:

      • CellArn — (String) The arn for the Cell
      • CellName — (String) The name of the Cell
      • Cells — (Array<String>) A list of Cell arns
      • ParentReadinessScopes — (Array<String>) A list of Cell ARNs and/or RecoveryGroup ARNs
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Returns information about readiness of a Cell.

Service Reference:

Examples:

Calling the getCellReadinessSummary operation

var params = {
  CellName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoveryreadiness.getCellReadinessSummary(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: {}) —
    • CellName — (String) The name of the Cell
    • MaxResults — (Integer) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.

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) A token that can be used to resume pagination from the end of the collection.
      • Readiness — (String) The readiness at Cell level. Possible values include:
        • "READY"
        • "NOT_READY"
        • "UNKNOWN"
        • "NOT_AUTHORIZED"
      • ReadinessChecks — (Array<map>) Summaries for the ReadinessChecks making up the Cell
        • Readiness — (String) The readiness of this ReadinessCheck Possible values include:
          • "READY"
          • "NOT_READY"
          • "UNKNOWN"
          • "NOT_AUTHORIZED"
        • ReadinessCheckName — (String) The name of a ReadinessCheck which is part of the given RecoveryGroup or Cell

Returns:

  • (AWS.Request) —

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

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

Returns information about a ReadinessCheck.

Service Reference:

Examples:

Calling the getReadinessCheck operation

var params = {
  ReadinessCheckName: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.getReadinessCheck(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: {}) —
    • ReadinessCheckName — (String) The ReadinessCheck to get

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:

      • ReadinessCheckArn — (String) Arn associated with ReadinessCheck
      • ReadinessCheckName — (String) Name for a ReadinessCheck
      • ResourceSet — (String) Name of the ResourceSet to be checked
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Returns detailed information about the status of an individual resource within a Readiness Check's Resource Set.

Service Reference:

Examples:

Calling the getReadinessCheckResourceStatus operation

var params = {
  ReadinessCheckName: 'STRING_VALUE', /* required */
  ResourceIdentifier: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoveryreadiness.getReadinessCheckResourceStatus(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) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.
    • ReadinessCheckName — (String) The ReadinessCheck to get
    • ResourceIdentifier — (String) The resource ARN or component Id to get

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) A token that can be used to resume pagination from the end of the collection.
      • Readiness — (String) The readiness at rule level. Possible values include:
        • "READY"
        • "NOT_READY"
        • "UNKNOWN"
        • "NOT_AUTHORIZED"
      • Rules — (Array<map>) Details of the rules's results
        • LastCheckedTimestamp — required — (Date) The time the resource was last checked for readiness, in ISO-8601 format, UTC.
        • Messages — required — (Array<map>) Details about the resource's readiness
          • MessageText — (String) The text of a readiness check message
        • Readiness — required — (String) The readiness at rule level. Possible values include:
          • "READY"
          • "NOT_READY"
          • "UNKNOWN"
          • "NOT_AUTHORIZED"
        • RuleId — required — (String) The identifier of the rule.

Returns:

  • (AWS.Request) —

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

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

Returns information about the status of a Readiness Check.

Service Reference:

Examples:

Calling the getReadinessCheckStatus operation

var params = {
  ReadinessCheckName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoveryreadiness.getReadinessCheckStatus(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) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.
    • ReadinessCheckName — (String) The ReadinessCheck to get

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:

      • Messages — (Array<map>) Top level messages for readiness check status
        • MessageText — (String) The text of a readiness check message
      • NextToken — (String) A token that can be used to resume pagination from the end of the collection.
      • Readiness — (String) The readiness at rule level. Possible values include:
        • "READY"
        • "NOT_READY"
        • "UNKNOWN"
        • "NOT_AUTHORIZED"
      • Resources — (Array<map>) Summary of resources's readiness
        • ComponentId — (String) The component id of the resource
        • LastCheckedTimestamp — required — (Date) The time the resource was last checked for readiness, in ISO-8601 format, UTC.
        • Readiness — required — (String) The readiness of the resource. Possible values include:
          • "READY"
          • "NOT_READY"
          • "UNKNOWN"
          • "NOT_AUTHORIZED"
        • ResourceArn — (String) The ARN of the resource

Returns:

  • (AWS.Request) —

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

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

Returns information about a Recovery Group.

Service Reference:

Examples:

Calling the getRecoveryGroup operation

var params = {
  RecoveryGroupName: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.getRecoveryGroup(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: {}) —
    • RecoveryGroupName — (String) The RecoveryGroup to get

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:

      • Cells — (Array<String>) A list of Cell arns
      • RecoveryGroupArn — (String) The arn for the RecoveryGroup
      • RecoveryGroupName — (String) The name of the RecoveryGroup
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Returns information about a Recovery Group.

Service Reference:

Examples:

Calling the getRecoveryGroupReadinessSummary operation

var params = {
  RecoveryGroupName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoveryreadiness.getRecoveryGroupReadinessSummary(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) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.
    • RecoveryGroupName — (String) The name of the RecoveryGroup

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) A token that can be used to resume pagination from the end of the collection.
      • Readiness — (String) The readiness at RecoveryGroup level. Possible values include:
        • "READY"
        • "NOT_READY"
        • "UNKNOWN"
        • "NOT_AUTHORIZED"
      • ReadinessChecks — (Array<map>) Summaries for the ReadinessChecks making up the RecoveryGroup
        • Readiness — (String) The readiness of this ReadinessCheck Possible values include:
          • "READY"
          • "NOT_READY"
          • "UNKNOWN"
          • "NOT_AUTHORIZED"
        • ReadinessCheckName — (String) The name of a ReadinessCheck which is part of the given RecoveryGroup or Cell

Returns:

  • (AWS.Request) —

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

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

Returns information about a Resource Set.

Service Reference:

Examples:

Calling the getResourceSet operation

var params = {
  ResourceSetName: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.getResourceSet(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: {}) —
    • ResourceSetName — (String) The ResourceSet to get

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:

      • ResourceSetArn — (String) The arn for the ResourceSet
      • ResourceSetName — (String) The name of the ResourceSet
      • ResourceSetType — (String) AWS Resource Type of the resources in the ResourceSet
      • Resources — (Array<map>) A list of Resource objects
        • ComponentId — (String) The component id of the resource, generated by the service when dnsTargetResource is used
        • DnsTargetResource — (map) A component for DNS/Routing Control Readiness Checks
          • DomainName — (String) The DNS Name that acts as ingress point to a portion of application
          • HostedZoneArn — (String) The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
          • RecordSetId — (String) The R53 Set Id to uniquely identify a record given a Name and a Type
          • RecordType — (String) The Type of DNS Record of target resource
          • TargetResource — (map) The target resource the R53 record points to
            • NLBResource — (map) The NLB resource a DNS Target Resource points to
              • Arn — (String) An NLB resource arn
            • R53Resource — (map) The Route 53 resource a DNS Target Resource record points to
              • DomainName — (String) The DNS target name
              • RecordSetId — (String) The Resource Record set id
        • ReadinessScopes — (Array<String>) A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
        • ResourceArn — (String) The ARN of the AWS resource, can be skipped if dnsTargetResource is used
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Returns a collection of Cells.

Service Reference:

Examples:

Calling the listCells operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoveryreadiness.listCells(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) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.

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:

      • Cells — (Array<map>) A list of Cells
        • CellArn — required — (String) The arn for the Cell
        • CellName — required — (String) The name of the Cell
        • Cells — required — (Array<String>) A list of Cell arns
        • ParentReadinessScopes — required — (Array<String>) A list of Cell ARNs and/or RecoveryGroup ARNs
        • Tags — (map<String>) A collection of tags associated with a resource
      • NextToken — (String) A token that can be used to resume pagination from the end of the collection.

Returns:

  • (AWS.Request) —

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

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

Returns a collection of cross account readiness authorizations.

Service Reference:

Examples:

Calling the listCrossAccountAuthorizations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoveryreadiness.listCrossAccountAuthorizations(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) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.

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:

      • CrossAccountAuthorizations — (Array<String>) A list of CrossAccountAuthorizations
      • NextToken — (String) A token that can be used to resume pagination from the end of the collection.

Returns:

  • (AWS.Request) —

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

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

Returns a collection of Readiness Checks.

Service Reference:

Examples:

Calling the listReadinessChecks operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoveryreadiness.listReadinessChecks(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) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.

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) A token that can be used to resume pagination from the end of the collection.
      • ReadinessChecks — (Array<map>) A list of ReadinessCheck associated with the account
        • ReadinessCheckArn — required — (String) Arn associated with ReadinessCheck
        • ReadinessCheckName — (String) Name for a ReadinessCheck
        • ResourceSet — required — (String) Name of the ResourceSet to be checked
        • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Returns a collection of Recovery Groups.

Service Reference:

Examples:

Calling the listRecoveryGroups operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoveryreadiness.listRecoveryGroups(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) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.

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) A token that can be used to resume pagination from the end of the collection.
      • RecoveryGroups — (Array<map>) A list of RecoveryGroups
        • Cells — required — (Array<String>) A list of Cell arns
        • RecoveryGroupArn — required — (String) The arn for the RecoveryGroup
        • RecoveryGroupName — required — (String) The name of the RecoveryGroup
        • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Returns a collection of Resource Sets.

Service Reference:

Examples:

Calling the listResourceSets operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53recoveryreadiness.listResourceSets(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) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.

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) A token that can be used to resume pagination from the end of the collection.
      • ResourceSets — (Array<map>) A list of ResourceSets associated with the account
        • ResourceSetArn — required — (String) The arn for the ResourceSet
        • ResourceSetName — required — (String) The name of the ResourceSet
        • ResourceSetType — required — (String) AWS Resource Type of the resources in the ResourceSet
        • Resources — required — (Array<map>) A list of Resource objects
          • ComponentId — (String) The component id of the resource, generated by the service when dnsTargetResource is used
          • DnsTargetResource — (map) A component for DNS/Routing Control Readiness Checks
            • DomainName — (String) The DNS Name that acts as ingress point to a portion of application
            • HostedZoneArn — (String) The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
            • RecordSetId — (String) The R53 Set Id to uniquely identify a record given a Name and a Type
            • RecordType — (String) The Type of DNS Record of target resource
            • TargetResource — (map) The target resource the R53 record points to
              • NLBResource — (map) The NLB resource a DNS Target Resource points to
                • Arn — (String) An NLB resource arn
              • R53Resource — (map) The Route 53 resource a DNS Target Resource record points to
                • DomainName — (String) The DNS target name
                • RecordSetId — (String) The Resource Record set id
          • ReadinessScopes — (Array<String>) A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
          • ResourceArn — (String) The ARN of the AWS resource, can be skipped if dnsTargetResource is used
        • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Returns a collection of rules that are applied as part of Readiness Checks.

Service Reference:

Examples:

Calling the listRules operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE'
};
route53recoveryreadiness.listRules(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) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.
    • ResourceType — (String) Filter parameter which specifies the rules to return given a resource type.

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) A token that can be used to resume pagination from the end of the collection.
      • Rules — (Array<map>) A list of rules
        • ResourceType — required — (String) The resource type the rule applies to.
        • RuleDescription — required — (String) A description of the rule
        • RuleId — required — (String) The Rule's ID.

Returns:

  • (AWS.Request) —

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

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

Returns a list of the tags assigned to the specified resource.

Service Reference:

Examples:

Calling the listTagsForResources operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.listTagsForResources(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. You can get this from the response to any request to 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. The data object has the following properties:

      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Adds tags to the specified resource. You can specify one or more tags to add.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
route53recoveryreadiness.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. You can get this from the response to any request to the resource.
    • Tags — (map<String>) A collection of tags associated with a 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 tags from the specified resource. You can specify one or more tags to remove.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
route53recoveryreadiness.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. You can get this from the response to any request to the resource.
    • TagKeys — (Array<String>) A comma-separated list of the tag keys to remove from 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.

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

Updates an existing Cell.

Service Reference:

Examples:

Calling the updateCell operation

var params = {
  CellName: 'STRING_VALUE', /* required */
  Cells: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
route53recoveryreadiness.updateCell(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: {}) —
    • CellName — (String) The Cell to update
    • Cells — (Array<String>) A list of Cell arns, completely replaces previous list

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:

      • CellArn — (String) The arn for the Cell
      • CellName — (String) The name of the Cell
      • Cells — (Array<String>) A list of Cell arns
      • ParentReadinessScopes — (Array<String>) A list of Cell ARNs and/or RecoveryGroup ARNs
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Updates an exisiting Readiness Check.

Service Reference:

Examples:

Calling the updateReadinessCheck operation

var params = {
  ReadinessCheckName: 'STRING_VALUE', /* required */
  ResourceSetName: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.updateReadinessCheck(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: {}) —
    • ReadinessCheckName — (String) The ReadinessCheck to update
    • ResourceSetName — (String) The name of the ResourceSet to check

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:

      • ReadinessCheckArn — (String) Arn associated with ReadinessCheck
      • ReadinessCheckName — (String) Name for a ReadinessCheck
      • ResourceSet — (String) Name of the ResourceSet to be checked
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Updates an existing Recovery Group.

Service Reference:

Examples:

Calling the updateRecoveryGroup operation

var params = {
  Cells: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  RecoveryGroupName: 'STRING_VALUE' /* required */
};
route53recoveryreadiness.updateRecoveryGroup(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: {}) —
    • Cells — (Array<String>) A list of Cell arns, completely replaces previous list
    • RecoveryGroupName — (String) The RecoveryGroup to update

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:

      • Cells — (Array<String>) A list of Cell arns
      • RecoveryGroupArn — (String) The arn for the RecoveryGroup
      • RecoveryGroupName — (String) The name of the RecoveryGroup
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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

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

Updates an existing Resource Set.

Service Reference:

Examples:

Calling the updateResourceSet operation

var params = {
  ResourceSetName: 'STRING_VALUE', /* required */
  ResourceSetType: 'STRING_VALUE', /* required */
  Resources: [ /* required */
    {
      ComponentId: 'STRING_VALUE',
      DnsTargetResource: {
        DomainName: 'STRING_VALUE',
        HostedZoneArn: 'STRING_VALUE',
        RecordSetId: 'STRING_VALUE',
        RecordType: 'STRING_VALUE',
        TargetResource: {
          NLBResource: {
            Arn: 'STRING_VALUE'
          },
          R53Resource: {
            DomainName: 'STRING_VALUE',
            RecordSetId: 'STRING_VALUE'
          }
        }
      },
      ReadinessScopes: [
        'STRING_VALUE',
        /* more items */
      ],
      ResourceArn: 'STRING_VALUE'
    },
    /* more items */
  ]
};
route53recoveryreadiness.updateResourceSet(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: {}) —
    • ResourceSetName — (String) The ResourceSet to update
    • ResourceSetType — (String) AWS Resource Type of the resources in the ResourceSet
    • Resources — (Array<map>) A list of Resource objects
      • ComponentId — (String) The component id of the resource, generated by the service when dnsTargetResource is used
      • DnsTargetResource — (map) A component for DNS/Routing Control Readiness Checks
        • DomainName — (String) The DNS Name that acts as ingress point to a portion of application
        • HostedZoneArn — (String) The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
        • RecordSetId — (String) The R53 Set Id to uniquely identify a record given a Name and a Type
        • RecordType — (String) The Type of DNS Record of target resource
        • TargetResource — (map) The target resource the R53 record points to
          • NLBResource — (map) The NLB resource a DNS Target Resource points to
            • Arn — (String) An NLB resource arn
          • R53Resource — (map) The Route 53 resource a DNS Target Resource record points to
            • DomainName — (String) The DNS target name
            • RecordSetId — (String) The Resource Record set id
      • ReadinessScopes — (Array<String>) A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
      • ResourceArn — (String) The ARN of the AWS resource, can be skipped if dnsTargetResource is used

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:

      • ResourceSetArn — (String) The arn for the ResourceSet
      • ResourceSetName — (String) The name of the ResourceSet
      • ResourceSetType — (String) AWS Resource Type of the resources in the ResourceSet
      • Resources — (Array<map>) A list of Resource objects
        • ComponentId — (String) The component id of the resource, generated by the service when dnsTargetResource is used
        • DnsTargetResource — (map) A component for DNS/Routing Control Readiness Checks
          • DomainName — (String) The DNS Name that acts as ingress point to a portion of application
          • HostedZoneArn — (String) The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
          • RecordSetId — (String) The R53 Set Id to uniquely identify a record given a Name and a Type
          • RecordType — (String) The Type of DNS Record of target resource
          • TargetResource — (map) The target resource the R53 record points to
            • NLBResource — (map) The NLB resource a DNS Target Resource points to
              • Arn — (String) An NLB resource arn
            • R53Resource — (map) The Route 53 resource a DNS Target Resource record points to
              • DomainName — (String) The DNS target name
              • RecordSetId — (String) The Resource Record set id
        • ReadinessScopes — (Array<String>) A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
        • ResourceArn — (String) The ARN of the AWS resource, can be skipped if dnsTargetResource is used
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request) —

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