paws (version 0.2.0)

resiliencehub: AWS Resilience Hub

Description

AWS Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. Resilience Hub offers continuous 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.

Usage

resiliencehub(config = list())

Value

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.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• 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.

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"
  )
)

Operations

add_draft_app_version_resource_mappings	Adds the resource mapping for the draft application version
create_app	Creates a Resilience Hub application
create_recommendation_template	Creates a new recommendation template
create_resiliency_policy	Creates a resiliency policy for an application
delete_app	Deletes an AWS Resilience Hub application
delete_app_assessment	Deletes an AWS Resilience Hub application assessment
delete_recommendation_template	Deletes a recommendation template
delete_resiliency_policy	Deletes a resiliency policy
describe_app	Describes an AWS Resilience Hub application
describe_app_assessment	Describes an assessment for an AWS Resilience Hub application
describe_app_version_resources_resolution_status	Returns the resolution status for the specified resolution identifier for an application version
describe_app_version_template	Describes details about an AWS Resilience Hub
describe_draft_app_version_resources_import_status	Describes the status of importing resources to an application version
describe_resiliency_policy	Describes a specified resiliency policy for an AWS Resilience Hub application
import_resources_to_draft_app_version	Imports resources from sources such as a CloudFormation stack, resource-groups, or application registry app to a draft application version
list_alarm_recommendations	Lists the alarm recommendations for a AWS Resilience Hub application
list_app_assessments	Lists the assessments for an AWS Resilience Hub application
list_app_component_compliances	Lists the compliances for an AWS Resilience Hub component
list_app_component_recommendations	Lists the recommendations for an AWS Resilience Hub component
list_apps	Lists your Resilience Hub applications
list_app_version_resource_mappings	Lists how the resources in an application version are mapped/sourced from
list_app_version_resources	Lists all the resources in an application version
list_app_versions	Lists the different versions for the Resilience Hub applications
list_recommendation_templates	Lists the recommendation templates for the Resilience Hub applications
list_resiliency_policies	Lists the resiliency policies for the Resilience Hub applications
list_sop_recommendations	Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications
list_suggested_resiliency_policies	Lists the suggested resiliency policies for the Resilience Hub applications
list_tags_for_resource	Lists the tags for your resources in your Resilience Hub applications
list_test_recommendations	Lists the test recommendations for the Resilience Hub application
list_unsupported_app_version_resources	Lists the resources that are not currently supported in AWS Resilience Hub
publish_app_version	Publishes a new version of a specific Resilience Hub application
put_draft_app_version_template	Adds or updates the app template for a draft version of a Resilience Hub app
remove_draft_app_version_resource_mappings	Removes resource mappings from a draft application version
resolve_app_version_resources	Resolves the resources for an application version
start_app_assessment	Creates a new application assessment for an application
tag_resource	Applies one or more tags to a resource
untag_resource	Removes one or more tags from a resource
update_app	Updates an application
update_resiliency_policy	Updates a resiliency policy

Examples

if (FALSE) {
svc <- resiliencehub()
svc$add_draft_app_version_resource_mappings(
  Foo = 123
)
}