resiliencehub function

AWS Resilience Hub

AWS Resilience Hub

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.

resiliencehub( config = list(), credentials = list(), endpoint = NULL, region = NULL )

Arguments

  • config: Optional configuration of credentials, endpoint, and/or region.

    • credentials :

      • creds :

        • access_key_id : AWS access key ID
        • secret_access_key : AWS secret access key
        • session_token : AWS temporary session token
      • profile : The name of a profile to use. If not given, then the default profile is used.

      • anonymous : Set anonymous credentials.

    • endpoint : The complete URL to use for the constructed client.

    • region : The AWS Region used in instantiating the client.

    • close_connection : Immediately close all HTTP connections.

    • timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

    • s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

    • sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

  • credentials: Optional credentials shorthand for the config parameter

    • creds :

      • access_key_id : AWS access key ID
      • secret_access_key : AWS secret access key
      • session_token : AWS temporary session token
    • profile : The name of a profile to use. If not given, then the default profile is used.

    • anonymous : Set anonymous credentials.

  • endpoint: Optional shorthand for complete URL to use for the constructed client.

  • region: Optional shorthand for AWS Region used in instantiating the client.

Returns

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- resiliencehub(
  config = list(
    credentials = list(
 creds = list(
   access_key_id = "string",
   secret_access_key = "string",
   session_token = "string"
 ),
 profile = "string",
 anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
 access_key_id = "string",
 secret_access_key = "string",
 session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

accept_resource_grouping_recommendationsAccepts the resource grouping recommendations suggested by Resilience Hub for your application
add_draft_app_version_resource_mappingsAdds the source of resource-maps to the draft version of an application
batch_update_recommendation_statusEnables you to include or exclude one or more operational recommendations
create_appCreates an Resilience Hub application
create_app_version_app_componentCreates a new Application Component in the Resilience Hub application
create_app_version_resourceAdds a resource to the Resilience Hub application and assigns it to the specified Application Components
create_recommendation_templateCreates a new recommendation template for the Resilience Hub application
create_resiliency_policyCreates a resiliency policy for an application
delete_appDeletes an Resilience Hub application
delete_app_assessmentDeletes an Resilience Hub application assessment
delete_app_input_sourceDeletes the input source and all of its imported resources from the Resilience Hub application
delete_app_version_app_componentDeletes an Application Component from the Resilience Hub application
delete_app_version_resourceDeletes a resource from the Resilience Hub application
delete_recommendation_templateDeletes a recommendation template
delete_resiliency_policyDeletes a resiliency policy
describe_appDescribes an Resilience Hub application
describe_app_assessmentDescribes an assessment for an Resilience Hub application
describe_app_versionDescribes the Resilience Hub application version
describe_app_version_app_componentDescribes an Application Component in the Resilience Hub application
describe_app_version_resourceDescribes a resource of the Resilience Hub application
describe_app_version_resources_resolution_statusReturns the resolution status for the specified resolution identifier for an application version
describe_app_version_templateDescribes details about an Resilience Hub application
describe_draft_app_version_resources_import_statusDescribes the status of importing resources to an application version
describe_metrics_exportDescribes the metrics of the application configuration being exported
describe_resiliency_policyDescribes a specified resiliency policy for an Resilience Hub application
describe_resource_grouping_recommendation_taskDescribes the resource grouping recommendation tasks run by Resilience Hub for your application
import_resources_to_draft_app_versionImports resources to Resilience Hub application draft version from different input sources
list_alarm_recommendationsLists the alarm recommendations for an Resilience Hub application
list_app_assessment_compliance_driftsList of compliance drifts that were detected while running an assessment
list_app_assessment_resource_driftsList of resource drifts that were detected while running an assessment
list_app_assessmentsLists the assessments for an Resilience Hub application
list_app_component_compliancesLists the compliances for an Resilience Hub Application Component
list_app_component_recommendationsLists the recommendations for an Resilience Hub Application Component
list_app_input_sourcesLists all the input sources of the Resilience Hub application
list_appsLists your Resilience Hub applications
list_app_version_app_componentsLists all the Application Components in the Resilience Hub application
list_app_version_resource_mappingsLists how the resources in an application version are mapped/sourced from
list_app_version_resourcesLists all the resources in an Resilience Hub application
list_app_versionsLists the different versions for the Resilience Hub applications
list_metricsLists the metrics that can be exported
list_recommendation_templatesLists the recommendation templates for the Resilience Hub applications
list_resiliency_policiesLists the resiliency policies for the Resilience Hub applications
list_resource_grouping_recommendationsLists the resource grouping recommendations suggested by Resilience Hub for your application
list_sop_recommendationsLists the standard operating procedure (SOP) recommendations for the Resilience Hub applications
list_suggested_resiliency_policiesLists the suggested resiliency policies for the Resilience Hub applications
list_tags_for_resourceLists the tags for your resources in your Resilience Hub applications
list_test_recommendationsLists the test recommendations for the Resilience Hub application
list_unsupported_app_version_resourcesLists the resources that are not currently supported in Resilience Hub
publish_app_versionPublishes a new version of a specific Resilience Hub application
put_draft_app_version_templateAdds or updates the app template for an Resilience Hub application draft version
reject_resource_grouping_recommendationsRejects resource grouping recommendations
remove_draft_app_version_resource_mappingsRemoves resource mappings from a draft application version
resolve_app_version_resourcesResolves the resources for an application version
start_app_assessmentCreates a new application assessment for an application
start_metrics_exportInitiates the export task of metrics
start_resource_grouping_recommendation_taskStarts grouping recommendation task
tag_resourceApplies one or more tags to a resource
untag_resourceRemoves one or more tags from a resource
update_appUpdates an application
update_app_versionUpdates the Resilience Hub application version
update_app_version_app_componentUpdates an existing Application Component in the Resilience Hub application
update_app_version_resourceUpdates the resource details in the Resilience Hub application
update_resiliency_policyUpdates a resiliency policy

Examples

## Not run: svc <- resiliencehub() svc$accept_resource_grouping_recommendations( Foo = 123 ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17