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

Class: AWS.Resiliencehub

Inherits:
AWS.Service show all
Identifier:
resiliencehub
API Version:
2020-04-30
Defined in:
(unknown)

Overview

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

Service Description

Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. It offers continual resiliency assessment and validation that integrates into your software development lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your applications are met, and resolve issues before they are released into production.

Sending a Request Using Resiliencehub

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

var resiliencehub = new AWS.Resiliencehub({apiVersion: '2020-04-30'});

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

AWS.config.apiVersions = {
  resiliencehub: '2020-04-30',
  // other service API versions
};

var resiliencehub = new AWS.Resiliencehub();

Version:

  • 2020-04-30

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.Resiliencehub(options = {}) ⇒ Object

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

Examples:

Constructing a Resiliencehub object

var resiliencehub = new AWS.Resiliencehub({apiVersion: '2020-04-30'});

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.Resiliencehub.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

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

  • s3UseArnRegion (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean|undefined)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Adds the source of resource-maps to the draft version of an application. During assessment, Resilience Hub will use these resource-maps to resolve the latest physical ID for each resource in the application template. For more information about different types of resources suported by Resilience Hub and how to add them in your application, see Step 2: How is your application managed? in the Resilience Hub User Guide.

Examples:

Calling the addDraftAppVersionResourceMappings operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  resourceMappings: [ /* required */
    {
      mappingType: CfnStack | Resource | AppRegistryApp | ResourceGroup | Terraform | EKS, /* required */
      physicalResourceId: { /* required */
        identifier: 'STRING_VALUE', /* required */
        type: Arn | Native, /* required */
        awsAccountId: 'STRING_VALUE',
        awsRegion: 'STRING_VALUE'
      },
      appRegistryAppName: 'STRING_VALUE',
      eksSourceName: 'STRING_VALUE',
      logicalStackName: 'STRING_VALUE',
      resourceGroupName: 'STRING_VALUE',
      resourceName: 'STRING_VALUE',
      terraformSourceName: 'STRING_VALUE'
    },
    /* more items */
  ]
};
resiliencehub.addDraftAppVersionResourceMappings(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • resourceMappings — (Array<map>)

      Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

      • appRegistryAppName — (String)

        The name of the application this resource is mapped to.

      • eksSourceName — (String)

        Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

        Note: This parameter accepts values in "eks-cluster/namespace" format.
      • logicalStackName — (String)

        The name of the CloudFormation stack this resource is mapped to.

      • mappingTyperequired — (String)

        Specifies the type of resource mapping.

        AppRegistryApp

        The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.

        CfnStack

        The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.

        Resource

        The resource is mapped to another resource. The name of the resource is contained in the resourceName property.

        ResourceGroup

        The resource is mapped to Resource Groups. The name of the resource group is contained in the resourceGroupName property.

        Possible values include:
        • "CfnStack"
        • "Resource"
        • "AppRegistryApp"
        • "ResourceGroup"
        • "Terraform"
        • "EKS"
      • physicalResourceIdrequired — (map)

        Identifier of the physical resource.

        • awsAccountId — (String)

          The Amazon Web Services account that owns the physical resource.

        • awsRegion — (String)

          The Amazon Web Services Region that the physical resource is located in.

        • identifierrequired — (String)

          Identifier of the physical resource.

        • typerequired — (String)

          Specifies the type of physical resource identifier.

          Arn

          The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

          • AWS::ECS::Service

          • AWS::EFS::FileSystem

          • AWS::ElasticLoadBalancingV2::LoadBalancer

          • AWS::Lambda::Function

          • AWS::SNS::Topic

          Native

          The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

          • AWS::ApiGateway::RestApi

          • AWS::ApiGatewayV2::Api

          • AWS::AutoScaling::AutoScalingGroup

          • AWS::DocDB::DBCluster

          • AWS::DocDB::DBGlobalCluster

          • AWS::DocDB::DBInstance

          • AWS::DynamoDB::GlobalTable

          • AWS::DynamoDB::Table

          • AWS::EC2::EC2Fleet

          • AWS::EC2::Instance

          • AWS::EC2::NatGateway

          • AWS::EC2::Volume

          • AWS::ElasticLoadBalancing::LoadBalancer

          • AWS::RDS::DBCluster

          • AWS::RDS::DBInstance

          • AWS::RDS::GlobalCluster

          • AWS::Route53::RecordSet

          • AWS::S3::Bucket

          • AWS::SQS::Queue

          Possible values include:
          • "Arn"
          • "Native"
      • resourceGroupName — (String)

        Name of the resource group that the resource is mapped to.

      • resourceName — (String)

        Name of the resource that the resource is mapped to.

      • terraformSourceName — (String)

        The short name of the Terraform source.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        The version of the application.

      • resourceMappings — (Array<map>)

        List of sources that are used to map a logical resource from the template to a physical resource. You can use sources such as CloudFormation, Terraform state files, AppRegistry applications, or Amazon EKS.

        • appRegistryAppName — (String)

          The name of the application this resource is mapped to.

        • eksSourceName — (String)

          Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          Note: This parameter accepts values in "eks-cluster/namespace" format.
        • logicalStackName — (String)

          The name of the CloudFormation stack this resource is mapped to.

        • mappingTyperequired — (String)

          Specifies the type of resource mapping.

          AppRegistryApp

          The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.

          CfnStack

          The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.

          Resource

          The resource is mapped to another resource. The name of the resource is contained in the resourceName property.

          ResourceGroup

          The resource is mapped to Resource Groups. The name of the resource group is contained in the resourceGroupName property.

          Possible values include:
          • "CfnStack"
          • "Resource"
          • "AppRegistryApp"
          • "ResourceGroup"
          • "Terraform"
          • "EKS"
        • physicalResourceIdrequired — (map)

          Identifier of the physical resource.

          • awsAccountId — (String)

            The Amazon Web Services account that owns the physical resource.

          • awsRegion — (String)

            The Amazon Web Services Region that the physical resource is located in.

          • identifierrequired — (String)

            Identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

            • AWS::ECS::Service

            • AWS::EFS::FileSystem

            • AWS::ElasticLoadBalancingV2::LoadBalancer

            • AWS::Lambda::Function

            • AWS::SNS::Topic

            Native

            The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

            • AWS::ApiGateway::RestApi

            • AWS::ApiGatewayV2::Api

            • AWS::AutoScaling::AutoScalingGroup

            • AWS::DocDB::DBCluster

            • AWS::DocDB::DBGlobalCluster

            • AWS::DocDB::DBInstance

            • AWS::DynamoDB::GlobalTable

            • AWS::DynamoDB::Table

            • AWS::EC2::EC2Fleet

            • AWS::EC2::Instance

            • AWS::EC2::NatGateway

            • AWS::EC2::Volume

            • AWS::ElasticLoadBalancing::LoadBalancer

            • AWS::RDS::DBCluster

            • AWS::RDS::DBInstance

            • AWS::RDS::GlobalCluster

            • AWS::Route53::RecordSet

            • AWS::S3::Bucket

            • AWS::SQS::Queue

            Possible values include:
            • "Arn"
            • "Native"
        • resourceGroupName — (String)

          Name of the resource group that the resource is mapped to.

        • resourceName — (String)

          Name of the resource that the resource is mapped to.

        • terraformSourceName — (String)

          The short name of the Terraform source.

Returns:

  • (AWS.Request)

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

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

Enables you to include or exclude one or more operational recommendations.

Service Reference:

Examples:

Calling the batchUpdateRecommendationStatus operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  requestEntries: [ /* required */
    {
      entryId: 'STRING_VALUE', /* required */
      excluded: true || false, /* required */
      item: { /* required */
        resourceId: 'STRING_VALUE',
        targetAccountId: 'STRING_VALUE',
        targetRegion: 'STRING_VALUE'
      },
      referenceId: 'STRING_VALUE', /* required */
      excludeReason: AlreadyImplemented | NotRelevant | ComplexityOfImplementation
    },
    /* more items */
  ]
};
resiliencehub.batchUpdateRecommendationStatus(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • requestEntries — (Array<map>)

      Defines the list of operational recommendations that need to be included or excluded.

      • entryIdrequired — (String)

        An identifier for an entry in this batch that is used to communicate the result.

        Note: The entryIds of a batch request need to be unique within a request.
      • excludeReason — (String)

        Indicates the reason for excluding an operational recommendation.

        Possible values include:
        • "AlreadyImplemented"
        • "NotRelevant"
        • "ComplexityOfImplementation"
      • excludedrequired — (Boolean)

        Indicates if the operational recommendation needs to be excluded. If set to True, the operational recommendation will be excluded.

      • itemrequired — (map)

        The operational recommendation item.

        • resourceId — (String)

          Resource identifier of the operational recommendation item.

        • targetAccountId — (String)

          Identifier of the target Amazon Web Services account.

        • targetRegion — (String)

          Identifier of the target Amazon Web Services Region.

      • referenceIdrequired — (String)

        Reference identifier of the operational recommendation item.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • failedEntries — (Array<map>)

        A list of items with error details about each item, which could not be included or excluded.

        • entryIdrequired — (String)

          An identifier of an entry in this batch that is used to communicate the result.

          Note: The entryIds of a batch request need to be unique within a request.
        • errorMessagerequired — (String)

          Indicates the error that occurred while excluding an operational recommendation.

      • successfulEntries — (Array<map>)

        A list of items that were included or excluded.

        • entryIdrequired — (String)

          An identifier for an entry in this batch that is used to communicate the result.

          Note: The entryIds of a batch request need to be unique within a request.
        • excludeReason — (String)

          Indicates the reason for excluding an operational recommendation.

          Possible values include:
          • "AlreadyImplemented"
          • "NotRelevant"
          • "ComplexityOfImplementation"
        • excludedrequired — (Boolean)

          Indicates if the operational recommendation was successfully excluded.

        • itemrequired — (map)

          The operational recommendation item.

          • resourceId — (String)

            Resource identifier of the operational recommendation item.

          • targetAccountId — (String)

            Identifier of the target Amazon Web Services account.

          • targetRegion — (String)

            Identifier of the target Amazon Web Services Region.

        • referenceIdrequired — (String)

          Reference identifier of the operational recommendation.

Returns:

  • (AWS.Request)

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

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

Creates an Resilience Hub application. An Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see Service quotas.

After you create an Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).

Service Reference:

Examples:

Calling the createApp operation

