Resiliencehub class
Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. It offers continual resiliency assessment and validation that integrates into your software development lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your applications are met, and resolve issues before they are released into production.
Constructors
- Resiliencehub({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
acceptResourceGroupingRecommendations(
{required String appArn, required List< AcceptGroupingRecommendationEntry> entries}) → Future<AcceptResourceGroupingRecommendationsResponse> - Accepts the resource grouping recommendations suggested by Resilience Hub for your application.
-
addDraftAppVersionResourceMappings(
{required String appArn, required List< ResourceMapping> resourceMappings}) → Future<AddDraftAppVersionResourceMappingsResponse> - 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(
{required String appArn, required List< UpdateRecommendationStatusRequestEntry> requestEntries}) → Future<BatchUpdateRecommendationStatusResponse> - Enables you to include or exclude one or more operational recommendations.
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createApp(
{required String name, AppAssessmentScheduleType? assessmentSchedule, String? awsApplicationArn, String? clientToken, String? description, List< EventSubscription> ? eventSubscriptions, PermissionModel? permissionModel, String? policyArn, Map<String, String> ? tags}) → Future<CreateAppResponse> - 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.
-
createAppVersionAppComponent(
{required String appArn, required String name, required String type, Map< String, List< ? additionalInfo, String? clientToken, String? id}) → Future<String> >CreateAppVersionAppComponentResponse> - Creates a new Application Component in the Resilience Hub application.
-
createAppVersionResource(
{required String appArn, required List< String> appComponents, required LogicalResourceId logicalResourceId, required String physicalResourceId, required String resourceType, Map<String, List< ? additionalInfo, String? awsAccountId, String? awsRegion, String? clientToken, String? resourceName}) → Future<String> >CreateAppVersionResourceResponse> - 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.
-
createRecommendationTemplate(
{required String assessmentArn, required String name, String? bucketName, String? clientToken, TemplateFormat? format, List< String> ? recommendationIds, List<RenderRecommendationType> ? recommendationTypes, Map<String, String> ? tags}) → Future<CreateRecommendationTemplateResponse> - Creates a new recommendation template for the Resilience Hub application.
-
createResiliencyPolicy(
{required Map< DisruptionType, FailurePolicy> policy, required String policyName, required ResiliencyPolicyTier tier, String? clientToken, DataLocationConstraint? dataLocationConstraint, String? policyDescription, Map<String, String> ? tags}) → Future<CreateResiliencyPolicyResponse> - Creates a resiliency policy for an application.
-
deleteApp(
{required String appArn, String? clientToken, bool? forceDelete}) → Future< DeleteAppResponse> - Deletes an Resilience Hub application. This is a destructive action that can't be undone.
-
deleteAppAssessment(
{required String assessmentArn, String? clientToken}) → Future< DeleteAppAssessmentResponse> - Deletes an Resilience Hub application assessment. This is a destructive action that can't be undone.
-
deleteAppInputSource(
{required String appArn, String? clientToken, EksSourceClusterNamespace? eksSourceClusterNamespace, String? sourceArn, TerraformSource? terraformSource}) → Future< DeleteAppInputSourceResponse> - Deletes the input source and all of its imported resources from the Resilience Hub application.
-
deleteAppVersionAppComponent(
{required String appArn, required String id, String? clientToken}) → Future< DeleteAppVersionAppComponentResponse> - Deletes an Application Component from the Resilience Hub application.
-
deleteAppVersionResource(
{required String appArn, String? awsAccountId, String? awsRegion, String? clientToken, LogicalResourceId? logicalResourceId, String? physicalResourceId, String? resourceName}) → Future< DeleteAppVersionResourceResponse> - Deletes a resource from the Resilience Hub application.
-
deleteRecommendationTemplate(
{required String recommendationTemplateArn, String? clientToken}) → Future< DeleteRecommendationTemplateResponse> - Deletes a recommendation template. This is a destructive action that can't be undone.
-
deleteResiliencyPolicy(
{required String policyArn, String? clientToken}) → Future< DeleteResiliencyPolicyResponse> - Deletes a resiliency policy. This is a destructive action that can't be undone.
-
describeApp(
{required String appArn}) → Future< DescribeAppResponse> - Describes an Resilience Hub application.
-
describeAppAssessment(
{required String assessmentArn}) → Future< DescribeAppAssessmentResponse> - Describes an assessment for an Resilience Hub application.
-
describeAppVersion(
{required String appArn, required String appVersion}) → Future< DescribeAppVersionResponse> - Describes the Resilience Hub application version.
-
describeAppVersionAppComponent(
{required String appArn, required String appVersion, required String id}) → Future< DescribeAppVersionAppComponentResponse> - Describes an Application Component in the Resilience Hub application.
-
describeAppVersionResource(
{required String appArn, required String appVersion, String? awsAccountId, String? awsRegion, LogicalResourceId? logicalResourceId, String? physicalResourceId, String? resourceName}) → Future< DescribeAppVersionResourceResponse> - Describes a resource of the Resilience Hub application.
-
describeAppVersionResourcesResolutionStatus(
{required String appArn, required String appVersion, String? resolutionId}) → Future< DescribeAppVersionResourcesResolutionStatusResponse> -
Returns the resolution status for the specified resolution identifier for
an application version. If
resolutionIdis not specified, the current resolution status is returned. -
describeAppVersionTemplate(
{required String appArn, required String appVersion}) → Future< DescribeAppVersionTemplateResponse> - Describes details about an Resilience Hub application.
-
describeDraftAppVersionResourcesImportStatus(
{required String appArn}) → Future< DescribeDraftAppVersionResourcesImportStatusResponse> - Describes the status of importing resources to an application version.
-
describeMetricsExport(
{required String metricsExportId}) → Future< DescribeMetricsExportResponse> - Describes the metrics of the application configuration being exported.
-
describeResiliencyPolicy(
{required String policyArn}) → Future< DescribeResiliencyPolicyResponse> - 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(
{required String appArn, String? groupingId}) → Future< DescribeResourceGroupingRecommendationTaskResponse> - Describes the resource grouping recommendation tasks run by Resilience Hub for your application.
-
importResourcesToDraftAppVersion(
{required String appArn, List< EksSource> ? eksSources, ResourceImportStrategyType? importStrategy, List<String> ? sourceArns, List<TerraformSource> ? terraformSources}) → Future<ImportResourcesToDraftAppVersionResponse> - Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
-
listAlarmRecommendations(
{required String assessmentArn, int? maxResults, String? nextToken}) → Future< ListAlarmRecommendationsResponse> - Lists the alarm recommendations for an Resilience Hub application.
-
listAppAssessmentComplianceDrifts(
{required String assessmentArn, int? maxResults, String? nextToken}) → Future< ListAppAssessmentComplianceDriftsResponse> - List of compliance drifts that were detected while running an assessment.
-
listAppAssessmentResourceDrifts(
{required String assessmentArn, int? maxResults, String? nextToken}) → Future< ListAppAssessmentResourceDriftsResponse> - List of resource drifts that were detected while running an assessment.
-
listAppAssessments(
{String? appArn, String? assessmentName, List< AssessmentStatus> ? assessmentStatus, ComplianceStatus? complianceStatus, AssessmentInvoker? invoker, int? maxResults, String? nextToken, bool? reverseOrder}) → Future<ListAppAssessmentsResponse> - Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.
-
listAppComponentCompliances(
{required String assessmentArn, int? maxResults, String? nextToken}) → Future< ListAppComponentCompliancesResponse> - Lists the compliances for an Resilience Hub Application Component.
-
listAppComponentRecommendations(
{required String assessmentArn, int? maxResults, String? nextToken}) → Future< ListAppComponentRecommendationsResponse> - Lists the recommendations for an Resilience Hub Application Component.
-
listAppInputSources(
{required String appArn, required String appVersion, int? maxResults, String? nextToken}) → Future< ListAppInputSourcesResponse> - Lists all the input sources of the Resilience Hub application. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
-
listApps(
{String? appArn, String? awsApplicationArn, DateTime? fromLastAssessmentTime, int? maxResults, String? name, String? nextToken, bool? reverseOrder, DateTime? toLastAssessmentTime}) → Future< ListAppsResponse> - Lists your Resilience Hub applications.
-
listAppVersionAppComponents(
{required String appArn, required String appVersion, int? maxResults, String? nextToken}) → Future< ListAppVersionAppComponentsResponse> - Lists all the Application Components in the Resilience Hub application.
-
listAppVersionResourceMappings(
{required String appArn, required String appVersion, int? maxResults, String? nextToken}) → Future< ListAppVersionResourceMappingsResponse> - 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(
{required String appArn, required String appVersion, int? maxResults, String? nextToken, String? resolutionId}) → Future< ListAppVersionResourcesResponse> - Lists all the resources in an Resilience Hub application.
-
listAppVersions(
{required String appArn, DateTime? endTime, int? maxResults, String? nextToken, DateTime? startTime}) → Future< ListAppVersionsResponse> - Lists the different versions for the Resilience Hub applications.
-
listMetrics(
{List< Condition> ? conditions, String? dataSource, List<Field> ? fields, int? maxResults, String? nextToken, List<Sort> ? sorts}) → Future<ListMetricsResponse> - Lists the metrics that can be exported.
-
listRecommendationTemplates(
{String? assessmentArn, int? maxResults, String? name, String? nextToken, String? recommendationTemplateArn, bool? reverseOrder, List< RecommendationTemplateStatus> ? status}) → Future<ListRecommendationTemplatesResponse> - Lists the recommendation templates for the Resilience Hub applications.
-
listResiliencyPolicies(
{int? maxResults, String? nextToken, String? policyName}) → Future< ListResiliencyPoliciesResponse> - Lists the resiliency policies for the Resilience Hub applications.
-
listResourceGroupingRecommendations(
{String? appArn, int? maxResults, String? nextToken}) → Future< ListResourceGroupingRecommendationsResponse> - Lists the resource grouping recommendations suggested by Resilience Hub for your application.
-
listSopRecommendations(
{required String assessmentArn, int? maxResults, String? nextToken}) → Future< ListSopRecommendationsResponse> - Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
-
listSuggestedResiliencyPolicies(
{int? maxResults, String? nextToken}) → Future< ListSuggestedResiliencyPoliciesResponse> - Lists the suggested resiliency policies for the Resilience Hub applications.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Lists the tags for your resources in your Resilience Hub applications.
-
listTestRecommendations(
{required String assessmentArn, int? maxResults, String? nextToken}) → Future< ListTestRecommendationsResponse> - Lists the test recommendations for the Resilience Hub application.
-
listUnsupportedAppVersionResources(
{required String appArn, required String appVersion, int? maxResults, String? nextToken, String? resolutionId}) → Future< ListUnsupportedAppVersionResourcesResponse> - 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.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
publishAppVersion(
{required String appArn, String? versionName}) → Future< PublishAppVersionResponse> - Publishes a new version of a specific Resilience Hub application.
-
putDraftAppVersionTemplate(
{required String appArn, required String appTemplateBody}) → Future< PutDraftAppVersionTemplateResponse> - Adds or updates the app template for an Resilience Hub application draft version.
-
rejectResourceGroupingRecommendations(
{required String appArn, required List< RejectGroupingRecommendationEntry> entries}) → Future<RejectResourceGroupingRecommendationsResponse> - Rejects resource grouping recommendations.
-
removeDraftAppVersionResourceMappings(
{required String appArn, List< String> ? appRegistryAppNames, List<String> ? eksSourceNames, List<String> ? logicalStackNames, List<String> ? resourceGroupNames, List<String> ? resourceNames, List<String> ? terraformSourceNames}) → Future<RemoveDraftAppVersionResourceMappingsResponse> - Removes resource mappings from a draft application version.
-
resolveAppVersionResources(
{required String appArn, required String appVersion}) → Future< ResolveAppVersionResourcesResponse> - Resolves the resources for an application version.
-
startAppAssessment(
{required String appArn, required String appVersion, required String assessmentName, String? clientToken, Map< String, String> ? tags}) → Future<StartAppAssessmentResponse> - Creates a new application assessment for an application.
-
startMetricsExport(
{String? bucketName, String? clientToken}) → Future< StartMetricsExportResponse> - Initiates the export task of metrics.
-
startResourceGroupingRecommendationTask(
{required String appArn}) → Future< StartResourceGroupingRecommendationTaskResponse> - Starts grouping recommendation task.
-
tagResource(
{required String resourceArn, required Map< String, String> tags}) → Future<void> - Applies one or more tags to a resource.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes one or more tags from a resource.
-
updateApp(
{required String appArn, AppAssessmentScheduleType? assessmentSchedule, bool? clearResiliencyPolicyArn, String? description, List< EventSubscription> ? eventSubscriptions, PermissionModel? permissionModel, String? policyArn}) → Future<UpdateAppResponse> - Updates an application.
-
updateAppVersion(
{required String appArn, Map< String, List< ? additionalInfo}) → Future<String> >UpdateAppVersionResponse> - Updates the Resilience Hub application version.
-
updateAppVersionAppComponent(
{required String appArn, required String id, Map< String, List< ? additionalInfo, String? name, String? type}) → Future<String> >UpdateAppVersionAppComponentResponse> - Updates an existing Application Component in the Resilience Hub application.
-
updateAppVersionResource(
{required String appArn, Map< String, List< ? additionalInfo, List<String> >String> ? appComponents, String? awsAccountId, String? awsRegion, bool? excluded, LogicalResourceId? logicalResourceId, String? physicalResourceId, String? resourceName, String? resourceType}) → Future<UpdateAppVersionResourceResponse> - Updates the resource details in the Resilience Hub application.
-
updateResiliencyPolicy(
{required String policyArn, DataLocationConstraint? dataLocationConstraint, Map< DisruptionType, FailurePolicy> ? policy, String? policyDescription, String? policyName, ResiliencyPolicyTier? tier}) → Future<UpdateResiliencyPolicyResponse> - Updates a resiliency policy.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited