Class: AWS.Resiliencehub

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)

      Name of the application this resource is mapped to when the mappingType is AppRegistryApp.

    • eksSourceName — (String)

      Name of the Amazon Elastic Kubernetes Service cluster and namespace that this resource is mapped to when the mappingType is EKS.

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

      Name of the CloudFormation stack this resource is mapped to when the mappingType is CfnStack.

    • mappingType — required — (String)

      Specifies the type of resource mapping.

      Possible values include:
      • "CfnStack"
      • "Resource"
      • "AppRegistryApp"
      • "ResourceGroup"
      • "Terraform"
      • "EKS"
    • physicalResourceId — required — (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.

      • identifier — required — (String)

        Identifier of the physical resource.

      • type — required — (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 Groups that this resource is mapped to when the mappingType is ResourceGroup.

    • resourceName — (String)

      Name of the resource that this resource is mapped to when the mappingType is Resource.

    • terraformSourceName — (String)

      Name of the Terraform source that this resource is mapped to when the mappingType is Terraform.

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)

        Name of the application this resource is mapped to when the mappingType is AppRegistryApp.

      • eksSourceName — (String)

        Name of the Amazon Elastic Kubernetes Service cluster and namespace that this resource is mapped to when the mappingType is EKS.

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

        Name of the CloudFormation stack this resource is mapped to when the mappingType is CfnStack.

      • mappingType — required — (String)

        Specifies the type of resource mapping.

        Possible values include:
        • "CfnStack"
        • "Resource"
        • "AppRegistryApp"
        • "ResourceGroup"
        • "Terraform"
        • "EKS"
      • physicalResourceId — required — (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.

        • identifier — required — (String)

          Identifier of the physical resource.

        • type — required — (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 Groups that this resource is mapped to when the mappingType is ResourceGroup.

      • resourceName — (String)

        Name of the resource that this resource is mapped to when the mappingType is Resource.

      • terraformSourceName — (String)

        Name of the Terraform source that this resource is mapped to when the mappingType is Terraform.

Returns:

• (AWS.Request) —

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

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.

    • entryId — required — (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"
    • excluded — required — (Boolean)

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

    • item — required — (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.

    • referenceId — required — (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.

      • entryId — required — (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.
      • errorMessage — required — (String)

        Indicates the error that occurred while excluding an operational recommendation.

    • successfulEntries — (Array<map>)

      A list of items that were included or excluded.

      • entryId — required — (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"
      • excluded — required — (Boolean)

        Indicates if the operational recommendation was successfully excluded.

      • item — required — (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.

      • referenceId — required — (String)

        Reference identifier of the operational recommendation.

Returns:

• (AWS.Request) —

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

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.

    • eventType — required — (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"
    • name — required — (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.
    • type — required — (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.

      • appArn — required — (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"
        • "NotApplicable"
        • "MissingPolicy"
      • creationTime — required — (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.

        • eventType — required — (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"
        • name — required — (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.

      • name — required — (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.
        • type — required — (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.

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.

      • name — required — (String)

        Name of the Application Component.

      • type — required — (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.

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.
    • identifier — required — (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.

        • name — required — (String)

          Name of the Application Component.

        • type — required — (String)

          The type of Application Component.

      • excluded — (Boolean)

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

      • logicalResourceId — required — (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.
        • identifier — required — (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.

      • physicalResourceId — required — (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.

        • identifier — required — (String)

          Identifier of the physical resource.

        • type — required — (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.

      • resourceType — required — (String)

        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.

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.

      • assessmentArn — required — (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.

      • format — required — (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.

      • name — required — (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.

      • recommendationTemplateArn — required — (String)

        Amazon Resource Name (ARN) for the recommendation template.

      • recommendationTypes — required — (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.

      • status — required — (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.

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.

    • rpoInSecs — required — (Integer)

      Recovery Point Objective (RPO) in seconds.

    • rtoInSecs — required — (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.

        • rpoInSecs — required — (Integer)

          Recovery Point Objective (RPO) in seconds.

        • rtoInSecs — required — (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.

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.

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.

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.

    • eksClusterArn — required — (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.

    • namespace — required — (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.

    • s3StateFileUrl — required — (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.

        • eksClusterArn — required — (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.

        • namespace — required — (String)

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

      • importType — required — (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.

        • s3StateFileUrl — required — (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.

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.

      • name — required — (String)

        Name of the Application Component.

      • type — required — (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.

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.
    • identifier — required — (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.

        • name — required — (String)

          Name of the Application Component.

        • type — required — (String)

          The type of Application Component.

      • excluded — (Boolean)

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

      • logicalResourceId — required — (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.
        • identifier — required — (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.

      • physicalResourceId — required — (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.

        • identifier — required — (String)

          Identifier of the physical resource.

        • type — required — (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.

      • resourceType — required — (String)

        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.

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.

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.

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.

      • appArn — required — (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"
        • "NotApplicable"
        • "MissingPolicy"
      • creationTime — required — (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.

        • eventType — required — (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"
        • name — required — (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.

      • name — required — (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.
        • type — required — (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.

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.

      • assessmentArn — required — (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.

      • assessmentStatus — required — (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

        • complianceStatus — required — (String)

          The current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotApplicable"
          • "MissingPolicy"
        • 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"
        • "NotApplicable"
        • "MissingPolicy"
      • cost — (map)

        Cost for the application.

        • amount — required — (Float)

          The cost amount.

        • currency — required — (String)

          The cost currency, for example USD.

        • frequency — required — (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 — required — (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.

          • rpoInSecs — required — (Integer)

            Recovery Point Objective (RPO) in seconds.

          • rtoInSecs — required — (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 excludedCount for Alarms coverage scoring component is 7, it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment.

          • outstandingCount — (Integer)

            Number of recommendations that must be implemented to obtain the maximum possible score for the scoring component. For SOPs, alarms, and tests, these are the number of recommendations that must be implemented. For compliance, these are the number of Application Components that have breached the resiliency policy.

            For example, if the outstandingCount for Alarms coverage scoring component is 5, it indicates that 5 Amazon CloudWatch alarms need to be implemented to achieve the maximum possible score.

          • possibleScore — (Float)

            Maximum possible score that can be obtained for the scoring component.

            For example, if the possibleScore is 20 points, it indicates the maximum possible score you can achieve for the scoring component when you run a new assessment after implementing all the Resilience Hub recommendations.

          • score — (Float)

            Resiliency score points given for the scoring component. The score is always less than or equal to the possibleScore.

        • disruptionScore — required — (map<Float>)

          The disruption score for a valid key.

        • score — required — (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.

      • summary — (map)

        Indicates a concise summary that provides an overview of the Resilience Hub assessment.

        • riskRecommendations — (Array<map>)

          Indicates the top risks and recommendations identified by the Resilience Hub assessment, each representing a specific risk and the corresponding recommendation to address it.

          Note: This property is available only in the US East (N. Virginia) Region.
          • appComponents — (Array<String>)

            Indicates the Application Components (AppComponents) that were assessed as part of the assessnent and are associated with the identified risk and recommendation.

            Note: This property is available only in the US East (N. Virginia) Region.
          • recommendation — (String)

            Indicates the recommendation provided by the Resilience Hub to address the identified risks in the application.

            Note: This property is available only in the US East (N. Virginia) Region.
          • risk — (String)

            Indicates the description of the potential risk identified in the application as part of the Resilience Hub assessment.

            Note: This property is available only in the US East (N. Virginia) Region.
        • summary — (String)

          Indicates a concise summary that provides an overview of the Resilience Hub assessment.

          Note: This property is available only in the US East (N. Virginia) Region.
      • 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.

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.

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.

      • name — required — (String)

        Name of the Application Component.

      • type — required — (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.

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.
    • identifier — required — (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.

        • name — required — (String)

          Name of the Application Component.

        • type — required — (String)

          The type of Application Component.

      • excluded — (Boolean)

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

      • logicalResourceId — required — (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.
        • identifier — required — (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.

      • physicalResourceId — required — (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.

        • identifier — required — (String)

          Identifier of the physical resource.

        • type — required — (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.

      • resourceType — required — (String)

        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.

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.

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.

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.

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.

        • rpoInSecs — required — (Integer)

          Recovery Point Objective (RPO) in seconds.

        • rtoInSecs — required — (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.

var params = {
  appArn: 'STRING_VALUE', /* required */
  groupingId: 'STRING_VALUE'
};
resiliencehub.describeResourceGroupingRecommendationTask(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.

  • groupingId — (String)

    Indicates the identifier of the grouping recommendation task.

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:

    • errorMessage — (String)

      Indicates the error that occurred while generating a grouping recommendation.

    • groupingId — (String)

      Indicates the identifier of the grouping recommendation task.

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

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.

    • eksClusterArn — required — (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.

    • namespaces — required — (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.

    • s3StateFileUrl — required — (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.

      • eksClusterArn — required — (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.

      • namespaces — required — (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.

      • s3StateFileUrl — required — (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.

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.

      • name — required — (String)

        Name of the alarm recommendation.

      • prerequisite — (String)

        The prerequisite for the alarm recommendation.

      • recommendationId — required — (String)

        Identifier of the alarm recommendation.

      • recommendationStatus — (String)

        Status of the recommended Amazon CloudWatch alarm.

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

        Reference identifier of the alarm recommendation.

      • type — required — (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.

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 compliance drifts requested.

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

    • 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

        • complianceStatus — required — (String)

          The current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotApplicable"
          • "MissingPolicy"
        • 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"
        • "Added"
        • "Removed"
      • driftType — (String)

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

        Possible values include:
        • "ApplicationCompliance"
        • "AppComponentResiliencyComplianceStatus"
      • 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

        • complianceStatus — required — (String)

          The current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotApplicable"
          • "MissingPolicy"
        • 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)

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

Returns:

• (AWS.Request) —

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

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

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

    • resourceDrifts — (Array<map>)

      Indicates all the resource drifts detected for an assessed entity.

      • appArn — (String)

        Amazon Resource Name (ARN) of the application whose resources have drifted. 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.

      • appVersion — (String)

        Version of the application whose resources have drifted.

      • diffType — (String)

        Indicates if the resource was added or removed.

        Possible values include:
        • "NotEqual"
        • "Added"
        • "Removed"
      • referenceId — (String)

        Reference identifier of the resource drift.

      • resourceIdentifier — (map)

        Identifier of the drifted resource.

        • logicalResourceId — (map)

          Logical identifier of the drifted 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.
          • identifier — required — (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.

        • resourceType — (String)

          Type of the drifted resource.

Returns:

• (AWS.Request) —

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

var params = {
  appArn: 'STRING_VALUE',
  assessmentName: 'STRING_VALUE',
  assessmentStatus: [
    Pending | InProgress | Failed | Success,
    /* more items */
  ],
  complianceStatus: PolicyBreached | PolicyMet | NotApplicable | MissingPolicy,
  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"
    • "NotApplicable"
    • "MissingPolicy"
  • 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.

      • assessmentArn — required — (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.

      • assessmentStatus — required — (String)

        Current status of the assessment for the resiliency policy.

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

        Current status of compliance for the resiliency policy.

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

        Cost for an application.

        • amount — required — (Float)

          The cost amount.

        • currency — required — (String)

          The cost currency, for example USD.

        • frequency — required — (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.