The AWS SDK for JavaScript v2 has reached end-of-support.
We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

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

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

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

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 cell in an account.

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 Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Amazon Web Services Regions.

    • 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 Amazon Resource Name (ARN) for the cell.

      • CellName — (String)

        The name of the cell.

      • Cells — (Array<String>)

        A list of cell ARNs.

      • ParentReadinessScopes — (Array<String>)

        The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.

      • Tags — (map<String>)

        Tags on the resources.

Returns:

  • (AWS.Request) —

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

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

Creates a cross-account readiness authorization. This lets you authorize another account to work with Route 53 Application Recovery Controller, for example, to check the readiness status of resources in a separate account.

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 readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a 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 readiness check to create.

    • ResourceSetName — (String)

      The name of the resource set 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)

        The Amazon Resource Name (ARN) associated with a readiness check.

      • ReadinessCheckName — (String)

        Name of a readiness check.

      • ResourceSet — (String)

        Name of the resource set 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 recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.

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 the cell Amazon Resource Names (ARNs) in the recovery group.

    • RecoveryGroupName — (String)

      The name of the recovery group 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 a cell's Amazon Resource Names (ARNs).

      • RecoveryGroupArn — (String)

        The Amazon Resource Name (ARN) for the recovery group.

      • RecoveryGroupName — (String)

        The name of the recovery group.

      • Tags — (map<String>)

        The tags associated with the recovery group.

Returns:

  • (AWS.Request) —

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

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

Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.

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 resource set to create.

    • ResourceSetType — (String)

      The resource type of the resources in the resource set. Enter one of the following values for resource type:

      AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

    • Resources — (Array<map>)

      A list of resource objects in the resource set.

      • ComponentId — (String)

        The component identifier of the resource, generated when DNS target resource is used.

      • DnsTargetResource — (map)

        The DNS target resource.

        • DomainName — (String)

          The domain name that acts as an ingress point to a portion of the customer application.

        • HostedZoneArn — (String)

          The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.

        • RecordSetId — (String)

          The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.

        • RecordType — (String)

          The type of DNS record of the target resource.

        • TargetResource — (map)

          The target resource of the DNS target resource.

          • NLBResource — (map)

            The Network Load Balancer Resource.

            • Arn — (String)

              The Network Load Balancer resource Amazon Resource Name (ARN).

          • R53Resource — (map)

            The Route 53 resource.

            • DomainName — (String)

              The DNS target domain name.

            • RecordSetId — (String)

              The Route 53 Resource Record Set ID.

      • ReadinessScopes — (Array<String>)

        A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.

      • ResourceArn — (String)

        The Amazon Resource Name (ARN) of the Amazon Web Services resource.

    • Tags — (map<String>)

      A tag to associate with the parameters for a resource set.

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 Amazon Resource Name (ARN) for the resource set.

      • ResourceSetName — (String)

        The name of the resource set.

      • ResourceSetType — (String)

        The resource type of the resources in the resource set. Enter one of the following values for resource type:

        AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

      • Resources — (Array<map>)

        A list of resource objects.

        • ComponentId — (String)

          The component identifier of the resource, generated when DNS target resource is used.

        • DnsTargetResource — (map)

          The DNS target resource.

          • DomainName — (String)

            The domain name that acts as an ingress point to a portion of the customer application.

          • HostedZoneArn — (String)

            The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.

          • RecordSetId — (String)

            The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.

          • RecordType — (String)

            The type of DNS record of the target resource.

          • TargetResource — (map)

            The target resource of the DNS target resource.

            • NLBResource — (map)

              The Network Load Balancer Resource.

              • Arn — (String)

                The Network Load Balancer resource Amazon Resource Name (ARN).

            • R53Resource — (map)

              The Route 53 resource.

              • DomainName — (String)

                The DNS target domain name.

              • RecordSetId — (String)

                The Route 53 Resource Record Set ID.

        • ReadinessScopes — (Array<String>)

          A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon Web Services resource.

      • 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

Delete a cell. When successful, the response code is 204, with no response body.

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 name of the cell.

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

Deletes 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 a 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)

      Name of a readiness 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.

Returns:

  • (AWS.Request) —

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

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

Deletes a 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 name of a recovery group.

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 a 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)

      Name of a resource set.

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

Gets recommendations about architecture designs for improving resiliency for an application, based on 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)

      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.

    • RecoveryGroupName — (String)

      The name of a recovery group.

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 that a recovery group was last assessed for recommendations, in UTC ISO-8601 format.

      • NextToken — (String)

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

      • Recommendations — (Array<map>)

        A list of the recommendations for the customer's application.

        • RecommendationText — required — (String)

          Text of the recommendations that are provided to make an application more recovery resilient.

Returns:

  • (AWS.Request) —

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

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

Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.

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 name of the cell.

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 Amazon Resource Name (ARN) for the cell.

      • CellName — (String)

        The name of the cell.

      • Cells — (Array<String>)

        A list of cell ARNs.

      • ParentReadinessScopes — (Array<String>)

        The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.

      • Tags — (map<String>)

        Tags on the resources.

