AWS.Resiliencehub — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

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

Method Details

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

Accepts the resource grouping recommendations suggested by Resilience Hub for your application.

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

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

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

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

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

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

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

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

Creates a new Application Component in the Resilience Hub application.

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

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

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

Note:

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

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

Creates a new recommendation template for the Resilience Hub application.

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

Creates a resiliency policy for an application.

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

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

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

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

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

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

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

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

Deletes an Application Component from the Resilience Hub application.

Note:

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

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

Deletes a resource from the Resilience Hub application.

Note:

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

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

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

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

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

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

Describes an Resilience Hub application.

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

Describes an assessment for an Resilience Hub application.

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

Describes the Resilience Hub application version.

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

Describes an Application Component in the Resilience Hub application.

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

Describes a resource of the Resilience Hub application.

Note: This API accepts only one of the following parameters to describe the resource:

resourceName
logicalResourceId
physicalResourceId (Along with physicalResourceId, you can also provide awsAccountId, and awsRegion)

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

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

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

Describes details about an Resilience Hub application.

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

Describes the status of importing resources to an application version.

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

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

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

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

Describes the resource grouping recommendation tasks run by Resilience Hub for your application.

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

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

Lists the alarm recommendations for an Resilience Hub application.

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

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

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

Indicates the list of resource drifts that were detected while running an assessment.

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

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

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

Lists the compliances for an Resilience Hub Application Component.

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

Lists the recommendations for an Resilience Hub Application Component.

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

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

Lists your Resilience Hub applications.

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

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

Lists all the Application Components in the Resilience Hub application.

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

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

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

Lists all the resources in an Resilience Hub application.

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

Lists the different versions for the Resilience Hub applications.

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

Lists the recommendation templates for the Resilience Hub applications.

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

Lists the resiliency policies for the Resilience Hub applications.

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

Lists the resource grouping recommendations suggested by Resilience Hub for your application.

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

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

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

Lists the suggested resiliency policies for the Resilience Hub applications.

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

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

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

Lists the test recommendations for the Resilience Hub application.

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

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

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

Publishes a new version of a specific Resilience Hub application.

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

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

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

Rejects resource grouping recommendations.

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

Removes resource mappings from a draft application version.

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

Resolves the resources for an application version.

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

Creates a new application assessment for an application.

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

Starts grouping recommendation task.

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

Applies one or more tags to a resource.

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

Removes one or more tags from a resource.

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

Updates the Resilience Hub application version.

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

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

Updates an existing Application Component in the Resilience Hub application.

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

Updates the resource details in the Resilience Hub application.

Note:

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

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

Updates a resiliency policy.