@alma-cdk/cross-region-parameter
Version:
Store AWS SSM Parameter Store Parameters into another AWS Region with AWS CDK
934 lines (933 loc) • 96.8 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Resiliencehub extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Resiliencehub.Types.ClientConfiguration)
config: Config & Resiliencehub.Types.ClientConfiguration;
/**
* Adds the resource mapping for the draft application version.
*/
addDraftAppVersionResourceMappings(params: Resiliencehub.Types.AddDraftAppVersionResourceMappingsRequest, callback?: (err: AWSError, data: Resiliencehub.Types.AddDraftAppVersionResourceMappingsResponse) => void): Request<Resiliencehub.Types.AddDraftAppVersionResourceMappingsResponse, AWSError>;
/**
* Adds the resource mapping for the draft application version.
*/
addDraftAppVersionResourceMappings(callback?: (err: AWSError, data: Resiliencehub.Types.AddDraftAppVersionResourceMappingsResponse) => void): Request<Resiliencehub.Types.AddDraftAppVersionResourceMappingsResponse, AWSError>;
/**
* Creates a Resilience Hub application. A 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–up to five–CloudFormation stacks, and an appropriate resiliency policy. After you create a 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).
*/
createApp(params: Resiliencehub.Types.CreateAppRequest, callback?: (err: AWSError, data: Resiliencehub.Types.CreateAppResponse) => void): Request<Resiliencehub.Types.CreateAppResponse, AWSError>;
/**
* Creates a Resilience Hub application. A 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–up to five–CloudFormation stacks, and an appropriate resiliency policy. After you create a 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).
*/
createApp(callback?: (err: AWSError, data: Resiliencehub.Types.CreateAppResponse) => void): Request<Resiliencehub.Types.CreateAppResponse, AWSError>;
/**
* Creates a new recommendation template.
*/
createRecommendationTemplate(params: Resiliencehub.Types.CreateRecommendationTemplateRequest, callback?: (err: AWSError, data: Resiliencehub.Types.CreateRecommendationTemplateResponse) => void): Request<Resiliencehub.Types.CreateRecommendationTemplateResponse, AWSError>;
/**
* Creates a new recommendation template.
*/
createRecommendationTemplate(callback?: (err: AWSError, data: Resiliencehub.Types.CreateRecommendationTemplateResponse) => void): Request<Resiliencehub.Types.CreateRecommendationTemplateResponse, AWSError>;
/**
* Creates a resiliency policy for an application.
*/
createResiliencyPolicy(params: Resiliencehub.Types.CreateResiliencyPolicyRequest, callback?: (err: AWSError, data: Resiliencehub.Types.CreateResiliencyPolicyResponse) => void): Request<Resiliencehub.Types.CreateResiliencyPolicyResponse, AWSError>;
/**
* Creates a resiliency policy for an application.
*/
createResiliencyPolicy(callback?: (err: AWSError, data: Resiliencehub.Types.CreateResiliencyPolicyResponse) => void): Request<Resiliencehub.Types.CreateResiliencyPolicyResponse, AWSError>;
/**
* Deletes an AWS Resilience Hub application. This is a destructive action that can't be undone.
*/
deleteApp(params: Resiliencehub.Types.DeleteAppRequest, callback?: (err: AWSError, data: Resiliencehub.Types.DeleteAppResponse) => void): Request<Resiliencehub.Types.DeleteAppResponse, AWSError>;
/**
* Deletes an AWS Resilience Hub application. This is a destructive action that can't be undone.
*/
deleteApp(callback?: (err: AWSError, data: Resiliencehub.Types.DeleteAppResponse) => void): Request<Resiliencehub.Types.DeleteAppResponse, AWSError>;
/**
* Deletes an AWS Resilience Hub application assessment. This is a destructive action that can't be undone.
*/
deleteAppAssessment(params: Resiliencehub.Types.DeleteAppAssessmentRequest, callback?: (err: AWSError, data: Resiliencehub.Types.DeleteAppAssessmentResponse) => void): Request<Resiliencehub.Types.DeleteAppAssessmentResponse, AWSError>;
/**
* Deletes an AWS Resilience Hub application assessment. This is a destructive action that can't be undone.
*/
deleteAppAssessment(callback?: (err: AWSError, data: Resiliencehub.Types.DeleteAppAssessmentResponse) => void): Request<Resiliencehub.Types.DeleteAppAssessmentResponse, AWSError>;
/**
* Deletes a recommendation template. This is a destructive action that can't be undone.
*/
deleteRecommendationTemplate(params: Resiliencehub.Types.DeleteRecommendationTemplateRequest, callback?: (err: AWSError, data: Resiliencehub.Types.DeleteRecommendationTemplateResponse) => void): Request<Resiliencehub.Types.DeleteRecommendationTemplateResponse, AWSError>;
/**
* Deletes a recommendation template. This is a destructive action that can't be undone.
*/
deleteRecommendationTemplate(callback?: (err: AWSError, data: Resiliencehub.Types.DeleteRecommendationTemplateResponse) => void): Request<Resiliencehub.Types.DeleteRecommendationTemplateResponse, AWSError>;
/**
* Deletes a resiliency policy. This is a destructive action that can't be undone.
*/
deleteResiliencyPolicy(params: Resiliencehub.Types.DeleteResiliencyPolicyRequest, callback?: (err: AWSError, data: Resiliencehub.Types.DeleteResiliencyPolicyResponse) => void): Request<Resiliencehub.Types.DeleteResiliencyPolicyResponse, AWSError>;
/**
* Deletes a resiliency policy. This is a destructive action that can't be undone.
*/
deleteResiliencyPolicy(callback?: (err: AWSError, data: Resiliencehub.Types.DeleteResiliencyPolicyResponse) => void): Request<Resiliencehub.Types.DeleteResiliencyPolicyResponse, AWSError>;
/**
* Describes an AWS Resilience Hub application.
*/
describeApp(params: Resiliencehub.Types.DescribeAppRequest, callback?: (err: AWSError, data: Resiliencehub.Types.DescribeAppResponse) => void): Request<Resiliencehub.Types.DescribeAppResponse, AWSError>;
/**
* Describes an AWS Resilience Hub application.
*/
describeApp(callback?: (err: AWSError, data: Resiliencehub.Types.DescribeAppResponse) => void): Request<Resiliencehub.Types.DescribeAppResponse, AWSError>;
/**
* Describes an assessment for an AWS Resilience Hub application.
*/
describeAppAssessment(params: Resiliencehub.Types.DescribeAppAssessmentRequest, callback?: (err: AWSError, data: Resiliencehub.Types.DescribeAppAssessmentResponse) => void): Request<Resiliencehub.Types.DescribeAppAssessmentResponse, AWSError>;
/**
* Describes an assessment for an AWS Resilience Hub application.
*/
describeAppAssessment(callback?: (err: AWSError, data: Resiliencehub.Types.DescribeAppAssessmentResponse) => void): Request<Resiliencehub.Types.DescribeAppAssessmentResponse, AWSError>;
/**
* Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.
*/
describeAppVersionResourcesResolutionStatus(params: Resiliencehub.Types.DescribeAppVersionResourcesResolutionStatusRequest, callback?: (err: AWSError, data: Resiliencehub.Types.DescribeAppVersionResourcesResolutionStatusResponse) => void): Request<Resiliencehub.Types.DescribeAppVersionResourcesResolutionStatusResponse, AWSError>;
/**
* Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.
*/
describeAppVersionResourcesResolutionStatus(callback?: (err: AWSError, data: Resiliencehub.Types.DescribeAppVersionResourcesResolutionStatusResponse) => void): Request<Resiliencehub.Types.DescribeAppVersionResourcesResolutionStatusResponse, AWSError>;
/**
* Describes details about an AWS Resilience Hub
*/
describeAppVersionTemplate(params: Resiliencehub.Types.DescribeAppVersionTemplateRequest, callback?: (err: AWSError, data: Resiliencehub.Types.DescribeAppVersionTemplateResponse) => void): Request<Resiliencehub.Types.DescribeAppVersionTemplateResponse, AWSError>;
/**
* Describes details about an AWS Resilience Hub
*/
describeAppVersionTemplate(callback?: (err: AWSError, data: Resiliencehub.Types.DescribeAppVersionTemplateResponse) => void): Request<Resiliencehub.Types.DescribeAppVersionTemplateResponse, AWSError>;
/**
* Describes the status of importing resources to an application version.
*/
describeDraftAppVersionResourcesImportStatus(params: Resiliencehub.Types.DescribeDraftAppVersionResourcesImportStatusRequest, callback?: (err: AWSError, data: Resiliencehub.Types.DescribeDraftAppVersionResourcesImportStatusResponse) => void): Request<Resiliencehub.Types.DescribeDraftAppVersionResourcesImportStatusResponse, AWSError>;
/**
* Describes the status of importing resources to an application version.
*/
describeDraftAppVersionResourcesImportStatus(callback?: (err: AWSError, data: Resiliencehub.Types.DescribeDraftAppVersionResourcesImportStatusResponse) => void): Request<Resiliencehub.Types.DescribeDraftAppVersionResourcesImportStatusResponse, AWSError>;
/**
* Describes a specified resiliency policy for an AWS 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.
*/
describeResiliencyPolicy(params: Resiliencehub.Types.DescribeResiliencyPolicyRequest, callback?: (err: AWSError, data: Resiliencehub.Types.DescribeResiliencyPolicyResponse) => void): Request<Resiliencehub.Types.DescribeResiliencyPolicyResponse, AWSError>;
/**
* Describes a specified resiliency policy for an AWS 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.
*/
describeResiliencyPolicy(callback?: (err: AWSError, data: Resiliencehub.Types.DescribeResiliencyPolicyResponse) => void): Request<Resiliencehub.Types.DescribeResiliencyPolicyResponse, AWSError>;
/**
* Imports resources from sources such as a CloudFormation stack, resource-groups, or application registry app to a draft application version.
*/
importResourcesToDraftAppVersion(params: Resiliencehub.Types.ImportResourcesToDraftAppVersionRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ImportResourcesToDraftAppVersionResponse) => void): Request<Resiliencehub.Types.ImportResourcesToDraftAppVersionResponse, AWSError>;
/**
* Imports resources from sources such as a CloudFormation stack, resource-groups, or application registry app to a draft application version.
*/
importResourcesToDraftAppVersion(callback?: (err: AWSError, data: Resiliencehub.Types.ImportResourcesToDraftAppVersionResponse) => void): Request<Resiliencehub.Types.ImportResourcesToDraftAppVersionResponse, AWSError>;
/**
* Lists the alarm recommendations for a AWS Resilience Hub application.
*/
listAlarmRecommendations(params: Resiliencehub.Types.ListAlarmRecommendationsRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListAlarmRecommendationsResponse) => void): Request<Resiliencehub.Types.ListAlarmRecommendationsResponse, AWSError>;
/**
* Lists the alarm recommendations for a AWS Resilience Hub application.
*/
listAlarmRecommendations(callback?: (err: AWSError, data: Resiliencehub.Types.ListAlarmRecommendationsResponse) => void): Request<Resiliencehub.Types.ListAlarmRecommendationsResponse, AWSError>;
/**
* Lists the assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object.
*/
listAppAssessments(params: Resiliencehub.Types.ListAppAssessmentsRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListAppAssessmentsResponse) => void): Request<Resiliencehub.Types.ListAppAssessmentsResponse, AWSError>;
/**
* Lists the assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object.
*/
listAppAssessments(callback?: (err: AWSError, data: Resiliencehub.Types.ListAppAssessmentsResponse) => void): Request<Resiliencehub.Types.ListAppAssessmentsResponse, AWSError>;
/**
* Lists the compliances for an AWS Resilience Hub component.
*/
listAppComponentCompliances(params: Resiliencehub.Types.ListAppComponentCompliancesRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListAppComponentCompliancesResponse) => void): Request<Resiliencehub.Types.ListAppComponentCompliancesResponse, AWSError>;
/**
* Lists the compliances for an AWS Resilience Hub component.
*/
listAppComponentCompliances(callback?: (err: AWSError, data: Resiliencehub.Types.ListAppComponentCompliancesResponse) => void): Request<Resiliencehub.Types.ListAppComponentCompliancesResponse, AWSError>;
/**
* Lists the recommendations for an AWS Resilience Hub component.
*/
listAppComponentRecommendations(params: Resiliencehub.Types.ListAppComponentRecommendationsRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListAppComponentRecommendationsResponse) => void): Request<Resiliencehub.Types.ListAppComponentRecommendationsResponse, AWSError>;
/**
* Lists the recommendations for an AWS Resilience Hub component.
*/
listAppComponentRecommendations(callback?: (err: AWSError, data: Resiliencehub.Types.ListAppComponentRecommendationsResponse) => void): Request<Resiliencehub.Types.ListAppComponentRecommendationsResponse, AWSError>;
/**
* 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.
*/
listAppVersionResourceMappings(params: Resiliencehub.Types.ListAppVersionResourceMappingsRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListAppVersionResourceMappingsResponse) => void): Request<Resiliencehub.Types.ListAppVersionResourceMappingsResponse, AWSError>;
/**
* 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.
*/
listAppVersionResourceMappings(callback?: (err: AWSError, data: Resiliencehub.Types.ListAppVersionResourceMappingsResponse) => void): Request<Resiliencehub.Types.ListAppVersionResourceMappingsResponse, AWSError>;
/**
* Lists all the resources in an application version.
*/
listAppVersionResources(params: Resiliencehub.Types.ListAppVersionResourcesRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListAppVersionResourcesResponse) => void): Request<Resiliencehub.Types.ListAppVersionResourcesResponse, AWSError>;
/**
* Lists all the resources in an application version.
*/
listAppVersionResources(callback?: (err: AWSError, data: Resiliencehub.Types.ListAppVersionResourcesResponse) => void): Request<Resiliencehub.Types.ListAppVersionResourcesResponse, AWSError>;
/**
* Lists the different versions for the Resilience Hub applications.
*/
listAppVersions(params: Resiliencehub.Types.ListAppVersionsRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListAppVersionsResponse) => void): Request<Resiliencehub.Types.ListAppVersionsResponse, AWSError>;
/**
* Lists the different versions for the Resilience Hub applications.
*/
listAppVersions(callback?: (err: AWSError, data: Resiliencehub.Types.ListAppVersionsResponse) => void): Request<Resiliencehub.Types.ListAppVersionsResponse, AWSError>;
/**
* Lists your Resilience Hub applications.
*/
listApps(params: Resiliencehub.Types.ListAppsRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListAppsResponse) => void): Request<Resiliencehub.Types.ListAppsResponse, AWSError>;
/**
* Lists your Resilience Hub applications.
*/
listApps(callback?: (err: AWSError, data: Resiliencehub.Types.ListAppsResponse) => void): Request<Resiliencehub.Types.ListAppsResponse, AWSError>;
/**
* Lists the recommendation templates for the Resilience Hub applications.
*/
listRecommendationTemplates(params: Resiliencehub.Types.ListRecommendationTemplatesRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListRecommendationTemplatesResponse) => void): Request<Resiliencehub.Types.ListRecommendationTemplatesResponse, AWSError>;
/**
* Lists the recommendation templates for the Resilience Hub applications.
*/
listRecommendationTemplates(callback?: (err: AWSError, data: Resiliencehub.Types.ListRecommendationTemplatesResponse) => void): Request<Resiliencehub.Types.ListRecommendationTemplatesResponse, AWSError>;
/**
* Lists the resiliency policies for the Resilience Hub applications.
*/
listResiliencyPolicies(params: Resiliencehub.Types.ListResiliencyPoliciesRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListResiliencyPoliciesResponse) => void): Request<Resiliencehub.Types.ListResiliencyPoliciesResponse, AWSError>;
/**
* Lists the resiliency policies for the Resilience Hub applications.
*/
listResiliencyPolicies(callback?: (err: AWSError, data: Resiliencehub.Types.ListResiliencyPoliciesResponse) => void): Request<Resiliencehub.Types.ListResiliencyPoliciesResponse, AWSError>;
/**
* Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
*/
listSopRecommendations(params: Resiliencehub.Types.ListSopRecommendationsRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListSopRecommendationsResponse) => void): Request<Resiliencehub.Types.ListSopRecommendationsResponse, AWSError>;
/**
* Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
*/
listSopRecommendations(callback?: (err: AWSError, data: Resiliencehub.Types.ListSopRecommendationsResponse) => void): Request<Resiliencehub.Types.ListSopRecommendationsResponse, AWSError>;
/**
* Lists the suggested resiliency policies for the Resilience Hub applications.
*/
listSuggestedResiliencyPolicies(params: Resiliencehub.Types.ListSuggestedResiliencyPoliciesRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListSuggestedResiliencyPoliciesResponse) => void): Request<Resiliencehub.Types.ListSuggestedResiliencyPoliciesResponse, AWSError>;
/**
* Lists the suggested resiliency policies for the Resilience Hub applications.
*/
listSuggestedResiliencyPolicies(callback?: (err: AWSError, data: Resiliencehub.Types.ListSuggestedResiliencyPoliciesResponse) => void): Request<Resiliencehub.Types.ListSuggestedResiliencyPoliciesResponse, AWSError>;
/**
* Lists the tags for your resources in your Resilience Hub applications.
*/
listTagsForResource(params: Resiliencehub.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListTagsForResourceResponse) => void): Request<Resiliencehub.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags for your resources in your Resilience Hub applications.
*/
listTagsForResource(callback?: (err: AWSError, data: Resiliencehub.Types.ListTagsForResourceResponse) => void): Request<Resiliencehub.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the test recommendations for the Resilience Hub application.
*/
listTestRecommendations(params: Resiliencehub.Types.ListTestRecommendationsRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListTestRecommendationsResponse) => void): Request<Resiliencehub.Types.ListTestRecommendationsResponse, AWSError>;
/**
* Lists the test recommendations for the Resilience Hub application.
*/
listTestRecommendations(callback?: (err: AWSError, data: Resiliencehub.Types.ListTestRecommendationsResponse) => void): Request<Resiliencehub.Types.ListTestRecommendationsResponse, AWSError>;
/**
* Lists the resources that are not currently supported in AWS 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.
*/
listUnsupportedAppVersionResources(params: Resiliencehub.Types.ListUnsupportedAppVersionResourcesRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ListUnsupportedAppVersionResourcesResponse) => void): Request<Resiliencehub.Types.ListUnsupportedAppVersionResourcesResponse, AWSError>;
/**
* Lists the resources that are not currently supported in AWS 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.
*/
listUnsupportedAppVersionResources(callback?: (err: AWSError, data: Resiliencehub.Types.ListUnsupportedAppVersionResourcesResponse) => void): Request<Resiliencehub.Types.ListUnsupportedAppVersionResourcesResponse, AWSError>;
/**
* Publishes a new version of a specific Resilience Hub application.
*/
publishAppVersion(params: Resiliencehub.Types.PublishAppVersionRequest, callback?: (err: AWSError, data: Resiliencehub.Types.PublishAppVersionResponse) => void): Request<Resiliencehub.Types.PublishAppVersionResponse, AWSError>;
/**
* Publishes a new version of a specific Resilience Hub application.
*/
publishAppVersion(callback?: (err: AWSError, data: Resiliencehub.Types.PublishAppVersionResponse) => void): Request<Resiliencehub.Types.PublishAppVersionResponse, AWSError>;
/**
* Adds or updates the app template for a draft version of a Resilience Hub app.
*/
putDraftAppVersionTemplate(params: Resiliencehub.Types.PutDraftAppVersionTemplateRequest, callback?: (err: AWSError, data: Resiliencehub.Types.PutDraftAppVersionTemplateResponse) => void): Request<Resiliencehub.Types.PutDraftAppVersionTemplateResponse, AWSError>;
/**
* Adds or updates the app template for a draft version of a Resilience Hub app.
*/
putDraftAppVersionTemplate(callback?: (err: AWSError, data: Resiliencehub.Types.PutDraftAppVersionTemplateResponse) => void): Request<Resiliencehub.Types.PutDraftAppVersionTemplateResponse, AWSError>;
/**
* Removes resource mappings from a draft application version.
*/
removeDraftAppVersionResourceMappings(params: Resiliencehub.Types.RemoveDraftAppVersionResourceMappingsRequest, callback?: (err: AWSError, data: Resiliencehub.Types.RemoveDraftAppVersionResourceMappingsResponse) => void): Request<Resiliencehub.Types.RemoveDraftAppVersionResourceMappingsResponse, AWSError>;
/**
* Removes resource mappings from a draft application version.
*/
removeDraftAppVersionResourceMappings(callback?: (err: AWSError, data: Resiliencehub.Types.RemoveDraftAppVersionResourceMappingsResponse) => void): Request<Resiliencehub.Types.RemoveDraftAppVersionResourceMappingsResponse, AWSError>;
/**
* Resolves the resources for an application version.
*/
resolveAppVersionResources(params: Resiliencehub.Types.ResolveAppVersionResourcesRequest, callback?: (err: AWSError, data: Resiliencehub.Types.ResolveAppVersionResourcesResponse) => void): Request<Resiliencehub.Types.ResolveAppVersionResourcesResponse, AWSError>;
/**
* Resolves the resources for an application version.
*/
resolveAppVersionResources(callback?: (err: AWSError, data: Resiliencehub.Types.ResolveAppVersionResourcesResponse) => void): Request<Resiliencehub.Types.ResolveAppVersionResourcesResponse, AWSError>;
/**
* Creates a new application assessment for an application.
*/
startAppAssessment(params: Resiliencehub.Types.StartAppAssessmentRequest, callback?: (err: AWSError, data: Resiliencehub.Types.StartAppAssessmentResponse) => void): Request<Resiliencehub.Types.StartAppAssessmentResponse, AWSError>;
/**
* Creates a new application assessment for an application.
*/
startAppAssessment(callback?: (err: AWSError, data: Resiliencehub.Types.StartAppAssessmentResponse) => void): Request<Resiliencehub.Types.StartAppAssessmentResponse, AWSError>;
/**
* Applies one or more tags to a resource.
*/
tagResource(params: Resiliencehub.Types.TagResourceRequest, callback?: (err: AWSError, data: Resiliencehub.Types.TagResourceResponse) => void): Request<Resiliencehub.Types.TagResourceResponse, AWSError>;
/**
* Applies one or more tags to a resource.
*/
tagResource(callback?: (err: AWSError, data: Resiliencehub.Types.TagResourceResponse) => void): Request<Resiliencehub.Types.TagResourceResponse, AWSError>;
/**
* Removes one or more tags from a resource.
*/
untagResource(params: Resiliencehub.Types.UntagResourceRequest, callback?: (err: AWSError, data: Resiliencehub.Types.UntagResourceResponse) => void): Request<Resiliencehub.Types.UntagResourceResponse, AWSError>;
/**
* Removes one or more tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: Resiliencehub.Types.UntagResourceResponse) => void): Request<Resiliencehub.Types.UntagResourceResponse, AWSError>;
/**
* Updates an application.
*/
updateApp(params: Resiliencehub.Types.UpdateAppRequest, callback?: (err: AWSError, data: Resiliencehub.Types.UpdateAppResponse) => void): Request<Resiliencehub.Types.UpdateAppResponse, AWSError>;
/**
* Updates an application.
*/
updateApp(callback?: (err: AWSError, data: Resiliencehub.Types.UpdateAppResponse) => void): Request<Resiliencehub.Types.UpdateAppResponse, AWSError>;
/**
* Updates a resiliency policy.
*/
updateResiliencyPolicy(params: Resiliencehub.Types.UpdateResiliencyPolicyRequest, callback?: (err: AWSError, data: Resiliencehub.Types.UpdateResiliencyPolicyResponse) => void): Request<Resiliencehub.Types.UpdateResiliencyPolicyResponse, AWSError>;
/**
* Updates a resiliency policy.
*/
updateResiliencyPolicy(callback?: (err: AWSError, data: Resiliencehub.Types.UpdateResiliencyPolicyResponse) => void): Request<Resiliencehub.Types.UpdateResiliencyPolicyResponse, AWSError>;
}
declare namespace Resiliencehub {
export interface AddDraftAppVersionResourceMappingsRequest {
/**
* The Amazon Resource Name (ARN) of the 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 AWS General Reference.
*/
appArn: Arn;
/**
* 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.
*/
resourceMappings: ResourceMappingList;
}
export interface AddDraftAppVersionResourceMappingsResponse {
/**
* The Amazon Resource Name (ARN) of the 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 AWS General Reference.
*/
appArn: Arn;
/**
* The version of the application.
*/
appVersion: EntityVersion;
/**
* 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.
*/
resourceMappings: ResourceMappingList;
}
export interface AlarmRecommendation {
/**
* The application component for the CloudWatch alarm recommendation.
*/
appComponentName?: EntityId;
/**
* The description of the recommendation.
*/
description?: EntityDescription;
/**
* The list of CloudWatch alarm recommendations.
*/
items?: RecommendationItemList;
/**
* The name of the alarm recommendation.
*/
name: String500;
/**
* The prerequisite for the alarm recommendation.
*/
prerequisite?: String500;
/**
* The identifier of the alarm recommendation.
*/
recommendationId: Uuid;
/**
* The reference identifier of the alarm recommendation.
*/
referenceId: SpecReferenceId;
/**
* The type of alarm recommendation.
*/
type: AlarmType;
}
export type AlarmRecommendationList = AlarmRecommendation[];
export type AlarmReferenceIdList = String500[];
export type AlarmType = "Metric"|"Composite"|"Canary"|"Logs"|"Event"|string;
export interface App {
/**
* The Amazon Resource Name (ARN) of the 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 AWS General Reference.
*/
appArn: Arn;
/**
* Assessment execution schedule with 'Daily' or 'Disabled' values.
*/
assessmentSchedule?: AppAssessmentScheduleType;
/**
* The current status of compliance for the resiliency policy.
*/
complianceStatus?: AppComplianceStatusType;
/**
* The timestamp for when the app was created.
*/
creationTime: TimeStamp;
/**
* The optional description for an app.
*/
description?: EntityDescription;
/**
* The timestamp for the most recent compliance evaluation.
*/
lastAppComplianceEvaluationTime?: TimeStamp;
/**
* The timestamp for the most recent resiliency score evaluation.
*/
lastResiliencyScoreEvaluationTime?: TimeStamp;
/**
* The name for the application.
*/
name: EntityName;
/**
* The 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 AWS General Reference.
*/
policyArn?: Arn;
/**
* The current resiliency score for the application.
*/
resiliencyScore?: Double;
/**
* The status of the application.
*/
status?: AppStatusType;
/**
* The 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.
*/
tags?: TagMap;
}
export interface AppAssessment {
/**
* The Amazon Resource Name (ARN) of the 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 AWS General Reference.
*/
appArn?: Arn;
/**
* The version of the application.
*/
appVersion?: EntityVersion;
/**
* The 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 AWS General Reference.
*/
assessmentArn: Arn;
/**
* The name of the assessment.
*/
assessmentName?: EntityName;
/**
* The current status of the assessment for the resiliency policy.
*/
assessmentStatus: AssessmentStatus;
/**
* The application compliance against the resiliency policy.
*/
compliance?: AssessmentCompliance;
/**
* The current status of the compliance for the resiliency policy.
*/
complianceStatus?: ComplianceStatus;
/**
* The cost for the application.
*/
cost?: Cost;
/**
* The end time for the action.
*/
endTime?: TimeStamp;
/**
* The entity that invoked the assessment.
*/
invoker: AssessmentInvoker;
/**
* Error or warning message from the assessment execution
*/
message?: String500;
/**
* The resiliency policy.
*/
policy?: ResiliencyPolicy;
/**
* The current resiliency score for the application.
*/
resiliencyScore?: ResiliencyScore;
/**
* A resource error object containing a list of errors retrieving an application's resources.
*/
resourceErrorsDetails?: ResourceErrorsDetails;
/**
* The starting time for the action.
*/
startTime?: TimeStamp;
/**
* The 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.
*/
tags?: TagMap;
}
export type AppAssessmentScheduleType = "Disabled"|"Daily"|string;
export interface AppAssessmentSummary {
/**
* The Amazon Resource Name (ARN) of the 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 AWS General Reference.
*/
appArn?: Arn;
/**
* The version of the application.
*/
appVersion?: EntityVersion;
/**
* The 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 AWS General Reference.
*/
assessmentArn: Arn;
/**
* The name of the assessment.
*/
assessmentName?: EntityName;
/**
* The current status of the assessment for the resiliency policy.
*/
assessmentStatus: AssessmentStatus;
/**
* The current status of compliance for the resiliency policy.
*/
complianceStatus?: ComplianceStatus;
/**
* The cost for the application.
*/
cost?: Cost;
/**
* The end time for the action.
*/
endTime?: TimeStamp;
/**
* The entity that invoked the assessment.
*/
invoker?: AssessmentInvoker;
/**
* The message from the assessment run.
*/
message?: String500;
/**
* The current resiliency score for the application.
*/
resiliencyScore?: Double;
/**
* The starting time for the action.
*/
startTime?: TimeStamp;
}
export type AppAssessmentSummaryList = AppAssessmentSummary[];
export type AppComplianceStatusType = "PolicyBreached"|"PolicyMet"|"NotAssessed"|"ChangesDetected"|string;
export interface AppComponent {
/**
* The name of the application component.
*/
name: String255;
/**
* The type of application component.
*/
type: String255;
}
export interface AppComponentCompliance {
/**
* The name of the application component.
*/
appComponentName?: EntityId;
/**
* The compliance of the application component against the resiliency policy.
*/
compliance?: AssessmentCompliance;
/**
* The cost for the application.
*/
cost?: Cost;
/**
* The compliance message.
*/
message?: String500;
/**
* The current resiliency score for the application.
*/
resiliencyScore?: ResiliencyScore;
/**
* The status of the action.
*/
status?: ComplianceStatus;
}
export type AppComponentList = AppComponent[];
export type AppStatusType = "Active"|"Deleting"|string;
export interface AppSummary {
/**
* The Amazon Resource Name (ARN) of the 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 AWS General Reference.
*/
appArn: Arn;
/**
* Assessment execution schedule with 'Daily' or 'Disabled' values.
*/
assessmentSchedule?: AppAssessmentScheduleType;
/**
* The current status of compliance for the resiliency policy.
*/
complianceStatus?: AppComplianceStatusType;
/**
* The timestamp for when the app was created.
*/
creationTime: TimeStamp;
/**
* The optional description for an app.
*/
description?: EntityDescription;
/**
* The name of the application.
*/
name: EntityName;
/**
* The current resiliency score for the application.
*/
resiliencyScore?: Double;
/**
* The status of the application.
*/
status?: AppStatusType;
}
export type AppSummaryList = AppSummary[];
export type AppTemplateBody = string;
export type AppVersionList = AppVersionSummary[];
export interface AppVersionSummary {
/**
* The version of the application.
*/
appVersion: EntityVersion;
}
export type Arn = string;
export type ArnList = Arn[];
export type AssessmentCompliance = {[key: string]: DisruptionCompliance};
export type AssessmentInvoker = "User"|"System"|string;
export type AssessmentStatus = "Pending"|"InProgress"|"Failed"|"Success"|string;
export type AssessmentStatusList = AssessmentStatus[];
export type AwsRegion = string;
export type BooleanOptional = boolean;
export type ClientToken = string;
export type ComplianceStatus = "PolicyBreached"|"PolicyMet"|string;
export type ComponentCompliancesList = AppComponentCompliance[];
export interface ComponentRecommendation {
/**
* The name of the application component.
*/
appComponentName: EntityId;
/**
* The list of recommendations.
*/
configRecommendations: ConfigRecommendationList;
/**
* The recommendation status.
*/
recommendationStatus: RecommendationComplianceStatus;
}
export type ComponentRecommendationList = ComponentRecommendation[];
export interface ConfigRecommendation {
/**
* The application component name.
*/
appComponentName?: EntityId;
/**
* The current compliance against the resiliency policy before applying the configuration change.
*/
compliance?: AssessmentCompliance;
/**
* The cost for the application.
*/
cost?: Cost;
/**
* The optional description for an app.
*/
description?: EntityDescription;
/**
* The architecture type.
*/
haArchitecture?: HaArchitecture;
/**
* The name of the recommendation configuration.
*/
name: EntityName;
/**
* The type of optimization.
*/
optimizationType: ConfigRecommendationOptimizationType;
/**
* The expected compliance against the resiliency policy after applying the configuration change.
*/
recommendationCompliance?: RecommendationCompliance;
/**
* The reference identifier for the recommendation configuration.
*/
referenceId: SpecReferenceId;
/**
* List of the suggested configuration changes.
*/
suggestedChanges?: SuggestedChangesList;
}
export type ConfigRecommendationList = ConfigRecommendation[];
export type ConfigRecommendationOptimizationType = "LeastCost"|"LeastChange"|"BestAZRecovery"|"LeastErrors"|"BestAttainable"|"BestRegionRecovery"|string;
export interface Cost {
/**
* The cost amount.
*/
amount: Double;
/**
* The cost currency, for example USD.
*/
currency: CurrencyCode;
/**
* The cost frequency.
*/
frequency: CostFrequency;
}
export type CostFrequency = "Hourly"|"Daily"|"Monthly"|"Yearly"|string;
export interface CreateAppRequest {
/**
* Assessment execution schedule with 'Daily' or 'Disabled' values.
*/
assessmentSchedule?: AppAssessmentScheduleType;
/**
* 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.
*/
clientToken?: ClientToken;
/**
* The optional description for an app.
*/
description?: EntityDescription;
/**
* The name for the application.
*/
name: EntityName;
/**
* The 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 AWS General Reference.
*/
policyArn?: Arn;
/**
* The 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.
*/
tags?: TagMap;
}
export interface CreateAppResponse {
/**
* The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.
*/
app: App;
}
export interface CreateRecommendationTemplateRequest {
/**
* The 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 AWS General Reference.
*/
assessmentArn: Arn;
/**
* The name of the Amazon S3 bucket that will contain the recommendation template.
*/
bucketName?: EntityName;
/**
* 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.
*/
clientToken?: ClientToken;
/**
* The format for the recommendation template. CfnJson The template is CloudFormation JSON. CfnYaml The template is CloudFormation YAML.
*/
format?: TemplateFormat;
/**
* The name for the recommendation template.
*/
name: EntityName;
/**
* Identifiers for the recommendations used to create a recommendation template.
*/
recommendationIds?: RecommendationIdList;
/**
* 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.
*/
recommendationTypes?: RenderRecommendationTypeList;
/**
* The 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.
*/
tags?: TagMap;
}
export interface CreateRecommendationTemplateResponse {
/**
* 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.
*/
recommendationTemplate?: RecommendationTemplate;
}
export interface CreateResiliencyPolicyRequest {
/**
* 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.
*/
clientToken?: ClientToken;
/**
* Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
*/
dataLocationConstraint?: DataLocationConstraint;
/**
* The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
*/
policy: DisruptionPolicy;
/**
* The description for the policy.
*/
policyDescription?: EntityDescription;
/**
* The name of the policy
*/
policyName: EntityName;
/**
* The 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.
*/
tags?: TagMap;
/**
* The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
*/
tier: ResiliencyPolicyTier;
}
export interface CreateResiliencyPolicyResponse {
/**
* The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
*/
policy: ResiliencyPolicy;
}
export type CurrencyCode = string;
export type CustomerId = string;
export type DataLocationConstraint = "AnyLocation"|"SameContinent"|"SameCountry"|string;
export interface DeleteAppAssessmentRequest {
/**
* The 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 AWS General Reference.
*/
assessmentArn: Arn;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface DeleteAppAssessmentResponse {
/**
* The 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 AWS General Reference.
*/
assessmentArn: Arn;
/**
* The current status of the assessment for the resiliency policy.
*/
assessmentStatus: AssessmentStatus;
}
export interface DeleteAppRequest {
/**
* The Amazon Resource Name (ARN) of the 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 AWS General Reference.
*/
appArn: Arn;
/**
* 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.
*/
clientToken?: ClientToken;
/**
* A boolean option to force the deletion of a Resilience Hub application.
*/
forceDelete?: BooleanOptional;
}
export interface DeleteAppResponse {
/**
* The Amazon Resource Name (ARN) of the 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 AWS General Reference.
*/
appArn: Arn;
}
export interface DeleteRecommendationTemplateRequest {
/**
* 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.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) for a recommendation template.
*/
recommendationTemplateArn: Arn;
}
export interface DeleteRecommendationTemplateResponse {
/**
* The Amazon Resource Name (ARN) for a recommendation template.
*/
recommendationTemplateArn: Arn;
/**
* The status of the action.
*/
status: RecommendationTemplateStatus;
}
export interface DeleteResiliencyPolicyRequest {
/**
* 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.
*/
clientToken?: ClientToken;
/**
* The 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 AWS General Reference.
*/
policyArn: Arn;
}
export interface DeleteResiliencyPolicyResponse {
/**
* The 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 AWS General Reference.
*/
policyArn: Arn;
}
export interface DescribeAppAssessmentRequest {
/**
* The 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 AWS General Reference.
*/
assessmentArn: Arn;
}
export interface DescribeAppAssessmentResponse {
/**
* The assessment for an AWS Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.
*/
assessment: AppAssessment;
}
export interface DescribeAppRequest {
/**
* The Amazon Resource Name (ARN) of the 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 AWS General Reference.
*/
appArn: Arn;
}
export interface DescribeAppResponse {
/**
* The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
*/
app: App;