Returns:

  • (AWS.Request) —

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

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

Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.

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)

      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.

      • Readiness — (String)

        The readiness at a cell level.

        Possible values include:
        • "READY"
        • "NOT_READY"
        • "UNKNOWN"
        • "NOT_AUTHORIZED"
      • ReadinessChecks — (Array<map>)

        Summaries for the readiness checks that make up the cell.

        • Readiness — (String)

          The readiness status of this readiness check.

          Possible values include:
          • "READY"
          • "NOT_READY"
          • "UNKNOWN"
          • "NOT_AUTHORIZED"
        • ReadinessCheckName — (String)

          The name of a readiness check.

Returns:

  • (AWS.Request) —

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

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

Gets details about a readiness check.

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)

      Name of a readiness 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)

        The Amazon Resource Name (ARN) associated with a readiness check.

      • ReadinessCheckName — (String)

        Name of a readiness check.

      • ResourceSet — (String)

        Name of the resource set 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

Gets individual readiness status for a readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in the recovery group, use GetRecoveryGroupReadinessSummary.

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)

      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.

    • ReadinessCheckName — (String)

      Name of a readiness check.

    • ResourceIdentifier — (String)

      The resource identifier, which is the Amazon Resource Name (ARN) or the identifier generated for the resource by Application Recovery Controller (for example, for a DNS target 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:

      • NextToken — (String)

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

      • Readiness — (String)

        The readiness at a rule level.

        Possible values include:
        • "READY"
        • "NOT_READY"
        • "UNKNOWN"
        • "NOT_AUTHORIZED"
      • Rules — (Array<map>)

        Details of the rule'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

Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary.

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)

      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.

    • ReadinessCheckName — (String)

      Name of a readiness 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:

      • Messages — (Array<map>)

        Top level messages for readiness check status

        • MessageText — (String)

          The text of a readiness check message.

      • NextToken — (String)

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

      • Readiness — (String)

        The readiness at rule level.

        Possible values include:
        • "READY"
        • "NOT_READY"
        • "UNKNOWN"
        • "NOT_AUTHORIZED"
      • Resources — (Array<map>)

        Summary of the readiness of resources.

        • ComponentId — (String)

          The component id of the resource.

        • LastCheckedTimestamp — required — (Date)

          The time (UTC) that the resource was last checked for readiness, in ISO-8601 format.

        • Readiness — required — (String)

          The readiness of a resource.

          Possible values include:
          • "READY"
          • "NOT_READY"
          • "UNKNOWN"
          • "NOT_AUTHORIZED"
        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the resource.

Returns:

  • (AWS.Request) —

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

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

Gets details about a recovery group, including a list of the cells that are included in it.

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 name of a recovery group.

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 a cell's Amazon Resource Names (ARNs).

      • RecoveryGroupArn — (String)

        The Amazon Resource Name (ARN) for the recovery group.

      • RecoveryGroupName — (String)

        The name of the recovery group.

      • Tags — (map<String>)

        The tags associated with the recovery group.

Returns:

  • (AWS.Request) —

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

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

Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.

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)

      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.

    • RecoveryGroupName — (String)

      The name of a recovery group.

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.

      • Readiness — (String)

        The readiness status at a recovery group level.

        Possible values include:
        • "READY"
        • "NOT_READY"
        • "UNKNOWN"
        • "NOT_AUTHORIZED"
      • ReadinessChecks — (Array<map>)

        Summaries of the readiness checks for the recovery group.

        • Readiness — (String)

          The readiness status of this readiness check.

          Possible values include:
          • "READY"
          • "NOT_READY"
          • "UNKNOWN"
          • "NOT_AUTHORIZED"
        • ReadinessCheckName — (String)

          The name of a readiness check.

Returns:

  • (AWS.Request) —

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

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

Displays the details about a resource set, including a list of the resources in the 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)

      Name of a resource set.

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 Amazon Resource Name (ARN) for the resource set.

      • ResourceSetName — (String)

        The name of the resource set.

      • ResourceSetType — (String)

        The resource type of the resources in the resource set. Enter one of the following values for resource type:

        AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

      • Resources — (Array<map>)

        A list of resource objects.

        • ComponentId — (String)

          The component identifier of the resource, generated when DNS target resource is used.

        • DnsTargetResource — (map)

          The DNS target resource.

          • DomainName — (String)

            The domain name that acts as an ingress point to a portion of the customer application.

          • HostedZoneArn — (String)

            The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.

          • RecordSetId — (String)

            The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.

          • RecordType — (String)

            The type of DNS record of the target resource.

          • TargetResource — (map)

            The target resource of the DNS target resource.

            • NLBResource — (map)

              The Network Load Balancer Resource.

              • Arn — (String)

                The Network Load Balancer resource Amazon Resource Name (ARN).

            • R53Resource — (map)

              The Route 53 resource.

              • DomainName — (String)

                The DNS target domain name.

              • RecordSetId — (String)

                The Route 53 Resource Record Set ID.

        • ReadinessScopes — (Array<String>)

          A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon Web Services resource.

      • 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

Lists the cells for an account.

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)

      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:

      • Cells — (Array<map>)

        A list of cells.

        • CellArn — required — (String)

          The Amazon Resource Name (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>)

          The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.

        • Tags — (map<String>)

          Tags on the resources.

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

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

Lists the cross-account readiness authorizations that are in place for an account.

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)