var params = {
  name: 'STRING_VALUE', /* required */
  assessmentSchedule: Disabled | Daily,
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  eventSubscriptions: [
    {
      eventType: ScheduledAssessmentFailure | DriftDetected, /* required */
      name: 'STRING_VALUE', /* required */
      snsTopicArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  permissionModel: {
    type: LegacyIAMUser | RoleBased, /* required */
    crossAccountRoleArns: [
      'STRING_VALUE',
      /* more items */
    ],
    invokerRoleName: 'STRING_VALUE'
  },
  policyArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resiliencehub.createApp(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: {})
    • assessmentSchedule — (String)

      Assessment execution schedule with 'Daily' or 'Disabled' values.

      Possible values include:
      • "Disabled"
      • "Daily"
    • clientToken — (String)

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      The optional description for an app.

    • eventSubscriptions — (Array<map>)

      The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only Drift detected and Scheduled assessment failure events notification.

      • eventTyperequired — (String)

        The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected (DriftDetected) and Scheduled assessment failure (ScheduledAssessmentFailure) events.

        Possible values include:
        • "ScheduledAssessmentFailure"
        • "DriftDetected"
      • namerequired — (String)

        Unique name to identify an event subscription.

      • snsTopicArn — (String)

        Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: arn:partition:sns:region:account:topic-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • name — (String)

      Name of the application.

    • permissionModel — (map)

      Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.

      • crossAccountRoleArns — (Array<String>)

        Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.

        Note:
        • These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts.
        • These roles must have a trust policy with iam:AssumeRole permission to the invoker role in the primary account.
      • invokerRoleName — (String)

        Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.

        Note:
        • You must have iam:passRole permission for this role while creating or updating the application.
        • Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.
      • typerequired — (String)

        Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user.

        Possible values include:
        • "LegacyIAMUser"
        • "RoleBased"
    • policyArn — (String)

      Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • tags — (map<String>)

      Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

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:

      • app — (map)

        The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.

        • appArnrequired — (String)

          Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • assessmentSchedule — (String)

          Assessment execution schedule with 'Daily' or 'Disabled' values.

          Possible values include:
          • "Disabled"
          • "Daily"
        • complianceStatus — (String)

          Current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotAssessed"
          • "ChangesDetected"
        • creationTimerequired — (Date)

          Date and time when the app was created.

        • description — (String)

          Optional description for an application.

        • driftStatus — (String)

          Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

          Possible values include:
          • "NotChecked"
          • "NotDetected"
          • "Detected"
        • eventSubscriptions — (Array<map>)

          The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.

          • eventTyperequired — (String)

            The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected (DriftDetected) and Scheduled assessment failure (ScheduledAssessmentFailure) events.

            Possible values include:
            • "ScheduledAssessmentFailure"
            • "DriftDetected"
          • namerequired — (String)

            Unique name to identify an event subscription.

          • snsTopicArn — (String)

            Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: arn:partition:sns:region:account:topic-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • lastAppComplianceEvaluationTime — (Date)

          Date and time the most recent compliance evaluation.

        • lastDriftEvaluationTime — (Date)

          Indicates the last time that a drift was evaluated.

        • lastResiliencyScoreEvaluationTime — (Date)

          Date and time the most recent resiliency score evaluation.

        • namerequired — (String)

          Name for the application.

        • permissionModel — (map)

          Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.

          • crossAccountRoleArns — (Array<String>)

            Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.

            Note:
            • These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts.
            • These roles must have a trust policy with iam:AssumeRole permission to the invoker role in the primary account.
          • invokerRoleName — (String)

            Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.

            Note:
            • You must have iam:passRole permission for this role while creating or updating the application.
            • Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.
          • typerequired — (String)

            Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user.

            Possible values include:
            • "LegacyIAMUser"
            • "RoleBased"
        • policyArn — (String)

          Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • resiliencyScore — (Float)

          Current resiliency score for the application.

        • rpoInSecs — (Integer)

          Recovery Point Objective (RPO) in seconds.

        • rtoInSecs — (Integer)

          Recovery Time Objective (RTO) in seconds.

        • status — (String)

          Status of the application.

          Possible values include:
          • "Active"
          • "Deleting"
        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

Returns:

  • (AWS.Request)

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

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

Creates a new Application Component in the Resilience Hub application.

Note: This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

Service Reference:

Examples:

Calling the createAppVersionAppComponent operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  type: 'STRING_VALUE', /* required */
  additionalInfo: {
    '<String128WithoutWhitespace>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String128WithoutWhitespace>': ... */
  },
  clientToken: 'STRING_VALUE',
  id: 'STRING_VALUE'
};
resiliencehub.createAppVersionAppComponent(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: {})
    • additionalInfo — (map<Array<String>>)

      Currently, there is no supported additional information for Application Components.

    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • clientToken — (String)

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      Identifier of the Application Component.

    • name — (String)

      Name of the Application Component.

    • type — (String)

      Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appComponent — (map)

        List of Application Components that belong to this resource.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • id — (String)

          Identifier of the Application Component.

        • namerequired — (String)

          Name of the Application Component.

        • typerequired — (String)

          The type of Application Component.

      • appVersion — (String)

        Resilience Hub application version.

Returns:

  • (AWS.Request)

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

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

Adds a resource to the Resilience Hub application and assigns it to the specified Application Components. If you specify a new Application Component, Resilience Hub will automatically create the Application Component.

Note:
  • This action has no effect outside Resilience Hub.
  • This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
  • To update application version with new physicalResourceID, you must call ResolveAppVersionResources API.

Service Reference:

Examples:

Calling the createAppVersionResource operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appComponents: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  logicalResourceId: { /* required */
    identifier: 'STRING_VALUE', /* required */
    eksSourceName: 'STRING_VALUE',
    logicalStackName: 'STRING_VALUE',
    resourceGroupName: 'STRING_VALUE',
    terraformSourceName: 'STRING_VALUE'
  },
  physicalResourceId: 'STRING_VALUE', /* required */
  resourceType: 'STRING_VALUE', /* required */
  additionalInfo: {
    '<String128WithoutWhitespace>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String128WithoutWhitespace>': ... */
  },
  awsAccountId: 'STRING_VALUE',
  awsRegion: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  resourceName: 'STRING_VALUE'
};
resiliencehub.createAppVersionResource(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: {})
    • additionalInfo — (map<Array<String>>)

      Currently, there is no supported additional information for resources.

    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appComponents — (Array<String>)

      List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

    • awsAccountId — (String)

      Amazon Web Services account that owns the physical resource.

    • awsRegion — (String)

      Amazon Web Services region that owns the physical resource.

    • clientToken — (String)

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      Logical identifier of the resource.

      • eksSourceName — (String)

        Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

        Note: This parameter accepts values in "eks-cluster/namespace" format.
      • identifierrequired — (String)

        Identifier of the resource.

      • logicalStackName — (String)

        The name of the CloudFormation stack this resource belongs to.

      • resourceGroupName — (String)

        The name of the resource group that this resource belongs to.

      • terraformSourceName — (String)

        The name of the Terraform S3 state file this resource belongs to.

    • physicalResourceId — (String)

      Physical identifier of the resource.

    • resourceName — (String)

      Name of the resource.

    • resourceType — (String)

      Type of 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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        Resilience Hub application version.

      • physicalResource — (map)

        Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • appComponents — (Array<map>)

          The application components that belong to this resource.

          • additionalInfo — (map<Array<String>>)

            Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

            Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
          • id — (String)

            Identifier of the Application Component.

          • namerequired — (String)

            Name of the Application Component.

          • typerequired — (String)

            The type of Application Component.

        • excluded — (Boolean)

          Indicates if a resource is included or excluded from the assessment.

        • logicalResourceIdrequired — (map)

          Logical identifier of the resource.

          • eksSourceName — (String)

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            Note: This parameter accepts values in "eks-cluster/namespace" format.
          • identifierrequired — (String)

            Identifier of the resource.

          • logicalStackName — (String)

            The name of the CloudFormation stack this resource belongs to.

          • resourceGroupName — (String)

            The name of the resource group that this resource belongs to.

          • terraformSourceName — (String)

            The name of the Terraform S3 state file this resource belongs to.

        • parentResourceName — (String)

          Name of the parent resource.

        • physicalResourceIdrequired — (map)

          Identifier of the physical resource.

          • awsAccountId — (String)

            The Amazon Web Services account that owns the physical resource.

          • awsRegion — (String)

            The Amazon Web Services Region that the physical resource is located in.

          • identifierrequired — (String)

            Identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

            • AWS::ECS::Service

            • AWS::EFS::FileSystem

            • AWS::ElasticLoadBalancingV2::LoadBalancer

            • AWS::Lambda::Function

            • AWS::SNS::Topic

            Native

            The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

            • AWS::ApiGateway::RestApi

            • AWS::ApiGatewayV2::Api

            • AWS::AutoScaling::AutoScalingGroup

            • AWS::DocDB::DBCluster

            • AWS::DocDB::DBGlobalCluster

            • AWS::DocDB::DBInstance

            • AWS::DynamoDB::GlobalTable

            • AWS::DynamoDB::Table

            • AWS::EC2::EC2Fleet

            • AWS::EC2::Instance

            • AWS::EC2::NatGateway

            • AWS::EC2::Volume

            • AWS::ElasticLoadBalancing::LoadBalancer

            • AWS::RDS::DBCluster

            • AWS::RDS::DBInstance

            • AWS::RDS::GlobalCluster

            • AWS::Route53::RecordSet

            • AWS::S3::Bucket

            • AWS::SQS::Queue

            Possible values include:
            • "Arn"
            • "Native"
        • resourceName — (String)

          The name of the resource.

        • resourceTyperequired — (String)

          The type of resource.

        • sourceType — (String)

          Type of input source.

          Possible values include:
          • "AppTemplate"
          • "Discovered"

Returns:

  • (AWS.Request)

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

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

Creates a new recommendation template for the Resilience Hub application.

Service Reference:

Examples:

Calling the createRecommendationTemplate operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  bucketName: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  format: CfnYaml | CfnJson,
  recommendationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  recommendationTypes: [
    Alarm | Sop | Test,
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resiliencehub.createRecommendationTemplate(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: {})
    • assessmentArn — (String)

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • bucketName — (String)

      The name of the Amazon S3 bucket that will contain the recommendation template.

    • clientToken — (String)

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      The format for the recommendation template.

      CfnJson

      The template is CloudFormation JSON.

      CfnYaml

      The template is CloudFormation YAML.

      Possible values include:
      • "CfnYaml"
      • "CfnJson"
    • name — (String)

      The name for the recommendation template.

    • recommendationIds — (Array<String>)

      Identifiers for the recommendations used to create a recommendation template.

    • recommendationTypes — (Array<String>)

      An array of strings that specify the recommendation template type or types.

      Alarm

      The template is an AlarmRecommendation template.

      Sop

      The template is a SopRecommendation template.

      Test

      The template is a TestRecommendation template.

    • tags — (map<String>)

      Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

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:

      • recommendationTemplate — (map)

        The newly created recommendation template, returned as an object. This object includes the template's name, format, status, tags, Amazon S3 bucket location, and more.

        • appArn — (String)

          Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • assessmentArnrequired — (String)

          Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • endTime — (Date)

          The end time for the action.

        • formatrequired — (String)

          Format of the recommendation template.

          CfnJson

          The template is CloudFormation JSON.

          CfnYaml

          The template is CloudFormation YAML.

          Possible values include:
          • "CfnYaml"
          • "CfnJson"
        • message — (String)

          Message for the recommendation template.

        • namerequired — (String)

          Name for the recommendation template.

        • needsReplacements — (Boolean)

          Indicates if replacements are needed.

        • recommendationIds — (Array<String>)

          Identifiers for the recommendations used in the recommendation template.

        • recommendationTemplateArnrequired — (String)

          Amazon Resource Name (ARN) for the recommendation template.

        • recommendationTypesrequired — (Array<String>)

          An array of strings that specify the recommendation template type or types.

          Alarm

          The template is an AlarmRecommendation template.

          Sop

          The template is a SopRecommendation template.

          Test

          The template is a TestRecommendation template.

        • startTime — (Date)

          The start time for the action.

        • statusrequired — (String)

          Status of the action.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Success"
        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • templatesLocation — (map)

          The file location of the template.

          • bucket — (String)

            The name of the Amazon S3 bucket.

          • prefix — (String)

            The prefix for the Amazon S3 bucket.

Returns:

  • (AWS.Request)

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

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

Creates a resiliency policy for an application.

Note: Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for rtoInSecs and rpoInSecs, the estimated workload RTO and estimated workload RPO result will be near zero and the Compliance status for your application will be set to Policy breached.

Service Reference:

Examples:

Calling the createResiliencyPolicy operation

var params = {
  policy: { /* required */
    '<DisruptionType>': {
      rpoInSecs: 'NUMBER_VALUE', /* required */
      rtoInSecs: 'NUMBER_VALUE' /* required */
    },
    /* '<DisruptionType>': ... */
  },
  policyName: 'STRING_VALUE', /* required */
  tier: MissionCritical | Critical | Important | CoreServices | NonCritical | NotApplicable, /* required */
  clientToken: 'STRING_VALUE',
  dataLocationConstraint: AnyLocation | SameContinent | SameCountry,
  policyDescription: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resiliencehub.createResiliencyPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

      Possible values include:
      • "AnyLocation"
      • "SameContinent"
      • "SameCountry"
    • policy — (map<map>)

      The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

      • rpoInSecsrequired — (Integer)

        Recovery Point Objective (RPO) in seconds.

      • rtoInSecsrequired — (Integer)

        Recovery Time Objective (RTO) in seconds.

    • policyDescription — (String)

      The description for the policy.

    • policyName — (String)

      The name of the policy

    • tags — (map<String>)

      Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    • tier — (String)

      The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

      Possible values include:
      • "MissionCritical"
      • "Critical"
      • "Important"
      • "CoreServices"
      • "NonCritical"
      • "NotApplicable"

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:

      • policy — (map)

        The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

        • creationTime — (Date)

          Date and time when the resiliency policy was created.

        • dataLocationConstraint — (String)

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

          Possible values include:
          • "AnyLocation"
          • "SameContinent"
          • "SameCountry"
        • estimatedCostTier — (String)

          Specifies the estimated cost tier of the resiliency policy.

          Possible values include:
          • "L1"
          • "L2"
          • "L3"
          • "L4"
        • policy — (map<map>)

          The resiliency policy.

          • rpoInSecsrequired — (Integer)

            Recovery Point Objective (RPO) in seconds.

          • rtoInSecsrequired — (Integer)

            Recovery Time Objective (RTO) in seconds.

        • policyArn — (String)

          Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • tier — (String)

          The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

          Possible values include:
          • "MissionCritical"
          • "Critical"
          • "Important"
          • "CoreServices"
          • "NonCritical"
          • "NotApplicable"

Returns:

  • (AWS.Request)

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

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

Deletes an Resilience Hub application. This is a destructive action that can't be undone.

Service Reference:

Examples:

Calling the deleteApp operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  forceDelete: true || false
};
resiliencehub.deleteApp(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • clientToken — (String)

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      A boolean option to force the deletion of an Resilience Hub application.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

Returns:

  • (AWS.Request)

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

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

Deletes an Resilience Hub application assessment. This is a destructive action that can't be undone.

Service Reference:

Examples:

Calling the deleteAppAssessment operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
resiliencehub.deleteAppAssessment(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: {})
    • assessmentArn — (String)

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • clientToken — (String)

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • assessmentArn — (String)

        Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • assessmentStatus — (String)

        The current status of the assessment for the resiliency policy.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"

Returns:

  • (AWS.Request)

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

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

Deletes the input source and all of its imported resources from the Resilience Hub application.

Service Reference:

Examples:

Calling the deleteAppInputSource operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  eksSourceClusterNamespace: {
    eksClusterArn: 'STRING_VALUE', /* required */
    namespace: 'STRING_VALUE' /* required */
  },
  sourceArn: 'STRING_VALUE',
  terraformSource: {
    s3StateFileUrl: 'STRING_VALUE' /* required */
  }
};
resiliencehub.deleteAppInputSource(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • clientToken — (String)

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the Resilience Hub application.

      • eksClusterArnrequired — (String)

        Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • namespacerequired — (String)

        Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.

    • sourceArn — (String)

      The Amazon Resource Name (ARN) of the imported resource you want to remove from the Resilience Hub application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • terraformSource — (map)

      The imported Terraform s3 state file you want to remove from the Resilience Hub application.

      • s3StateFileUrlrequired — (String)

        The URL of the Terraform s3 state file you need to import.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appInputSource — (map)

        Name of the input source from where the application resource is imported from.

        • eksSourceClusterNamespace — (map)

          The namespace on your Amazon Elastic Kubernetes Service cluster.

          • eksClusterArnrequired — (String)

            Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

          • namespacerequired — (String)

            Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.

        • importTyperequired — (String)

          The resource type of the input source.

          Possible values include:
          • "CfnStack"
          • "Resource"
          • "AppRegistryApp"
          • "ResourceGroup"
          • "Terraform"
          • "EKS"
        • resourceCount — (Integer)

          The number of resources.

        • sourceArn — (String)

          The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • sourceName — (String)

          The name of the input source.

        • terraformSource — (map)

          The name of the Terraform s3 state file.

          • s3StateFileUrlrequired — (String)

            The URL of the Terraform s3 state file you need to import.

Returns:

  • (AWS.Request)

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

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

Deletes an Application Component from the Resilience Hub application.

Note:
  • This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
  • You will not be able to delete an Application Component if it has resources associated with it.

Service Reference:

Examples:

Calling the deleteAppVersionAppComponent operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
resiliencehub.deleteAppVersionAppComponent(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • clientToken — (String)

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      Identifier of the Application Component.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appComponent — (map)

        List of Application Components that belong to this resource.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • id — (String)

          Identifier of the Application Component.

        • namerequired — (String)

          Name of the Application Component.

        • typerequired — (String)

          The type of Application Component.

      • appVersion — (String)

        Resilience Hub application version.

Returns:

  • (AWS.Request)

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

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

Deletes a resource from the Resilience Hub application.

Note:
  • You can only delete a manually added resource. To exclude non-manually added resources, use the UpdateAppVersionResource API.
  • This action has no effect outside Resilience Hub.
  • This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

Service Reference:

Examples:

Calling the deleteAppVersionResource operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  awsAccountId: 'STRING_VALUE',
  awsRegion: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  logicalResourceId: {
    identifier: 'STRING_VALUE', /* required */
    eksSourceName: 'STRING_VALUE',
    logicalStackName: 'STRING_VALUE',
    resourceGroupName: 'STRING_VALUE',
    terraformSourceName: 'STRING_VALUE'
  },
  physicalResourceId: 'STRING_VALUE',
  resourceName: 'STRING_VALUE'
};
resiliencehub.deleteAppVersionResource(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • awsAccountId — (String)

      Amazon Web Services account that owns the physical resource.

    • awsRegion — (String)

      Amazon Web Services region that owns the physical resource.

    • clientToken — (String)

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      Logical identifier of the resource.

      • eksSourceName — (String)

        Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

        Note: This parameter accepts values in "eks-cluster/namespace" format.
      • identifierrequired — (String)

        Identifier of the resource.

      • logicalStackName — (String)

        The name of the CloudFormation stack this resource belongs to.

      • resourceGroupName — (String)

        The name of the resource group that this resource belongs to.

      • terraformSourceName — (String)

        The name of the Terraform S3 state file this resource belongs to.

    • physicalResourceId — (String)

      Physical identifier of the resource.

    • resourceName — (String)

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

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        Resilience Hub application version.

      • physicalResource — (map)

        Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • appComponents — (Array<map>)

          The application components that belong to this resource.

          • additionalInfo — (map<Array<String>>)

            Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

            Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
          • id — (String)

            Identifier of the Application Component.

          • namerequired — (String)

            Name of the Application Component.

          • typerequired — (String)

            The type of Application Component.

        • excluded — (Boolean)

          Indicates if a resource is included or excluded from the assessment.

        • logicalResourceIdrequired — (map)

          Logical identifier of the resource.

          • eksSourceName — (String)

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            Note: This parameter accepts values in "eks-cluster/namespace" format.
          • identifierrequired — (String)

            Identifier of the resource.

          • logicalStackName — (String)

            The name of the CloudFormation stack this resource belongs to.

          • resourceGroupName — (String)

            The name of the resource group that this resource belongs to.

          • terraformSourceName — (String)

            The name of the Terraform S3 state file this resource belongs to.

        • parentResourceName — (String)

          Name of the parent resource.

        • physicalResourceIdrequired — (map)

          Identifier of the physical resource.

          • awsAccountId — (String)

            The Amazon Web Services account that owns the physical resource.

          • awsRegion — (String)

            The Amazon Web Services Region that the physical resource is located in.

          • identifierrequired — (String)

            Identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

            • AWS::ECS::Service

            • AWS::EFS::FileSystem

            • AWS::ElasticLoadBalancingV2::LoadBalancer

            • AWS::Lambda::Function

            • AWS::SNS::Topic

            Native

            The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

            • AWS::ApiGateway::RestApi

            • AWS::ApiGatewayV2::Api

            • AWS::AutoScaling::AutoScalingGroup

            • AWS::DocDB::DBCluster

            • AWS::DocDB::DBGlobalCluster

            • AWS::DocDB::DBInstance

            • AWS::DynamoDB::GlobalTable

            • AWS::DynamoDB::Table

            • AWS::EC2::EC2Fleet

            • AWS::EC2::Instance

            • AWS::EC2::NatGateway

            • AWS::EC2::Volume

            • AWS::ElasticLoadBalancing::LoadBalancer

            • AWS::RDS::DBCluster

            • AWS::RDS::DBInstance

            • AWS::RDS::GlobalCluster

            • AWS::Route53::RecordSet

            • AWS::S3::Bucket

            • AWS::SQS::Queue

            Possible values include:
            • "Arn"
            • "Native"
        • resourceName — (String)

          The name of the resource.

        • resourceTyperequired — (String)

          The type of resource.

        • sourceType — (String)

          Type of input source.

          Possible values include:
          • "AppTemplate"
          • "Discovered"

Returns:

  • (AWS.Request)

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

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

Deletes a recommendation template. This is a destructive action that can't be undone.

Service Reference:

Examples:

Calling the deleteRecommendationTemplate operation

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

Parameters:

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

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      The Amazon Resource Name (ARN) for a recommendation template.

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:

      • recommendationTemplateArn — (String)

        The Amazon Resource Name (ARN) for a recommendation template.

      • status — (String)

        Status of the action.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"

Returns:

  • (AWS.Request)

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

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

Deletes a resiliency policy. This is a destructive action that can't be undone.

Service Reference:

Examples:

Calling the deleteResiliencyPolicy operation

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

Parameters:

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

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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:

      • policyArn — (String)

        Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

Returns:

  • (AWS.Request)

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

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

Describes an Resilience Hub application.

Service Reference:

Examples:

Calling the describeApp operation

var params = {
  appArn: 'STRING_VALUE' /* required */
};
resiliencehub.describeApp(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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:

      • app — (map)

        The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

        • appArnrequired — (String)

          Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • assessmentSchedule — (String)

          Assessment execution schedule with 'Daily' or 'Disabled' values.

          Possible values include:
          • "Disabled"
          • "Daily"
        • complianceStatus — (String)

          Current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotAssessed"
          • "ChangesDetected"
        • creationTimerequired — (Date)

          Date and time when the app was created.

        • description — (String)

          Optional description for an application.

        • driftStatus — (String)

          Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

          Possible values include:
          • "NotChecked"
          • "NotDetected"
          • "Detected"
        • eventSubscriptions — (Array<map>)

          The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.

          • eventTyperequired — (String)

            The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected (DriftDetected) and Scheduled assessment failure (ScheduledAssessmentFailure) events.

            Possible values include:
            • "ScheduledAssessmentFailure"
            • "DriftDetected"
          • namerequired — (String)

            Unique name to identify an event subscription.

          • snsTopicArn — (String)

            Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: arn:partition:sns:region:account:topic-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • lastAppComplianceEvaluationTime — (Date)

          Date and time the most recent compliance evaluation.

        • lastDriftEvaluationTime — (Date)

          Indicates the last time that a drift was evaluated.

        • lastResiliencyScoreEvaluationTime — (Date)

          Date and time the most recent resiliency score evaluation.

        • namerequired — (String)

          Name for the application.

        • permissionModel — (map)

          Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.

          • crossAccountRoleArns — (Array<String>)

            Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.

            Note:
            • These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts.
            • These roles must have a trust policy with iam:AssumeRole permission to the invoker role in the primary account.
          • invokerRoleName — (String)

            Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.

            Note:
            • You must have iam:passRole permission for this role while creating or updating the application.
            • Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.
          • typerequired — (String)

            Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user.

            Possible values include:
            • "LegacyIAMUser"
            • "RoleBased"
        • policyArn — (String)

          Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • resiliencyScore — (Float)

          Current resiliency score for the application.

        • rpoInSecs — (Integer)

          Recovery Point Objective (RPO) in seconds.

        • rtoInSecs — (Integer)

          Recovery Time Objective (RTO) in seconds.

        • status — (String)

          Status of the application.

          Possible values include:
          • "Active"
          • "Deleting"
        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

Returns:

  • (AWS.Request)

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

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

Describes an assessment for an Resilience Hub application.

Service Reference:

Examples:

Calling the describeAppAssessment operation

var params = {
  assessmentArn: 'STRING_VALUE' /* required */
};
resiliencehub.describeAppAssessment(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: {})
    • assessmentArn — (String)

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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:

      • assessment — (map)

        The assessment for an Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.

        • appArn — (String)

          Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • appVersion — (String)

          Version of an application.

        • assessmentArnrequired — (String)

          Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • assessmentName — (String)

          Name of the assessment.

        • assessmentStatusrequired — (String)

          Current status of the assessment for the resiliency policy.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Success"
        • compliance — (map<map>)

          Application compliance against the resiliency policy.

          • achievableRpoInSecs — (Integer)

            The Recovery Point Objective (RPO) that is achievable, in seconds.

          • achievableRtoInSecs — (Integer)

            The Recovery Time Objective (RTO) that is achievable, in seconds

          • complianceStatusrequired — (String)

            The current status of compliance for the resiliency policy.

            Possible values include:
            • "PolicyBreached"
            • "PolicyMet"
          • currentRpoInSecs — (Integer)

            The current RPO, in seconds.

          • currentRtoInSecs — (Integer)

            The current RTO, in seconds.

          • message — (String)

            The disruption compliance message.

          • rpoDescription — (String)

            The RPO description.

          • rpoReferenceId — (String)

            Reference identifier of the RPO .

          • rtoDescription — (String)

            The RTO description.

          • rtoReferenceId — (String)

            Reference identifier of the RTO.

        • complianceStatus — (String)

          Current status of the compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
        • cost — (map)

          Cost for the application.

          • amountrequired — (Float)

            The cost amount.

          • currencyrequired — (String)

            The cost currency, for example USD.

          • frequencyrequired — (String)

            The cost frequency.

            Possible values include:
            • "Hourly"
            • "Daily"
            • "Monthly"
            • "Yearly"
        • driftStatus — (String)

          Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

          Possible values include:
          • "NotChecked"
          • "NotDetected"
          • "Detected"
        • endTime — (Date)

          End time for the action.

        • invokerrequired — (String)

          The entity that invoked the assessment.

          Possible values include:
          • "User"
          • "System"
        • message — (String)

          Error or warning message from the assessment execution

        • policy — (map)

          Resiliency policy of an application.

          • creationTime — (Date)

            Date and time when the resiliency policy was created.

          • dataLocationConstraint — (String)

            Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

            Possible values include:
            • "AnyLocation"
            • "SameContinent"
            • "SameCountry"
          • estimatedCostTier — (String)

            Specifies the estimated cost tier of the resiliency policy.

            Possible values include:
            • "L1"
            • "L2"
            • "L3"
            • "L4"
          • policy — (map<map>)

            The resiliency policy.

            • rpoInSecsrequired — (Integer)

              Recovery Point Objective (RPO) in seconds.

            • rtoInSecsrequired — (Integer)

              Recovery Time Objective (RTO) in seconds.

          • policyArn — (String)

            Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

          • policyDescription — (String)

            The description for the policy.

          • policyName — (String)

            The name of the policy

          • tags — (map<String>)

            Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

          • tier — (String)

            The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

            Possible values include:
            • "MissionCritical"
            • "Critical"
            • "Important"
            • "CoreServices"
            • "NonCritical"
            • "NotApplicable"
        • resiliencyScore — (map)

          Current resiliency score for an application.

          • componentScore — (map<map>)

            The score generated by Resilience Hub for the scoring component after running an assessment.

            For example, if the score is 25 points, it indicates the overall score of your application generated by Resilience Hub after running an assessment.

            • excludedCount — (Integer)

              Number of recommendations that were excluded from the assessment.

              For example, if the Excluded count for Resilience Hub recommended Amazon CloudWatch alarms is 7, it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment.

            • outstandingCount — (Integer)

              Number of issues that must be resolved to obtain the maximum possible score for the scoring component. For SOPs, alarms, and FIS experiments, these are the number of recommendations that must be implemented. For compliance, it is the number of Application Components that has breached the resiliency policy.

              For example, if the Outstanding count for Resilience Hub recommended Amazon CloudWatch alarms is 5, it indicates that 5 Amazon CloudWatch alarms must be fixed to achieve the maximum possible score.

            • possibleScore — (Float)

              Maximum possible score that can be obtained for the scoring component. If the Possible score is 20 points, it indicates the maximum possible score you can achieve for your application when you run a new assessment after implementing all the Resilience Hub recommendations.

            • score — (Float)

              Resiliency score of your application.

          • disruptionScorerequired — (map<Float>)

            The disruption score for a valid key.

          • scorerequired — (Float)

            The outage score for a valid key.

        • resourceErrorsDetails — (map)

          A resource error object containing a list of errors retrieving an application's resources.

          • hasMoreErrors — (Boolean)

            This indicates if there are more errors not listed in the resourceErrors list.

          • resourceErrors — (Array<map>)

            A list of errors retrieving an application's resources.

            • logicalResourceId — (String)

              Identifier of the logical resource.

            • physicalResourceId — (String)

              Identifier of the physical resource.

            • reason — (String)

              This is the error message.

        • startTime — (Date)

          Starting time for the action.

        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • versionName — (String)

          Version name of the published application.

Returns:

  • (AWS.Request)

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

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

Describes the Resilience Hub application version.

Service Reference:

Examples:

Calling the describeAppVersion operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE' /* required */
};
resiliencehub.describeAppVersion(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      Resilience Hub application version.

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:

      • additionalInfo — (map<Array<String>>)

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        Note: Currently, this parameter supports only failover region and account.
      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        Resilience Hub application version.

Returns:

  • (AWS.Request)

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

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

Describes an Application Component in the Resilience Hub application.

Service Reference:

Examples:

Calling the describeAppVersionAppComponent operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE' /* required */
};
resiliencehub.describeAppVersionAppComponent(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      Resilience Hub application version.

    • id — (String)

      Identifier of the Application Component.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appComponent — (map)

        List of Application Components that belong to this resource.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • id — (String)

          Identifier of the Application Component.

        • namerequired — (String)

          Name of the Application Component.

        • typerequired — (String)

          The type of Application Component.

      • appVersion — (String)

        Resilience Hub application version.

Returns:

  • (AWS.Request)

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

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

Describes a resource of the Resilience Hub application.

Note: This API accepts only one of the following parameters to descibe the resource:
  • resourceName
  • logicalResourceId
  • physicalResourceId (Along with physicalResourceId, you can also provide awsAccountId, and awsRegion)

Service Reference:

Examples:

Calling the describeAppVersionResource operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  awsAccountId: 'STRING_VALUE',
  awsRegion: 'STRING_VALUE',
  logicalResourceId: {
    identifier: 'STRING_VALUE', /* required */
    eksSourceName: 'STRING_VALUE',
    logicalStackName: 'STRING_VALUE',
    resourceGroupName: 'STRING_VALUE',
    terraformSourceName: 'STRING_VALUE'
  },
  physicalResourceId: 'STRING_VALUE',
  resourceName: 'STRING_VALUE'
};
resiliencehub.describeAppVersionResource(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      Resilience Hub application version.

    • awsAccountId — (String)

      Amazon Web Services account that owns the physical resource.

    • awsRegion — (String)

      Amazon Web Services region that owns the physical resource.

    • logicalResourceId — (map)

      Logical identifier of the resource.

      • eksSourceName — (String)

        Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

        Note: This parameter accepts values in "eks-cluster/namespace" format.
      • identifierrequired — (String)

        Identifier of the resource.

      • logicalStackName — (String)

        The name of the CloudFormation stack this resource belongs to.

      • resourceGroupName — (String)

        The name of the resource group that this resource belongs to.

      • terraformSourceName — (String)

        The name of the Terraform S3 state file this resource belongs to.

    • physicalResourceId — (String)

      Physical identifier of the resource.

    • resourceName — (String)

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

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        Resilience Hub application version.

      • physicalResource — (map)

        Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • appComponents — (Array<map>)

          The application components that belong to this resource.

          • additionalInfo — (map<Array<String>>)

            Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

            Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
          • id — (String)

            Identifier of the Application Component.

          • namerequired — (String)

            Name of the Application Component.

          • typerequired — (String)

            The type of Application Component.

        • excluded — (Boolean)

          Indicates if a resource is included or excluded from the assessment.

        • logicalResourceIdrequired — (map)

          Logical identifier of the resource.

          • eksSourceName — (String)

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            Note: This parameter accepts values in "eks-cluster/namespace" format.
          • identifierrequired — (String)

            Identifier of the resource.

          • logicalStackName — (String)

            The name of the CloudFormation stack this resource belongs to.

          • resourceGroupName — (String)

            The name of the resource group that this resource belongs to.

          • terraformSourceName — (String)

            The name of the Terraform S3 state file this resource belongs to.

        • parentResourceName — (String)

          Name of the parent resource.

        • physicalResourceIdrequired — (map)

          Identifier of the physical resource.

          • awsAccountId — (String)

            The Amazon Web Services account that owns the physical resource.

          • awsRegion — (String)

            The Amazon Web Services Region that the physical resource is located in.

          • identifierrequired — (String)

            Identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

            • AWS::ECS::Service

            • AWS::EFS::FileSystem

            • AWS::ElasticLoadBalancingV2::LoadBalancer

            • AWS::Lambda::Function

            • AWS::SNS::Topic

            Native

            The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

            • AWS::ApiGateway::RestApi

            • AWS::ApiGatewayV2::Api

            • AWS::AutoScaling::AutoScalingGroup

            • AWS::DocDB::DBCluster

            • AWS::DocDB::DBGlobalCluster

            • AWS::DocDB::DBInstance

            • AWS::DynamoDB::GlobalTable

            • AWS::DynamoDB::Table

            • AWS::EC2::EC2Fleet

            • AWS::EC2::Instance

            • AWS::EC2::NatGateway

            • AWS::EC2::Volume

            • AWS::ElasticLoadBalancing::LoadBalancer

            • AWS::RDS::DBCluster

            • AWS::RDS::DBInstance

            • AWS::RDS::GlobalCluster

            • AWS::Route53::RecordSet

            • AWS::S3::Bucket

            • AWS::SQS::Queue

            Possible values include:
            • "Arn"
            • "Native"
        • resourceName — (String)

          The name of the resource.

        • resourceTyperequired — (String)

          The type of resource.

        • sourceType — (String)

          Type of input source.

          Possible values include:
          • "AppTemplate"
          • "Discovered"

Returns:

  • (AWS.Request)

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

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

Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.

Examples:

Calling the describeAppVersionResourcesResolutionStatus operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  resolutionId: 'STRING_VALUE'
};
resiliencehub.describeAppVersionResourcesResolutionStatus(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      The version of the application.

    • resolutionId — (String)

      The identifier for a specific resolution.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        The version of the application.

      • errorMessage — (String)

        The returned error message for the request.

      • resolutionId — (String)

        The identifier for a specific resolution.

      • status — (String)

        Status of the action.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"

Returns:

  • (AWS.Request)

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

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

Describes details about an Resilience Hub application.

Service Reference:

Examples:

Calling the describeAppVersionTemplate operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE' /* required */
};
resiliencehub.describeAppVersionTemplate(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      The version of the application.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appTemplateBody — (String)

        A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.

        The appTemplateBody JSON string has the following structure:

        • resources

          The list of logical resources that must be included in the Resilience Hub application.

          Type: Array

          Note: Don't add the resources that you want to exclude.

          Each resources array item includes the following fields:

          • logicalResourceId

            Logical identifier of the resource.

            Type: Object

            Each logicalResourceId object includes the following fields:

            • identifier

              Identifier of the resource.

              Type: String

            • logicalStackName

              The name of the CloudFormation stack this resource belongs to.

              Type: String

            • resourceGroupName

              The name of the resource group this resource belongs to.

              Type: String

            • terraformSourceName

              The name of the Terraform S3 state file this resource belongs to.

              Type: String

            • eksSourceName

              Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

              Note: This parameter accepts values in "eks-cluster/namespace" format.

              Type: String

          • type

            The type of resource.

            Type: string

          • name

            The name of the resource.

            Type: String

          • additionalInfo

            Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

            Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • appComponents

          List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

          Type: Array

          Each appComponents array item includes the following fields:

          • name

            Name of the Application Component.

            Type: String

          • type

            Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

            Type: String

          • resourceNames

            The list of included resources that are assigned to the Application Component.

            Type: Array of strings

          • additionalInfo

            Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

            Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • excludedResources

          The list of logical resource identifiers to be excluded from the application.

          Type: Array

          Note: Don't add the resources that you want to include.

          Each excludedResources array item includes the following fields:

          • logicalResourceIds

            Logical identifier of the resource.

            Type: Object

            Note: You can configure only one of the following fields:
            • logicalStackName
            • resourceGroupName
            • terraformSourceName
            • eksSourceName

            Each logicalResourceIds object includes the following fields:

            • identifier

              Identifier of the resource.

              Type: String

            • logicalStackName

              The name of the CloudFormation stack this resource belongs to.

              Type: String

            • resourceGroupName

              The name of the resource group this resource belongs to.

              Type: String

            • terraformSourceName

              The name of the Terraform S3 state file this resource belongs to.

              Type: String

            • eksSourceName

              Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

              Note: This parameter accepts values in "eks-cluster/namespace" format.

              Type: String

        • version

          Resilience Hub application version.

        • additionalInfo

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
      • appVersion — (String)

        The version of the application.

Returns:

  • (AWS.Request)

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

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

Describes the status of importing resources to an application version.

Note: If you get a 404 error with ResourceImportStatusNotFoundAppMetadataException, you must call importResourcesToDraftAppVersion after creating the application and before calling describeDraftAppVersionResourcesImportStatus to obtain the status.

Examples:

Calling the describeDraftAppVersionResourcesImportStatus operation

var params = {
  appArn: 'STRING_VALUE' /* required */
};
resiliencehub.describeDraftAppVersionResourcesImportStatus(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        The version of the application.

      • errorMessage — (String)

        The returned error message for the request.

      • status — (String)

        Status of the action.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"
      • statusChangeTime — (Date)

        The time when the status last changed.

Returns:

  • (AWS.Request)

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

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

Describes a specified resiliency policy for an Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.

Service Reference:

Examples:

Calling the describeResiliencyPolicy operation

var params = {
  policyArn: 'STRING_VALUE' /* required */
};
resiliencehub.describeResiliencyPolicy(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: {})
    • policyArn — (String)

      Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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:

      • policy — (map)

        Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.

        • creationTime — (Date)

          Date and time when the resiliency policy was created.

        • dataLocationConstraint — (String)

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

          Possible values include:
          • "AnyLocation"
          • "SameContinent"
          • "SameCountry"
        • estimatedCostTier — (String)

          Specifies the estimated cost tier of the resiliency policy.

          Possible values include:
          • "L1"
          • "L2"
          • "L3"
          • "L4"
        • policy — (map<map>)

          The resiliency policy.

          • rpoInSecsrequired — (Integer)

            Recovery Point Objective (RPO) in seconds.

          • rtoInSecsrequired — (Integer)

            Recovery Time Objective (RTO) in seconds.

        • policyArn — (String)

          Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • tier — (String)

          The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

          Possible values include:
          • "MissionCritical"
          • "Critical"
          • "Important"
          • "CoreServices"
          • "NonCritical"
          • "NotApplicable"

Returns:

  • (AWS.Request)

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

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

Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.

Examples:

Calling the importResourcesToDraftAppVersion operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  eksSources: [
    {
      eksClusterArn: 'STRING_VALUE', /* required */
      namespaces: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  importStrategy: AddOnly | ReplaceAll,
  sourceArns: [
    'STRING_VALUE',
    /* more items */
  ],
  terraformSources: [
    {
      s3StateFileUrl: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
resiliencehub.importResourcesToDraftAppVersion(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • eksSources — (Array<map>)

      The input sources of the Amazon Elastic Kubernetes Service resources you need to import.

      • eksClusterArnrequired — (String)

        Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • namespacesrequired — (Array<String>)

        The list of namespaces located on your Amazon Elastic Kubernetes Service cluster.

    • importStrategy — (String)

      The import strategy you would like to set to import resources into Resilience Hub application.

      Possible values include:
      • "AddOnly"
      • "ReplaceAll"
    • sourceArns — (Array<String>)

      The Amazon Resource Names (ARNs) for the resources.

    • terraformSources — (Array<map>)

      A list of terraform file s3 URLs you need to import.

      • s3StateFileUrlrequired — (String)

        The URL of the Terraform s3 state file you need to import.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        The version of the application.

      • eksSources — (Array<map>)

        The input sources of the Amazon Elastic Kubernetes Service resources you have imported.

        • eksClusterArnrequired — (String)

          Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • namespacesrequired — (Array<String>)

          The list of namespaces located on your Amazon Elastic Kubernetes Service cluster.

      • sourceArns — (Array<String>)

        The Amazon Resource Names (ARNs) for the resources you have imported.

      • status — (String)

        Status of the action.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"
      • terraformSources — (Array<map>)

        A list of terraform file s3 URLs you have imported.

        • s3StateFileUrlrequired — (String)

          The URL of the Terraform s3 state file you need to import.

Returns:

  • (AWS.Request)

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

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

Lists the alarm recommendations for an Resilience Hub application.

Service Reference:

Examples:

Calling the listAlarmRecommendations operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAlarmRecommendations(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: {})
    • assessmentArn — (String)

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

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:

      • alarmRecommendations — (Array<map>)

        The alarm recommendations for an Resilience Hub application, returned as an object. This object includes Application Component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.

        • appComponentName — (String)

          Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the appComponentNames list.

        • appComponentNames — (Array<String>)

          List of Application Component names for the CloudWatch alarm recommendation.

        • description — (String)

          Description of the alarm recommendation.

        • items — (Array<map>)

          List of CloudWatch alarm recommendations.

          • alreadyImplemented — (Boolean)

            Specifies if the recommendation has already been implemented.

          • excludeReason — (String)

            Indicates the reason for excluding an operational recommendation.

            Possible values include:
            • "AlreadyImplemented"
            • "NotRelevant"
            • "ComplexityOfImplementation"
          • excluded — (Boolean)

            Indicates if an operational recommendation item is excluded.

          • resourceId — (String)

            Identifier of the resource.

          • targetAccountId — (String)

            Identifier of the target account.

          • targetRegion — (String)

            The target region.

        • namerequired — (String)

          Name of the alarm recommendation.

        • prerequisite — (String)

          The prerequisite for the alarm recommendation.

        • recommendationIdrequired — (String)

          Identifier of the alarm recommendation.

        • recommendationStatus — (String)

          Status of the recommended Amazon CloudWatch alarm.

          Possible values include:
          • "Implemented"
          • "Inactive"
          • "NotImplemented"
          • "Excluded"
        • referenceIdrequired — (String)

          Reference identifier of the alarm recommendation.

        • typerequired — (String)

          Type of alarm recommendation.

          Possible values include:
          • "Metric"
          • "Composite"
          • "Canary"
          • "Logs"
          • "Event"
      • nextToken — (String)

        Token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

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

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

List of compliance drifts that were detected while running an assessment.

Examples:

Calling the listAppAssessmentComplianceDrifts operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppAssessmentComplianceDrifts(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: {})
    • assessmentArn — (String)

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • maxResults — (Integer)

      Indicates the maximum number of applications requested.

    • nextToken — (String)

      Indicates the unique token number of the next application to be checked for compliance and regulatory requirements from the list of applications.

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:

      • complianceDrifts — (Array<map>)

        Indicates compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) detected for an assessed entity.

        • actualReferenceId — (String)

          Assessment identifier that is associated with this drift item.

        • actualValue — (map<map>)

          Actual compliance value of the entity.

          • achievableRpoInSecs — (Integer)

            The Recovery Point Objective (RPO) that is achievable, in seconds.

          • achievableRtoInSecs — (Integer)

            The Recovery Time Objective (RTO) that is achievable, in seconds

          • complianceStatusrequired — (String)

            The current status of compliance for the resiliency policy.

            Possible values include:
            • "PolicyBreached"
            • "PolicyMet"
          • currentRpoInSecs — (Integer)

            The current RPO, in seconds.

          • currentRtoInSecs — (Integer)

            The current RTO, in seconds.

          • message — (String)

            The disruption compliance message.

          • rpoDescription — (String)

            The RPO description.

          • rpoReferenceId — (String)

            Reference identifier of the RPO .

          • rtoDescription — (String)

            The RTO description.

          • rtoReferenceId — (String)

            Reference identifier of the RTO.

        • appId — (String)

          Identifier of your application.

        • appVersion — (String)

          Published version of your application on which drift was detected.

        • diffType — (String)

          Difference type between actual and expected recovery point objective (RPO) and recovery time objective (RTO) values. Currently, Resilience Hub supports only NotEqual difference type.

          Possible values include:
          • "NotEqual"
        • driftType — (String)

          The type of drift detected. Currently, Resilience Hub supports only ApplicationCompliance drift type.

          Possible values include:
          • "ApplicationCompliance"
        • entityId — (String)

          Identifier of an entity in which drift was detected. For compliance drift, the entity ID can be either application ID or the AppComponent ID.

        • entityType — (String)

          The type of entity in which drift was detected. For compliance drifts, Resilience Hub supports AWS::ResilienceHub::AppComponent and AWS::ResilienceHub::Application.

        • expectedReferenceId — (String)

          Assessment identifier of a previous assessment of the same application version. Resilience Hub uses the previous assessment (associated with the reference identifier) to compare the compliance with the current assessment to identify drifts.

        • expectedValue — (map<map>)

          The expected compliance value of an entity.

          • achievableRpoInSecs — (Integer)

            The Recovery Point Objective (RPO) that is achievable, in seconds.

          • achievableRtoInSecs — (Integer)

            The Recovery Time Objective (RTO) that is achievable, in seconds

          • complianceStatusrequired — (String)

            The current status of compliance for the resiliency policy.

            Possible values include:
            • "PolicyBreached"
            • "PolicyMet"
          • currentRpoInSecs — (Integer)

            The current RPO, in seconds.

          • currentRtoInSecs — (Integer)

            The current RTO, in seconds.

          • message — (String)

            The disruption compliance message.

          • rpoDescription — (String)

            The RPO description.

          • rpoReferenceId — (String)

            Reference identifier of the RPO .

          • rtoDescription — (String)

            The RTO description.

          • rtoReferenceId — (String)

            Reference identifier of the RTO.

      • nextToken — (String)

        Token number of the next application to be checked for compliance and regulatory requirements from the list of applications.

Returns:

  • (AWS.Request)

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

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

Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.

Service Reference:

Examples:

Calling the listAppAssessments operation

var params = {
  appArn: 'STRING_VALUE',
  assessmentName: 'STRING_VALUE',
  assessmentStatus: [
    Pending | InProgress | Failed | Success,
    /* more items */
  ],
  complianceStatus: PolicyBreached | PolicyMet,
  invoker: User | System,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  reverseOrder: true || false
};
resiliencehub.listAppAssessments(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • assessmentName — (String)

      The name for the assessment.

    • assessmentStatus — (Array<String>)

      The current status of the assessment for the resiliency policy.

    • complianceStatus — (String)

      The current status of compliance for the resiliency policy.

      Possible values include:
      • "PolicyBreached"
      • "PolicyMet"
    • invoker — (String)

      Specifies the entity that invoked a specific assessment, either a User or the System.

      Possible values include:
      • "User"
      • "System"
    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

    • reverseOrder — (Boolean)

      The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

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:

      • assessmentSummaries — (Array<map>)

        The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.

        • appArn — (String)

          Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • appVersion — (String)

          Version of an application.

        • assessmentArnrequired — (String)

          Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • assessmentName — (String)

          Name of the assessment.

        • assessmentStatusrequired — (String)

          Current status of the assessment for the resiliency policy.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Success"
        • complianceStatus — (String)

          TCurrent status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
        • cost — (map)

          Cost for an application.

          • amountrequired — (Float)

            The cost amount.

          • currencyrequired — (String)

            The cost currency, for example USD.

          • frequencyrequired — (String)

            The cost frequency.

            Possible values include:
            • "Hourly"
            • "Daily"
            • "Monthly"
            • "Yearly"
        • driftStatus — (String)

          Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

          Possible values include:
          • "NotChecked"
          • "NotDetected"
          • "Detected"
        • endTime — (Date)

          End time for the action.

        • invoker — (String)

          Entity that invoked the assessment.

          Possible values include:
          • "User"
          • "System"
        • message — (String)

          Message from the assessment run.

        • resiliencyScore — (Float)

          Current resiliency score for the application.

        • startTime — (Date)

          Starting time for the action.

        • versionName — (String)

          Name of an application version.

      • nextToken — (String)

        Token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

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

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

Lists the compliances for an Resilience Hub Application Component.

Service Reference:

Examples:

Calling the listAppComponentCompliances operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppComponentCompliances(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: {})
    • assessmentArn — (String)

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

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:

      • componentCompliances — (Array<map>)

        The compliances for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and more.

        • appComponentName — (String)

          Name of the Application Component.

        • compliance — (map<map>)

          The compliance of the Application Component against the resiliency policy.

          • achievableRpoInSecs — (Integer)

            The Recovery Point Objective (RPO) that is achievable, in seconds.

          • achievableRtoInSecs — (Integer)

            The Recovery Time Objective (RTO) that is achievable, in seconds

          • complianceStatusrequired — (String)

            The current status of compliance for the resiliency policy.

            Possible values include:
            • "PolicyBreached"
            • "PolicyMet"
          • currentRpoInSecs — (Integer)

            The current RPO, in seconds.

          • currentRtoInSecs — (Integer)

            The current RTO, in seconds.

          • message — (String)

            The disruption compliance message.

          • rpoDescription — (String)

            The RPO description.

          • rpoReferenceId — (String)

            Reference identifier of the RPO .

          • rtoDescription — (String)

            The RTO description.

          • rtoReferenceId — (String)

            Reference identifier of the RTO.

        • cost — (map)

          The cost for the application.

          • amountrequired — (Float)

            The cost amount.

          • currencyrequired — (String)

            The cost currency, for example USD.

          • frequencyrequired — (String)

            The cost frequency.

            Possible values include:
            • "Hourly"
            • "Daily"
            • "Monthly"
            • "Yearly"
        • message — (String)

          The compliance message.

        • resiliencyScore — (map)

          The current resiliency score for the application.

          • componentScore — (map<map>)

            The score generated by Resilience Hub for the scoring component after running an assessment.

            For example, if the score is 25 points, it indicates the overall score of your application generated by Resilience Hub after running an assessment.

            • excludedCount — (Integer)

              Number of recommendations that were excluded from the assessment.

              For example, if the Excluded count for Resilience Hub recommended Amazon CloudWatch alarms is 7, it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment.

            • outstandingCount — (Integer)

              Number of issues that must be resolved to obtain the maximum possible score for the scoring component. For SOPs, alarms, and FIS experiments, these are the number of recommendations that must be implemented. For compliance, it is the number of Application Components that has breached the resiliency policy.

              For example, if the Outstanding count for Resilience Hub recommended Amazon CloudWatch alarms is 5, it indicates that 5 Amazon CloudWatch alarms must be fixed to achieve the maximum possible score.

            • possibleScore — (Float)

              Maximum possible score that can be obtained for the scoring component. If the Possible score is 20 points, it indicates the maximum possible score you can achieve for your application when you run a new assessment after implementing all the Resilience Hub recommendations.

            • score — (Float)

              Resiliency score of your application.

          • disruptionScorerequired — (map<Float>)

            The disruption score for a valid key.

          • scorerequired — (Float)

            The outage score for a valid key.

        • status — (String)

          Status of the action.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
      • nextToken — (String)

        Token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

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

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

Lists the recommendations for an Resilience Hub Application Component.

Service Reference:

Examples:

Calling the listAppComponentRecommendations operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppComponentRecommendations(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: {})
    • assessmentArn — (String)

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

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:

      • componentRecommendations — (Array<map>)

        The recommendations for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, configuration recommendations, and recommendation statuses.

        • appComponentNamerequired — (String)

          Name of the Application Component.

        • configRecommendationsrequired — (Array<map>)

          List of recommendations.

          • appComponentName — (String)

            Name of the Application Component.

          • compliance — (map<map>)

            The current compliance against the resiliency policy before applying the configuration change.

            • achievableRpoInSecs — (Integer)

              The Recovery Point Objective (RPO) that is achievable, in seconds.

            • achievableRtoInSecs — (Integer)

              The Recovery Time Objective (RTO) that is achievable, in seconds

            • complianceStatusrequired — (String)

              The current status of compliance for the resiliency policy.

              Possible values include:
              • "PolicyBreached"
              • "PolicyMet"
            • currentRpoInSecs — (Integer)

              The current RPO, in seconds.

            • currentRtoInSecs — (Integer)

              The current RTO, in seconds.

            • message — (String)

              The disruption compliance message.

            • rpoDescription — (String)

              The RPO description.

            • rpoReferenceId — (String)

              Reference identifier of the RPO .

            • rtoDescription — (String)

              The RTO description.

            • rtoReferenceId — (String)

              Reference identifier of the RTO.

          • cost — (map)

            The cost for the application.

            • amountrequired — (Float)

              The cost amount.

            • currencyrequired — (String)

              The cost currency, for example USD.

            • frequencyrequired — (String)

              The cost frequency.

              Possible values include:
              • "Hourly"
              • "Daily"
              • "Monthly"
              • "Yearly"
          • description — (String)

            The optional description for an app.

          • haArchitecture — (String)

            The architecture type.

            Possible values include:
            • "MultiSite"
            • "WarmStandby"
            • "PilotLight"
            • "BackupAndRestore"
            • "NoRecoveryPlan"
          • namerequired — (String)

            The name of the recommendation configuration.

          • optimizationTyperequired — (String)

            The type of optimization.

            Possible values include:
            • "LeastCost"
            • "LeastChange"
            • "BestAZRecovery"
            • "LeastErrors"
            • "BestAttainable"
            • "BestRegionRecovery"
          • recommendationCompliance — (map<map>)

            The expected compliance against the resiliency policy after applying the configuration change.

            • expectedComplianceStatusrequired — (String)

              The expected compliance status after applying the recommended configuration change.

              Possible values include:
              • "PolicyBreached"
              • "PolicyMet"
            • expectedRpoDescription — (String)

              The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.

            • expectedRpoInSecs — (Integer)

              The expected RPO after applying the recommended configuration change.

            • expectedRtoDescription — (String)

              The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.

            • expectedRtoInSecs — (Integer)

              The expected RTO after applying the recommended configuration change.

          • referenceIdrequired — (String)

            Reference identifier for the recommendation configuration.

          • suggestedChanges — (Array<String>)

            List of the suggested configuration changes.

        • recommendationStatusrequired — (String)

          Status of the recommendation.

          Possible values include:
          • "BreachedUnattainable"
          • "BreachedCanMeet"
          • "MetCanImprove"
      • nextToken — (String)

        Token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

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

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

Lists all the input sources of the Resilience Hub application. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.

Service Reference:

Examples:

Calling the listAppInputSources operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppInputSources(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      Resilience Hub application version.

    • maxResults — (Integer)

      Maximum number of input sources to be displayed per Resilience Hub application.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

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:

      • appInputSources — (Array<map>)

        The list of Resilience Hub application input sources.

        • eksSourceClusterNamespace — (map)

          The namespace on your Amazon Elastic Kubernetes Service cluster.

          • eksClusterArnrequired — (String)

            Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

          • namespacerequired — (String)

            Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.

        • importTyperequired — (String)

          The resource type of the input source.

          Possible values include:
          • "CfnStack"
          • "Resource"
          • "AppRegistryApp"
          • "ResourceGroup"
          • "Terraform"
          • "EKS"
        • resourceCount — (Integer)

          The number of resources.

        • sourceArn — (String)

          The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • sourceName — (String)

          The name of the input source.

        • terraformSource — (map)

          The name of the Terraform s3 state file.

          • s3StateFileUrlrequired — (String)

            The URL of the Terraform s3 state file you need to import.

      • nextToken — (String)

        Token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

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

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

Lists your Resilience Hub applications.

Note: You can filter applications using only one filter at a time or without using any filter. If you try to filter applications using multiple filters, you will get the following error: An error occurred (ValidationException) when calling the ListApps operation: Only one filter is supported for this operation.

Service Reference:

Examples:

Calling the listApps operation

var params = {
  appArn: 'STRING_VALUE',
  fromLastAssessmentTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  reverseOrder: true || false,
  toLastAssessmentTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
resiliencehub.listApps(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • fromLastAssessmentTime — (Date)

      Indicates the lower limit of the range that is used to filter applications based on their last assessment times.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • name — (String)

      The name for the one of the listed applications.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

    • reverseOrder — (Boolean)

      The application list is sorted based on the values of lastAppComplianceEvaluationTime field. By default, application list is sorted in ascending order. To sort the appliation list in descending order, set this field to True.

    • toLastAssessmentTime — (Date)

      Indicates the upper limit of the range that is used to filter the applications based on their last assessment times.

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:

      • appSummaries — (Array<map>)

        Summaries for the Resilience Hub application.

        • appArnrequired — (String)

          Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • assessmentSchedule — (String)

          Assessment execution schedule with 'Daily' or 'Disabled' values.

          Possible values include:
          • "Disabled"
          • "Daily"
        • complianceStatus — (String)

          The current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotAssessed"
          • "ChangesDetected"
        • creationTimerequired — (Date)

          Date and time when the app was created.

        • description — (String)

          The optional description for an app.

        • driftStatus — (String)

          Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

          Possible values include:
          • "NotChecked"
          • "NotDetected"
          • "Detected"
        • lastAppComplianceEvaluationTime — (Date)

          Date and time of the most recent compliance evaluation.

        • namerequired — (String)

          The name of the application.

        • resiliencyScore — (Float)

          The current resiliency score for the application.

        • rpoInSecs — (Integer)

          Recovery Point Objective (RPO) in seconds.

        • rtoInSecs — (Integer)

          Recovery Time Objective (RTO) in seconds.

        • status — (String)

          Status of the application.

          Possible values include:
          • "Active"
          • "Deleting"
      • nextToken — (String)

        Token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

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

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

Lists all the Application Components in the Resilience Hub application.

Service Reference:

Examples:

Calling the listAppVersionAppComponents operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppVersionAppComponents(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      Version of the Application Component.

    • maxResults — (Integer)

      Maximum number of Application Components to be displayed per Resilience Hub application version.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appComponents — (Array<map>)

        Defines an Application Component.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • id — (String)

          Identifier of the Application Component.

        • namerequired — (String)

          Name of the Application Component.

        • typerequired — (String)

          The type of Application Component.

      • appVersion — (String)

        Resilience Hub application version.

      • nextToken — (String)

        Token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

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

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

Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app.

Service Reference:

Examples:

Calling the listAppVersionResourceMappings operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppVersionResourceMappings(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      The version of the application.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

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)

        Token for the next set of results, or null if there are no more results.

      • resourceMappings — (Array<map>)

        Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

        • appRegistryAppName — (String)

          The name of the application this resource is mapped to.

        • eksSourceName — (String)

          Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          Note: This parameter accepts values in "eks-cluster/namespace" format.
        • logicalStackName — (String)

          The name of the CloudFormation stack this resource is mapped to.

        • mappingTyperequired — (String)

          Specifies the type of resource mapping.

          AppRegistryApp

          The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.

          CfnStack

          The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.

          Resource

          The resource is mapped to another resource. The name of the resource is contained in the resourceName property.

          ResourceGroup

          The resource is mapped to Resource Groups. The name of the resource group is contained in the resourceGroupName property.

          Possible values include:
          • "CfnStack"
          • "Resource"
          • "AppRegistryApp"
          • "ResourceGroup"
          • "Terraform"
          • "EKS"
        • physicalResourceIdrequired — (map)

          Identifier of the physical resource.

          • awsAccountId — (String)

            The Amazon Web Services account that owns the physical resource.

          • awsRegion — (String)

            The Amazon Web Services Region that the physical resource is located in.

          • identifierrequired — (String)

            Identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

            • AWS::ECS::Service

            • AWS::EFS::FileSystem

            • AWS::ElasticLoadBalancingV2::LoadBalancer

            • AWS::Lambda::Function

            • AWS::SNS::Topic

            Native

            The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

            • AWS::ApiGateway::RestApi

            • AWS::ApiGatewayV2::Api

            • AWS::AutoScaling::AutoScalingGroup

            • AWS::DocDB::DBCluster

            • AWS::DocDB::DBGlobalCluster

            • AWS::DocDB::DBInstance

            • AWS::DynamoDB::GlobalTable

            • AWS::DynamoDB::Table

            • AWS::EC2::EC2Fleet

            • AWS::EC2::Instance

            • AWS::EC2::NatGateway

            • AWS::EC2::Volume

            • AWS::ElasticLoadBalancing::LoadBalancer

            • AWS::RDS::DBCluster

            • AWS::RDS::DBInstance

            • AWS::RDS::GlobalCluster

            • AWS::Route53::RecordSet

            • AWS::S3::Bucket

            • AWS::SQS::Queue

            Possible values include:
            • "Arn"
            • "Native"
        • resourceGroupName — (String)

          Name of the resource group that the resource is mapped to.

        • resourceName — (String)

          Name of the resource that the resource is mapped to.

        • terraformSourceName — (String)

          The short name of the Terraform source.

Returns:

  • (AWS.Request)

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

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

Lists all the resources in an Resilience Hub application.

Service Reference:

Examples:

Calling the listAppVersionResources operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resolutionId: 'STRING_VALUE'
};
resiliencehub.listAppVersionResources(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      The version of the application.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

    • resolutionId — (String)

      The identifier for a specific resolution.

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)

        Token for the next set of results, or null if there are no more results.

      • physicalResources — (Array<map>)

        The physical resources in the application version.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • appComponents — (Array<map>)

          The application components that belong to this resource.

          • additionalInfo — (map<Array<String>>)

            Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

            Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
          • id — (String)

            Identifier of the Application Component.

          • namerequired — (String)

            Name of the Application Component.

          • typerequired — (String)

            The type of Application Component.

        • excluded — (Boolean)

          Indicates if a resource is included or excluded from the assessment.

        • logicalResourceIdrequired — (map)

          Logical identifier of the resource.

          • eksSourceName — (String)

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            Note: This parameter accepts values in "eks-cluster/namespace" format.
          • identifierrequired — (String)

            Identifier of the resource.

          • logicalStackName — (String)

            The name of the CloudFormation stack this resource belongs to.

          • resourceGroupName — (String)

            The name of the resource group that this resource belongs to.

          • terraformSourceName — (String)

            The name of the Terraform S3 state file this resource belongs to.

        • parentResourceName — (String)

          Name of the parent resource.

        • physicalResourceIdrequired — (map)

          Identifier of the physical resource.

          • awsAccountId — (String)

            The Amazon Web Services account that owns the physical resource.

          • awsRegion — (String)

            The Amazon Web Services Region that the physical resource is located in.

          • identifierrequired — (String)

            Identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

            • AWS::ECS::Service

            • AWS::EFS::FileSystem

            • AWS::ElasticLoadBalancingV2::LoadBalancer

            • AWS::Lambda::Function

            • AWS::SNS::Topic

            Native

            The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

            • AWS::ApiGateway::RestApi

            • AWS::ApiGatewayV2::Api

            • AWS::AutoScaling::AutoScalingGroup

            • AWS::DocDB::DBCluster

            • AWS::DocDB::DBGlobalCluster

            • AWS::DocDB::DBInstance

            • AWS::DynamoDB::GlobalTable

            • AWS::DynamoDB::Table

            • AWS::EC2::EC2Fleet

            • AWS::EC2::Instance

            • AWS::EC2::NatGateway

            • AWS::EC2::Volume

            • AWS::ElasticLoadBalancing::LoadBalancer

            • AWS::RDS::DBCluster

            • AWS::RDS::DBInstance

            • AWS::RDS::GlobalCluster

            • AWS::Route53::RecordSet

            • AWS::S3::Bucket

            • AWS::SQS::Queue

            Possible values include:
            • "Arn"
            • "Native"
        • resourceName — (String)

          The name of the resource.

        • resourceTyperequired — (String)

          The type of resource.

        • sourceType — (String)

          Type of input source.

          Possible values include:
          • "AppTemplate"
          • "Discovered"
      • resolutionId — (String)

        The ID for a specific resolution.

Returns:

  • (AWS.Request)

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

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

Lists the different versions for the Resilience Hub applications.

Service Reference:

Examples:

Calling the listAppVersions operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
resiliencehub.listAppVersions(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • endTime — (Date)

      Upper limit of the time range to filter the application versions.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

    • startTime — (Date)

      Lower limit of the time range to filter the application versions.

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:

      • appVersions — (Array<map>)

        The version of the application.

        • appVersionrequired — (String)

          Version of an application.

        • creationTime — (Date)

          Creation time of the application version.

        • identifier — (Integer)

          Identifier of the application version.

        • versionName — (String)

          Name of the application version.

      • nextToken — (String)

        Token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

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

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

Lists the recommendation templates for the Resilience Hub applications.

Service Reference:

Examples:

Calling the listRecommendationTemplates operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  recommendationTemplateArn: 'STRING_VALUE',
  reverseOrder: true || false,
  status: [
    Pending | InProgress | Failed | Success,
    /* more items */
  ]
};
resiliencehub.listRecommendationTemplates(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: {})
    • assessmentArn — (String)

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • name — (String)

      The name for one of the listed recommendation templates.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

    • recommendationTemplateArn — (String)

      The Amazon Resource Name (ARN) for a recommendation template.

    • reverseOrder — (Boolean)

      The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

    • status — (Array<String>)

      Status of the action.

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)

        Token for the next set of results, or null if there are no more results.

      • recommendationTemplates — (Array<map>)

        The recommendation templates for the Resilience Hub applications.

        • appArn — (String)

          Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • assessmentArnrequired — (String)

          Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • endTime — (Date)

          The end time for the action.

        • formatrequired — (String)

          Format of the recommendation template.

          CfnJson

          The template is CloudFormation JSON.

          CfnYaml

          The template is CloudFormation YAML.

          Possible values include:
          • "CfnYaml"
          • "CfnJson"
        • message — (String)

          Message for the recommendation template.

        • namerequired — (String)

          Name for the recommendation template.

        • needsReplacements — (Boolean)

          Indicates if replacements are needed.

        • recommendationIds — (Array<String>)

          Identifiers for the recommendations used in the recommendation template.

        • recommendationTemplateArnrequired — (String)

          Amazon Resource Name (ARN) for the recommendation template.

        • recommendationTypesrequired — (Array<String>)

          An array of strings that specify the recommendation template type or types.

          Alarm

          The template is an AlarmRecommendation template.

          Sop

          The template is a SopRecommendation template.

          Test

          The template is a TestRecommendation template.

        • startTime — (Date)

          The start time for the action.

        • statusrequired — (String)

          Status of the action.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Success"
        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • templatesLocation — (map)

          The file location of the template.

          • bucket — (String)

            The name of the Amazon S3 bucket.

          • prefix — (String)

            The prefix for the Amazon S3 bucket.

Returns:

  • (AWS.Request)

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

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

Lists the resiliency policies for the Resilience Hub applications.

Service Reference:

Examples:

Calling the listResiliencyPolicies operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  policyName: 'STRING_VALUE'
};
resiliencehub.listResiliencyPolicies(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)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

    • policyName — (String)

      The name of the policy

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)

        Token for the next set of results, or null if there are no more results.

      • resiliencyPolicies — (Array<map>)

        The resiliency policies for the Resilience Hub applications.

        • creationTime — (Date)

          Date and time when the resiliency policy was created.

        • dataLocationConstraint — (String)

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

          Possible values include:
          • "AnyLocation"
          • "SameContinent"
          • "SameCountry"
        • estimatedCostTier — (String)

          Specifies the estimated cost tier of the resiliency policy.

          Possible values include:
          • "L1"
          • "L2"
          • "L3"
          • "L4"
        • policy — (map<map>)

          The resiliency policy.

          • rpoInSecsrequired — (Integer)

            Recovery Point Objective (RPO) in seconds.

          • rtoInSecsrequired — (Integer)

            Recovery Time Objective (RTO) in seconds.

        • policyArn — (String)

          Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • tier — (String)

          The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

          Possible values include:
          • "MissionCritical"
          • "Critical"
          • "Important"
          • "CoreServices"
          • "NonCritical"
          • "NotApplicable"

Returns:

  • (AWS.Request)

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

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

Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.

Service Reference:

Examples:

Calling the listSopRecommendations operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listSopRecommendations(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: {})
    • assessmentArn — (String)

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

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)

        Token for the next set of results, or null if there are no more results.

      • sopRecommendations — (Array<map>)

        The standard operating procedure (SOP) recommendations for the Resilience Hub applications.

        • appComponentName — (String)

          Name of the Application Component.

        • description — (String)

          Description of the SOP recommendation.

        • items — (Array<map>)

          The recommendation items.

          • alreadyImplemented — (Boolean)

            Specifies if the recommendation has already been implemented.

          • excludeReason — (String)

            Indicates the reason for excluding an operational recommendation.

            Possible values include:
            • "AlreadyImplemented"
            • "NotRelevant"
            • "ComplexityOfImplementation"
          • excluded — (Boolean)

            Indicates if an operational recommendation item is excluded.

          • resourceId — (String)

            Identifier of the resource.

          • targetAccountId — (String)

            Identifier of the target account.

          • targetRegion — (String)

            The target region.

        • name — (String)

          Name of the SOP recommendation.

        • prerequisite — (String)

          Prerequisite for the SOP recommendation.

        • recommendationIdrequired — (String)

          Identifier for the SOP recommendation.

        • recommendationStatus — (String)

          Status of the recommended standard operating procedure.

          Possible values include:
          • "Implemented"
          • "Inactive"
          • "NotImplemented"
          • "Excluded"
        • referenceIdrequired — (String)

          Reference identifier for the SOP recommendation.

        • serviceTyperequired — (String)

          The service type.

          Possible values include:
          • "SSM"

Returns:

  • (AWS.Request)

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

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

Lists the suggested resiliency policies for the Resilience Hub applications.

Service Reference:

Examples:

Calling the listSuggestedResiliencyPolicies operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listSuggestedResiliencyPolicies(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)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

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)

        Token for the next set of results, or null if there are no more results.

      • resiliencyPolicies — (Array<map>)

        The suggested resiliency policies for the Resilience Hub applications.

        • creationTime — (Date)

          Date and time when the resiliency policy was created.

        • dataLocationConstraint — (String)

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

          Possible values include:
          • "AnyLocation"
          • "SameContinent"
          • "SameCountry"
        • estimatedCostTier — (String)

          Specifies the estimated cost tier of the resiliency policy.

          Possible values include:
          • "L1"
          • "L2"
          • "L3"
          • "L4"
        • policy — (map<map>)

          The resiliency policy.

          • rpoInSecsrequired — (Integer)

            Recovery Point Objective (RPO) in seconds.

          • rtoInSecsrequired — (Integer)

            Recovery Time Objective (RTO) in seconds.

        • policyArn — (String)

          Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • tier — (String)

          The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

          Possible values include:
          • "MissionCritical"
          • "Critical"
          • "Important"
          • "CoreServices"
          • "NonCritical"
          • "NotApplicable"

Returns:

  • (AWS.Request)

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

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

Lists the tags for your resources in your Resilience Hub applications.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application.

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

        Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

Returns:

  • (AWS.Request)

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

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

Lists the test recommendations for the Resilience Hub application.

Service Reference:

Examples:

Calling the listTestRecommendations operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listTestRecommendations(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: {})
    • assessmentArn — (String)

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

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)

        Token for the next set of results, or null if there are no more results.

      • testRecommendations — (Array<map>)

        The test recommendations for the Resilience Hub application.

        • appComponentName — (String)

          Name of the Application Component.

        • dependsOnAlarms — (Array<String>)

          A list of recommended alarms that are used in the test and must be exported before or with the test.

        • description — (String)

          Description for the test recommendation.

        • intent — (String)

          Intent of the test recommendation.

        • items — (Array<map>)

          The test recommendation items.

          • alreadyImplemented — (Boolean)

            Specifies if the recommendation has already been implemented.

          • excludeReason — (String)

            Indicates the reason for excluding an operational recommendation.

            Possible values include:
            • "AlreadyImplemented"
            • "NotRelevant"
            • "ComplexityOfImplementation"
          • excluded — (Boolean)

            Indicates if an operational recommendation item is excluded.

          • resourceId — (String)

            Identifier of the resource.

          • targetAccountId — (String)

            Identifier of the target account.

          • targetRegion — (String)

            The target region.

        • name — (String)

          Name of the test recommendation.

        • prerequisite — (String)

          Prerequisite of the test recommendation.

        • recommendationId — (String)

          Identifier for the test recommendation.

        • recommendationStatus — (String)

          Status of the recommended test.

          Possible values include:
          • "Implemented"
          • "Inactive"
          • "NotImplemented"
          • "Excluded"
        • referenceIdrequired — (String)

          Reference identifier for the test recommendation.

        • risk — (String)

          Level of risk for this test recommendation.

          Possible values include:
          • "Small"
          • "Medium"
          • "High"
        • type — (String)

          Type of test recommendation.

          Possible values include:
          • "Software"
          • "Hardware"
          • "AZ"
          • "Region"

Returns:

  • (AWS.Request)

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

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

Lists the resources that are not currently supported in Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by Resilience Hub.

Examples:

Calling the listUnsupportedAppVersionResources operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resolutionId: 'STRING_VALUE'
};
resiliencehub.listUnsupportedAppVersionResources(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      The version of the application.

    • maxResults — (Integer)

      Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • nextToken — (String)

      Null, or the token from a previous call to get the next set of results.

    • resolutionId — (String)

      The identifier for a specific resolution.

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)

        Token for the next set of results, or null if there are no more results.

      • resolutionId — (String)

        The identifier for a specific resolution.

      • unsupportedResources — (Array<map>)

        The unsupported resources for the application.

        • logicalResourceIdrequired — (map)

          Logical resource identifier for the unsupported resource.

          • eksSourceName — (String)

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            Note: This parameter accepts values in "eks-cluster/namespace" format.
          • identifierrequired — (String)

            Identifier of the resource.

          • logicalStackName — (String)

            The name of the CloudFormation stack this resource belongs to.

          • resourceGroupName — (String)

            The name of the resource group that this resource belongs to.

          • terraformSourceName — (String)

            The name of the Terraform S3 state file this resource belongs to.

        • physicalResourceIdrequired — (map)

          Physical resource identifier for the unsupported resource.

          • awsAccountId — (String)

            The Amazon Web Services account that owns the physical resource.

          • awsRegion — (String)

            The Amazon Web Services Region that the physical resource is located in.

          • identifierrequired — (String)

            Identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

            • AWS::ECS::Service

            • AWS::EFS::FileSystem

            • AWS::ElasticLoadBalancingV2::LoadBalancer

            • AWS::Lambda::Function

            • AWS::SNS::Topic

            Native

            The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

            • AWS::ApiGateway::RestApi

            • AWS::ApiGatewayV2::Api

            • AWS::AutoScaling::AutoScalingGroup

            • AWS::DocDB::DBCluster

            • AWS::DocDB::DBGlobalCluster

            • AWS::DocDB::DBInstance

            • AWS::DynamoDB::GlobalTable

            • AWS::DynamoDB::Table

            • AWS::EC2::EC2Fleet

            • AWS::EC2::Instance

            • AWS::EC2::NatGateway

            • AWS::EC2::Volume

            • AWS::ElasticLoadBalancing::LoadBalancer

            • AWS::RDS::DBCluster

            • AWS::RDS::DBInstance

            • AWS::RDS::GlobalCluster

            • AWS::Route53::RecordSet

            • AWS::S3::Bucket

            • AWS::SQS::Queue

            Possible values include:
            • "Arn"
            • "Native"
        • resourceTyperequired — (String)

          The type of resource.

        • unsupportedResourceStatus — (String)

          The status of the unsupported resource.

Returns:

  • (AWS.Request)

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

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

Publishes a new version of a specific Resilience Hub application.

Service Reference:

Examples:

Calling the publishAppVersion operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  versionName: 'STRING_VALUE'
};
resiliencehub.publishAppVersion(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • versionName — (String)

      Name of the application version.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        The version of the application.

      • identifier — (Integer)

        Identifier of the application version.

      • versionName — (String)

        Name of the application version.

Returns:

  • (AWS.Request)

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

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

Adds or updates the app template for an Resilience Hub application draft version.

Service Reference:

Examples:

Calling the putDraftAppVersionTemplate operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appTemplateBody: 'STRING_VALUE' /* required */
};
resiliencehub.putDraftAppVersionTemplate(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appTemplateBody — (String)

      A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.

      The appTemplateBody JSON string has the following structure:

      • resources

        The list of logical resources that must be included in the Resilience Hub application.

        Type: Array

        Note: Don't add the resources that you want to exclude.

        Each resources array item includes the following fields:

        • logicalResourceId

          Logical identifier of the resource.

          Type: Object

          Each logicalResourceId object includes the following fields:

          • identifier

            Identifier of the resource.

            Type: String

          • logicalStackName

            The name of the CloudFormation stack this resource belongs to.

            Type: String

          • resourceGroupName

            The name of the resource group this resource belongs to.

            Type: String

          • terraformSourceName

            The name of the Terraform S3 state file this resource belongs to.

            Type: String

          • eksSourceName

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            Note: This parameter accepts values in "eks-cluster/namespace" format.

            Type: String

        • type

          The type of resource.

          Type: string

        • name

          The name of the resource.

          Type: String

        • additionalInfo

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
      • appComponents

        List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

        Type: Array

        Each appComponents array item includes the following fields:

        • name

          Name of the Application Component.

          Type: String

        • type

          Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

          Type: String

        • resourceNames

          The list of included resources that are assigned to the Application Component.

          Type: Array of strings

        • additionalInfo

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
      • excludedResources

        The list of logical resource identifiers to be excluded from the application.

        Type: Array

        Note: Don't add the resources that you want to include.

        Each excludedResources array item includes the following fields:

        • logicalResourceIds

          Logical identifier of the resource.

          Type: Object

          Note: You can configure only one of the following fields:
          • logicalStackName
          • resourceGroupName
          • terraformSourceName
          • eksSourceName

          Each logicalResourceIds object includes the following fields:

          • identifier

            Identifier of the resource.

            Type: String

          • logicalStackName

            The name of the CloudFormation stack this resource belongs to.

            Type: String

          • resourceGroupName

            The name of the resource group this resource belongs to.

            Type: String

          • terraformSourceName

            The name of the Terraform S3 state file this resource belongs to.

            Type: String

          • eksSourceName

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            Note: This parameter accepts values in "eks-cluster/namespace" format.

            Type: String

      • version

        Resilience Hub application version.

      • additionalInfo

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        The version of the application.

Returns:

  • (AWS.Request)

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

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

Removes resource mappings from a draft application version.

Examples:

Calling the removeDraftAppVersionResourceMappings operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appRegistryAppNames: [
    'STRING_VALUE',
    /* more items */
  ],
  eksSourceNames: [
    'STRING_VALUE',
    /* more items */
  ],
  logicalStackNames: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceGroupNames: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceNames: [
    'STRING_VALUE',
    /* more items */
  ],
  terraformSourceNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
resiliencehub.removeDraftAppVersionResourceMappings(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appRegistryAppNames — (Array<String>)

      The names of the registered applications you want to remove from the resource mappings.

    • eksSourceNames — (Array<String>)

      The names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from the resource mappings.

      Note: This parameter accepts values in "eks-cluster/namespace" format.
    • logicalStackNames — (Array<String>)

      The names of the CloudFormation stacks you want to remove from the resource mappings.

    • resourceGroupNames — (Array<String>)

      The names of the resource groups you want to remove from the resource mappings.

    • resourceNames — (Array<String>)

      The names of the resources you want to remove from the resource mappings.

    • terraformSourceNames — (Array<String>)

      The names of the Terraform sources you want to remove from the resource mappings.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        The version of the application.

Returns:

  • (AWS.Request)

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

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

Resolves the resources for an application version.

Service Reference:

Examples:

Calling the resolveAppVersionResources operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE' /* required */
};
resiliencehub.resolveAppVersionResources(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      The version of the application.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        The version of the application.

      • resolutionId — (String)

        The identifier for a specific resolution.

      • status — (String)

        Status of the action.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"

Returns:

  • (AWS.Request)

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

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

Creates a new application assessment for an application.

Service Reference:

Examples:

Calling the startAppAssessment operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  assessmentName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resiliencehub.startAppAssessment(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion — (String)

      The version of the application.

    • assessmentName — (String)

      The name for the assessment.

    • clientToken — (String)

      Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

      Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

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:

      • assessment — (map)

        The assessment created.

        • appArn — (String)

          Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • appVersion — (String)

          Version of an application.

        • assessmentArnrequired — (String)

          Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • assessmentName — (String)

          Name of the assessment.

        • assessmentStatusrequired — (String)

          Current status of the assessment for the resiliency policy.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Success"
        • compliance — (map<map>)

          Application compliance against the resiliency policy.

          • achievableRpoInSecs — (Integer)

            The Recovery Point Objective (RPO) that is achievable, in seconds.

          • achievableRtoInSecs — (Integer)

            The Recovery Time Objective (RTO) that is achievable, in seconds

          • complianceStatusrequired — (String)

            The current status of compliance for the resiliency policy.

            Possible values include:
            • "PolicyBreached"
            • "PolicyMet"
          • currentRpoInSecs — (Integer)

            The current RPO, in seconds.

          • currentRtoInSecs — (Integer)

            The current RTO, in seconds.

          • message — (String)

            The disruption compliance message.

          • rpoDescription — (String)

            The RPO description.

          • rpoReferenceId — (String)

            Reference identifier of the RPO .

          • rtoDescription — (String)

            The RTO description.

          • rtoReferenceId — (String)

            Reference identifier of the RTO.

        • complianceStatus — (String)

          Current status of the compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
        • cost — (map)

          Cost for the application.

          • amountrequired — (Float)

            The cost amount.

          • currencyrequired — (String)

            The cost currency, for example USD.

          • frequencyrequired — (String)

            The cost frequency.

            Possible values include:
            • "Hourly"
            • "Daily"
            • "Monthly"
            • "Yearly"
        • driftStatus — (String)

          Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

          Possible values include:
          • "NotChecked"
          • "NotDetected"
          • "Detected"
        • endTime — (Date)

          End time for the action.

        • invokerrequired — (String)

          The entity that invoked the assessment.

          Possible values include:
          • "User"
          • "System"
        • message — (String)

          Error or warning message from the assessment execution

        • policy — (map)

          Resiliency policy of an application.

          • creationTime — (Date)

            Date and time when the resiliency policy was created.

          • dataLocationConstraint — (String)

            Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

            Possible values include:
            • "AnyLocation"
            • "SameContinent"
            • "SameCountry"
          • estimatedCostTier — (String)

            Specifies the estimated cost tier of the resiliency policy.

            Possible values include:
            • "L1"
            • "L2"
            • "L3"
            • "L4"
          • policy — (map<map>)

            The resiliency policy.

            • rpoInSecsrequired — (Integer)

              Recovery Point Objective (RPO) in seconds.

            • rtoInSecsrequired — (Integer)

              Recovery Time Objective (RTO) in seconds.

          • policyArn — (String)

            Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

          • policyDescription — (String)

            The description for the policy.

          • policyName — (String)

            The name of the policy

          • tags — (map<String>)

            Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

          • tier — (String)

            The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

            Possible values include:
            • "MissionCritical"
            • "Critical"
            • "Important"
            • "CoreServices"
            • "NonCritical"
            • "NotApplicable"
        • resiliencyScore — (map)

          Current resiliency score for an application.

          • componentScore — (map<map>)

            The score generated by Resilience Hub for the scoring component after running an assessment.

            For example, if the score is 25 points, it indicates the overall score of your application generated by Resilience Hub after running an assessment.

            • excludedCount — (Integer)

              Number of recommendations that were excluded from the assessment.

              For example, if the Excluded count for Resilience Hub recommended Amazon CloudWatch alarms is 7, it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment.

            • outstandingCount — (Integer)

              Number of issues that must be resolved to obtain the maximum possible score for the scoring component. For SOPs, alarms, and FIS experiments, these are the number of recommendations that must be implemented. For compliance, it is the number of Application Components that has breached the resiliency policy.

              For example, if the Outstanding count for Resilience Hub recommended Amazon CloudWatch alarms is 5, it indicates that 5 Amazon CloudWatch alarms must be fixed to achieve the maximum possible score.

            • possibleScore — (Float)

              Maximum possible score that can be obtained for the scoring component. If the Possible score is 20 points, it indicates the maximum possible score you can achieve for your application when you run a new assessment after implementing all the Resilience Hub recommendations.

            • score — (Float)

              Resiliency score of your application.

          • disruptionScorerequired — (map<Float>)

            The disruption score for a valid key.

          • scorerequired — (Float)

            The outage score for a valid key.

        • resourceErrorsDetails — (map)

          A resource error object containing a list of errors retrieving an application's resources.

          • hasMoreErrors — (Boolean)

            This indicates if there are more errors not listed in the resourceErrors list.

          • resourceErrors — (Array<map>)

            A list of errors retrieving an application's resources.

            • logicalResourceId — (String)

              Identifier of the logical resource.

            • physicalResourceId — (String)

              Identifier of the physical resource.

            • reason — (String)

              This is the error message.

        • startTime — (Date)

          Starting time for the action.

        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • versionName — (String)

          Version name of the published application.

Returns:

  • (AWS.Request)

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

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

Applies one or more tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resiliencehub.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)

      Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

      The tags to assign to the resource. Each tag consists of a key/value pair.

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 one or more tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
resiliencehub.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)

      Amazon Resource Name (ARN) of the resource.

    • tagKeys — (Array<String>)

      The keys of the tags you want to remove.

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.

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

Updates an application.

Service Reference:

Examples:

Calling the updateApp operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  assessmentSchedule: Disabled | Daily,
  clearResiliencyPolicyArn: true || false,
  description: 'STRING_VALUE',
  eventSubscriptions: [
    {
      eventType: ScheduledAssessmentFailure | DriftDetected, /* required */
      name: 'STRING_VALUE', /* required */
      snsTopicArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  permissionModel: {
    type: LegacyIAMUser | RoleBased, /* required */
    crossAccountRoleArns: [
      'STRING_VALUE',
      /* more items */
    ],
    invokerRoleName: 'STRING_VALUE'
  },
  policyArn: 'STRING_VALUE'
};
resiliencehub.updateApp(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: {})
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • assessmentSchedule — (String)

      Assessment execution schedule with 'Daily' or 'Disabled' values.

      Possible values include:
      • "Disabled"
      • "Daily"
    • clearResiliencyPolicyArn — (Boolean)

      Specifies if the resiliency policy ARN should be cleared.

    • description — (String)

      The optional description for an app.

    • eventSubscriptions — (Array<map>)

      The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.

      • eventTyperequired — (String)

        The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected (DriftDetected) and Scheduled assessment failure (ScheduledAssessmentFailure) events.

        Possible values include:
        • "ScheduledAssessmentFailure"
        • "DriftDetected"
      • namerequired — (String)

        Unique name to identify an event subscription.

      • snsTopicArn — (String)

        Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: arn:partition:sns:region:account:topic-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • permissionModel — (map)

      Defines the roles and credentials that Resilience Hub would use while creating an application, importing its resources, and running an assessment.

      • crossAccountRoleArns — (Array<String>)

        Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.

        Note:
        • These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts.
        • These roles must have a trust policy with iam:AssumeRole permission to the invoker role in the primary account.
      • invokerRoleName — (String)

        Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.

        Note:
        • You must have iam:passRole permission for this role while creating or updating the application.
        • Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.
      • typerequired — (String)

        Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user.

        Possible values include:
        • "LegacyIAMUser"
        • "RoleBased"
    • policyArn — (String)

      Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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:

      • app — (map)

        The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

        • appArnrequired — (String)

          Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • assessmentSchedule — (String)

          Assessment execution schedule with 'Daily' or 'Disabled' values.

          Possible values include:
          • "Disabled"
          • "Daily"
        • complianceStatus — (String)

          Current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotAssessed"
          • "ChangesDetected"
        • creationTimerequired — (Date)

          Date and time when the app was created.

        • description — (String)

          Optional description for an application.

        • driftStatus — (String)

          Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

          Possible values include:
          • "NotChecked"
          • "NotDetected"
          • "Detected"
        • eventSubscriptions — (Array<map>)

          The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.

          • eventTyperequired — (String)

            The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected (DriftDetected) and Scheduled assessment failure (ScheduledAssessmentFailure) events.

            Possible values include:
            • "ScheduledAssessmentFailure"
            • "DriftDetected"
          • namerequired — (String)

            Unique name to identify an event subscription.

          • snsTopicArn — (String)

            Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: arn:partition:sns:region:account:topic-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • lastAppComplianceEvaluationTime — (Date)

          Date and time the most recent compliance evaluation.

        • lastDriftEvaluationTime — (Date)

          Indicates the last time that a drift was evaluated.

        • lastResiliencyScoreEvaluationTime — (Date)

          Date and time the most recent resiliency score evaluation.

        • namerequired — (String)

          Name for the application.

        • permissionModel — (map)

          Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.

          • crossAccountRoleArns — (Array<String>)

            Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.

            Note:
            • These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts.
            • These roles must have a trust policy with iam:AssumeRole permission to the invoker role in the primary account.
          • invokerRoleName — (String)

            Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.

            Note:
            • You must have iam:passRole permission for this role while creating or updating the application.
            • Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.
          • typerequired — (String)

            Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user.

            Possible values include:
            • "LegacyIAMUser"
            • "RoleBased"
        • policyArn — (String)

          Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • resiliencyScore — (Float)

          Current resiliency score for the application.

        • rpoInSecs — (Integer)

          Recovery Point Objective (RPO) in seconds.

        • rtoInSecs — (Integer)

          Recovery Time Objective (RTO) in seconds.

        • status — (String)

          Status of the application.

          Possible values include:
          • "Active"
          • "Deleting"
        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

Returns:

  • (AWS.Request)

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

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

Updates the Resilience Hub application version.

Note: This API updates the Resilience Hub application draft version. To use this information for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

Service Reference:

Examples:

Calling the updateAppVersion operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  additionalInfo: {
    '<String128WithoutWhitespace>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String128WithoutWhitespace>': ... */
  }
};
resiliencehub.updateAppVersion(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: {})
    • additionalInfo — (map<Array<String>>)

      Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

      Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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:

      • additionalInfo — (map<Array<String>>)

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        Note: Currently, this parameter supports only failover region and account.
      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        Resilience Hub application version.

Returns:

  • (AWS.Request)

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

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

Updates an existing Application Component in the Resilience Hub application.

Note: This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

Service Reference:

Examples:

Calling the updateAppVersionAppComponent operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE', /* required */
  additionalInfo: {
    '<String128WithoutWhitespace>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String128WithoutWhitespace>': ... */
  },
  name: 'STRING_VALUE',
  type: 'STRING_VALUE'
};
resiliencehub.updateAppVersionAppComponent(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: {})
    • additionalInfo — (map<Array<String>>)

      Currently, there is no supported additional information for Application Components.

    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • id — (String)

      Identifier of the Application Component.

    • name — (String)

      Name of the Application Component.

    • type — (String)

      Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appComponent — (map)

        List of Application Components that belong to this resource.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • id — (String)

          Identifier of the Application Component.

        • namerequired — (String)

          Name of the Application Component.

        • typerequired — (String)

          The type of Application Component.

      • appVersion — (String)

        Resilience Hub application version.

Returns:

  • (AWS.Request)

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

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

Updates the resource details in the Resilience Hub application.

Note:
  • This action has no effect outside Resilience Hub.
  • This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
  • To update application version with new physicalResourceID, you must call ResolveAppVersionResources API.

Service Reference:

Examples:

Calling the updateAppVersionResource operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  additionalInfo: {
    '<String128WithoutWhitespace>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String128WithoutWhitespace>': ... */
  },
  appComponents: [
    'STRING_VALUE',
    /* more items */
  ],
  awsAccountId: 'STRING_VALUE',
  awsRegion: 'STRING_VALUE',
  excluded: true || false,
  logicalResourceId: {
    identifier: 'STRING_VALUE', /* required */
    eksSourceName: 'STRING_VALUE',
    logicalStackName: 'STRING_VALUE',
    resourceGroupName: 'STRING_VALUE',
    terraformSourceName: 'STRING_VALUE'
  },
  physicalResourceId: 'STRING_VALUE',
  resourceName: 'STRING_VALUE',
  resourceType: 'STRING_VALUE'
};
resiliencehub.updateAppVersionResource(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: {})
    • additionalInfo — (map<Array<String>>)

      Currently, there is no supported additional information for resources.

    • appArn — (String)

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appComponents — (Array<String>)

      List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

    • awsAccountId — (String)

      Amazon Web Services account that owns the physical resource.

    • awsRegion — (String)

      Amazon Web Services region that owns the physical resource.

    • excluded — (Boolean)

      Indicates if a resource is excluded from an Resilience Hub application.

      Note: You can exclude only imported resources from an Resilience Hub application.
    • logicalResourceId — (map)

      Logical identifier of the resource.

      • eksSourceName — (String)

        Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

        Note: This parameter accepts values in "eks-cluster/namespace" format.
      • identifierrequired — (String)

        Identifier of the resource.

      • logicalStackName — (String)

        The name of the CloudFormation stack this resource belongs to.

      • resourceGroupName — (String)

        The name of the resource group that this resource belongs to.

      • terraformSourceName — (String)

        The name of the Terraform S3 state file this resource belongs to.

    • physicalResourceId — (String)

      Physical identifier of the resource.

    • resourceName — (String)

      Name of the resource.

    • resourceType — (String)

      Type of 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:

      • appArn — (String)

        Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      • appVersion — (String)

        Resilience Hub application version.

      • physicalResource — (map)

        Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
        • appComponents — (Array<map>)

          The application components that belong to this resource.

          • additionalInfo — (map<Array<String>>)

            Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

            Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
          • id — (String)

            Identifier of the Application Component.

          • namerequired — (String)

            Name of the Application Component.

          • typerequired — (String)

            The type of Application Component.

        • excluded — (Boolean)

          Indicates if a resource is included or excluded from the assessment.

        • logicalResourceIdrequired — (map)

          Logical identifier of the resource.

          • eksSourceName — (String)

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            Note: This parameter accepts values in "eks-cluster/namespace" format.
          • identifierrequired — (String)

            Identifier of the resource.

          • logicalStackName — (String)

            The name of the CloudFormation stack this resource belongs to.

          • resourceGroupName — (String)

            The name of the resource group that this resource belongs to.

          • terraformSourceName — (String)

            The name of the Terraform S3 state file this resource belongs to.

        • parentResourceName — (String)

          Name of the parent resource.

        • physicalResourceIdrequired — (map)

          Identifier of the physical resource.

          • awsAccountId — (String)

            The Amazon Web Services account that owns the physical resource.

          • awsRegion — (String)

            The Amazon Web Services Region that the physical resource is located in.

          • identifierrequired — (String)

            Identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

            • AWS::ECS::Service

            • AWS::EFS::FileSystem

            • AWS::ElasticLoadBalancingV2::LoadBalancer

            • AWS::Lambda::Function

            • AWS::SNS::Topic

            Native

            The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

            • AWS::ApiGateway::RestApi

            • AWS::ApiGatewayV2::Api

            • AWS::AutoScaling::AutoScalingGroup

            • AWS::DocDB::DBCluster

            • AWS::DocDB::DBGlobalCluster

            • AWS::DocDB::DBInstance

            • AWS::DynamoDB::GlobalTable

            • AWS::DynamoDB::Table

            • AWS::EC2::EC2Fleet

            • AWS::EC2::Instance

            • AWS::EC2::NatGateway

            • AWS::EC2::Volume

            • AWS::ElasticLoadBalancing::LoadBalancer

            • AWS::RDS::DBCluster

            • AWS::RDS::DBInstance

            • AWS::RDS::GlobalCluster

            • AWS::Route53::RecordSet

            • AWS::S3::Bucket

            • AWS::SQS::Queue

            Possible values include:
            • "Arn"
            • "Native"
        • resourceName — (String)

          The name of the resource.

        • resourceTyperequired — (String)

          The type of resource.

        • sourceType — (String)

          Type of input source.

          Possible values include:
          • "AppTemplate"
          • "Discovered"

Returns:

  • (AWS.Request)

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

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

Updates a resiliency policy.

Note: Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for rtoInSecs and rpoInSecs, the estimated workload RTO and estimated workload RPO result will be near zero and the Compliance status for your application will be set to Policy breached.

Service Reference:

Examples:

Calling the updateResiliencyPolicy operation

var params = {
  policyArn: 'STRING_VALUE', /* required */
  dataLocationConstraint: AnyLocation | SameContinent | SameCountry,
  policy: {
    '<DisruptionType>': {
      rpoInSecs: 'NUMBER_VALUE', /* required */
      rtoInSecs: 'NUMBER_VALUE' /* required */
    },
    /* '<DisruptionType>': ... */
  },
  policyDescription: 'STRING_VALUE',
  policyName: 'STRING_VALUE',
  tier: MissionCritical | Critical | Important | CoreServices | NonCritical | NotApplicable
};
resiliencehub.updateResiliencyPolicy(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: {})
    • dataLocationConstraint — (String)

      Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

      Possible values include:
      • "AnyLocation"
      • "SameContinent"
      • "SameCountry"
    • policy — (map<map>)

      The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

      • rpoInSecsrequired — (Integer)

        Recovery Point Objective (RPO) in seconds.

      • rtoInSecsrequired — (Integer)

        Recovery Time Objective (RTO) in seconds.

    • policyArn — (String)

      Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • policyDescription — (String)

      The description for the policy.

    • policyName — (String)

      The name of the policy

    • tier — (String)

      The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

      Possible values include:
      • "MissionCritical"
      • "Critical"
      • "Important"
      • "CoreServices"
      • "NonCritical"
      • "NotApplicable"

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:

      • policy — (map)

        The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

        • creationTime — (Date)

          Date and time when the resiliency policy was created.

        • dataLocationConstraint — (String)

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

          Possible values include:
          • "AnyLocation"
          • "SameContinent"
          • "SameCountry"
        • estimatedCostTier — (String)

          Specifies the estimated cost tier of the resiliency policy.

          Possible values include:
          • "L1"
          • "L2"
          • "L3"
          • "L4"
        • policy — (map<map>)

          The resiliency policy.

          • rpoInSecsrequired — (Integer)

            Recovery Point Objective (RPO) in seconds.

          • rtoInSecsrequired — (Integer)

            Recovery Time Objective (RTO) in seconds.

        • policyArn — (String)

          Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

        • tags — (map<String>)

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • tier — (String)

          The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

          Possible values include:
          • "MissionCritical"
          • "Critical"
          • "Important"
          • "CoreServices"
          • "NonCritical"
          • "NotApplicable"

Returns:

  • (AWS.Request)

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