resiliencehub/aws.sdk.kotlin.services.resiliencehub

Package-level declarations

Types

Link copied to clipboard
interface ResiliencehubClient : SdkClient

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun ResiliencehubClient.addDraftAppVersionResourceMappings(crossinline block: AddDraftAppVersionResourceMappingsRequest.Builder.() -> Unit): 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 suported by Resilience Hub and how to add them in your application, see Step 2: How is your application managed? in the Resilience Hub User Guide.

Link copied to clipboard
inline suspend fun ResiliencehubClient.batchUpdateRecommendationStatus(crossinline block: BatchUpdateRecommendationStatusRequest.Builder.() -> Unit): BatchUpdateRecommendationStatusResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.createApp(crossinline block: CreateAppRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun ResiliencehubClient.createAppVersionAppComponent(crossinline block: CreateAppVersionAppComponentRequest.Builder.() -> Unit): CreateAppVersionAppComponentResponse

Creates a new Application Component in the Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.createAppVersionResource(crossinline block: CreateAppVersionResourceRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun ResiliencehubClient.createRecommendationTemplate(crossinline block: CreateRecommendationTemplateRequest.Builder.() -> Unit): CreateRecommendationTemplateResponse

Creates a new recommendation template for the Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.createResiliencyPolicy(crossinline block: CreateResiliencyPolicyRequest.Builder.() -> Unit): CreateResiliencyPolicyResponse

Creates a resiliency policy for an application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.deleteApp(crossinline block: DeleteAppRequest.Builder.() -> Unit): DeleteAppResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.deleteAppAssessment(crossinline block: DeleteAppAssessmentRequest.Builder.() -> Unit): DeleteAppAssessmentResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.deleteAppInputSource(crossinline block: DeleteAppInputSourceRequest.Builder.() -> Unit): DeleteAppInputSourceResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.deleteAppVersionAppComponent(crossinline block: DeleteAppVersionAppComponentRequest.Builder.() -> Unit): DeleteAppVersionAppComponentResponse

Deletes an Application Component from the Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.deleteAppVersionResource(crossinline block: DeleteAppVersionResourceRequest.Builder.() -> Unit): DeleteAppVersionResourceResponse

Deletes a resource from the Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.deleteRecommendationTemplate(crossinline block: DeleteRecommendationTemplateRequest.Builder.() -> Unit): DeleteRecommendationTemplateResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.deleteResiliencyPolicy(crossinline block: DeleteResiliencyPolicyRequest.Builder.() -> Unit): DeleteResiliencyPolicyResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.describeApp(crossinline block: DescribeAppRequest.Builder.() -> Unit): DescribeAppResponse

Describes an Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.describeAppAssessment(crossinline block: DescribeAppAssessmentRequest.Builder.() -> Unit): DescribeAppAssessmentResponse

Describes an assessment for an Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.describeAppVersion(crossinline block: DescribeAppVersionRequest.Builder.() -> Unit): DescribeAppVersionResponse

Describes the Resilience Hub application version.

Link copied to clipboard
inline suspend fun ResiliencehubClient.describeAppVersionAppComponent(crossinline block: DescribeAppVersionAppComponentRequest.Builder.() -> Unit): DescribeAppVersionAppComponentResponse

Describes an Application Component in the Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.describeAppVersionResource(crossinline block: DescribeAppVersionResourceRequest.Builder.() -> Unit): DescribeAppVersionResourceResponse

Describes a resource of the Resilience Hub application.

inline suspend fun ResiliencehubClient.describeAppVersionResourcesResolutionStatus(crossinline block: DescribeAppVersionResourcesResolutionStatusRequest.Builder.() -> Unit): DescribeAppVersionResourcesResolutionStatusResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.describeAppVersionTemplate(crossinline block: DescribeAppVersionTemplateRequest.Builder.() -> Unit): DescribeAppVersionTemplateResponse

Describes details about an Resilience Hub application.

inline suspend fun ResiliencehubClient.describeDraftAppVersionResourcesImportStatus(crossinline block: DescribeDraftAppVersionResourcesImportStatusRequest.Builder.() -> Unit): DescribeDraftAppVersionResourcesImportStatusResponse

Describes the status of importing resources to an application version.

Link copied to clipboard
inline suspend fun ResiliencehubClient.describeResiliencyPolicy(crossinline block: DescribeResiliencyPolicyRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun ResiliencehubClient.importResourcesToDraftAppVersion(crossinline block: ImportResourcesToDraftAppVersionRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listAlarmRecommendations(crossinline block: ListAlarmRecommendationsRequest.Builder.() -> Unit): ListAlarmRecommendationsResponse

Lists the alarm recommendations for an Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listAppAssessmentComplianceDrifts(crossinline block: ListAppAssessmentComplianceDriftsRequest.Builder.() -> Unit): ListAppAssessmentComplianceDriftsResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.listAppAssessments(crossinline block: ListAppAssessmentsRequest.Builder.() -> Unit): ListAppAssessmentsResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.listAppComponentCompliances(crossinline block: ListAppComponentCompliancesRequest.Builder.() -> Unit): ListAppComponentCompliancesResponse

Lists the compliances for an Resilience Hub Application Component.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listAppComponentRecommendations(crossinline block: ListAppComponentRecommendationsRequest.Builder.() -> Unit): ListAppComponentRecommendationsResponse

Lists the recommendations for an Resilience Hub Application Component.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listAppInputSources(crossinline block: ListAppInputSourcesRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listApps(crossinline block: ListAppsRequest.Builder.() -> Unit): ListAppsResponse

Lists your Resilience Hub applications.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listAppVersionAppComponents(crossinline block: ListAppVersionAppComponentsRequest.Builder.() -> Unit): ListAppVersionAppComponentsResponse

Lists all the Application Components in the Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listAppVersionResourceMappings(crossinline block: ListAppVersionResourceMappingsRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listAppVersionResources(crossinline block: ListAppVersionResourcesRequest.Builder.() -> Unit): ListAppVersionResourcesResponse

Lists all the resources in an Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listAppVersions(crossinline block: ListAppVersionsRequest.Builder.() -> Unit): ListAppVersionsResponse

Lists the different versions for the Resilience Hub applications.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listRecommendationTemplates(crossinline block: ListRecommendationTemplatesRequest.Builder.() -> Unit): ListRecommendationTemplatesResponse

Lists the recommendation templates for the Resilience Hub applications.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listResiliencyPolicies(crossinline block: ListResiliencyPoliciesRequest.Builder.() -> Unit): ListResiliencyPoliciesResponse

Lists the resiliency policies for the Resilience Hub applications.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listSopRecommendations(crossinline block: ListSopRecommendationsRequest.Builder.() -> Unit): ListSopRecommendationsResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.listSuggestedResiliencyPolicies(crossinline block: ListSuggestedResiliencyPoliciesRequest.Builder.() -> Unit): ListSuggestedResiliencyPoliciesResponse

Lists the suggested resiliency policies for the Resilience Hub applications.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.listTestRecommendations(crossinline block: ListTestRecommendationsRequest.Builder.() -> Unit): ListTestRecommendationsResponse

Lists the test recommendations for the Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.listUnsupportedAppVersionResources(crossinline block: ListUnsupportedAppVersionResourcesRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun ResiliencehubClient.publishAppVersion(crossinline block: PublishAppVersionRequest.Builder.() -> Unit): PublishAppVersionResponse

Publishes a new version of a specific Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.putDraftAppVersionTemplate(crossinline block: PutDraftAppVersionTemplateRequest.Builder.() -> Unit): PutDraftAppVersionTemplateResponse

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

Link copied to clipboard
inline suspend fun ResiliencehubClient.removeDraftAppVersionResourceMappings(crossinline block: RemoveDraftAppVersionResourceMappingsRequest.Builder.() -> Unit): RemoveDraftAppVersionResourceMappingsResponse

Removes resource mappings from a draft application version.

Link copied to clipboard
inline suspend fun ResiliencehubClient.resolveAppVersionResources(crossinline block: ResolveAppVersionResourcesRequest.Builder.() -> Unit): ResolveAppVersionResourcesResponse

Resolves the resources for an application version.

Link copied to clipboard
inline suspend fun ResiliencehubClient.startAppAssessment(crossinline block: StartAppAssessmentRequest.Builder.() -> Unit): StartAppAssessmentResponse

Creates a new application assessment for an application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Applies one or more tags to a resource.

Link copied to clipboard
inline suspend fun ResiliencehubClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tags from a resource.

Link copied to clipboard
inline suspend fun ResiliencehubClient.updateApp(crossinline block: UpdateAppRequest.Builder.() -> Unit): UpdateAppResponse

Updates an application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.updateAppVersion(crossinline block: UpdateAppVersionRequest.Builder.() -> Unit): UpdateAppVersionResponse

Updates the Resilience Hub application version.

Link copied to clipboard
inline suspend fun ResiliencehubClient.updateAppVersionAppComponent(crossinline block: UpdateAppVersionAppComponentRequest.Builder.() -> Unit): UpdateAppVersionAppComponentResponse

Updates an existing Application Component in the Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.updateAppVersionResource(crossinline block: UpdateAppVersionResourceRequest.Builder.() -> Unit): UpdateAppVersionResourceResponse

Updates the resource details in the Resilience Hub application.

Link copied to clipboard
inline suspend fun ResiliencehubClient.updateResiliencyPolicy(crossinline block: UpdateResiliencyPolicyRequest.Builder.() -> Unit): UpdateResiliencyPolicyResponse

Updates a resiliency policy.

Link copied to clipboard
fun ResiliencehubClient.withConfig(block: ResiliencehubClient.Config.Builder.() -> Unit): ResiliencehubClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.