resiliencehub: AWS Resilience Hub

In paws: Amazon Web Services Software Development Kit

AWS Resilience Hub

Description

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.

Usage

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.

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.

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_recommendations	Accepts the resource grouping recommendations suggested by Resilience Hub for your application
add_draft_app_version_resource_mappings	Adds the source of resource-maps to the draft version of an application
batch_update_recommendation_status	Enables you to include or exclude one or more operational recommendations
create_app	Creates an Resilience Hub application
create_app_version_app_component	Creates a new Application Component in the Resilience Hub application
create_app_version_resource	Adds a resource to the Resilience Hub application and assigns it to the specified Application Components
create_recommendation_template	Creates a new recommendation template for the Resilience Hub application
create_resiliency_policy	Creates a resiliency policy for an application
delete_app	Deletes an Resilience Hub application
delete_app_assessment	Deletes an Resilience Hub application assessment
delete_app_input_source	Deletes the input source and all of its imported resources from the Resilience Hub application
delete_app_version_app_component	Deletes an Application Component from the Resilience Hub application
delete_app_version_resource	Deletes a resource from the Resilience Hub application
delete_recommendation_template	Deletes a recommendation template
delete_resiliency_policy	Deletes a resiliency policy
describe_app	Describes an Resilience Hub application
describe_app_assessment	Describes an assessment for an Resilience Hub application
describe_app_version	Describes the Resilience Hub application version
describe_app_version_app_component	Describes an Application Component in the Resilience Hub application
describe_app_version_resource	Describes a resource of the 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 Resilience Hub application
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 Resilience Hub application
describe_resource_grouping_recommendation_task	Describes the resource grouping recommendation tasks run by Resilience Hub for your application
import_resources_to_draft_app_version	Imports resources to Resilience Hub application draft version from different input sources
list_alarm_recommendations	Lists the alarm recommendations for an Resilience Hub application
list_app_assessment_compliance_drifts	List of compliance drifts that were detected while running an assessment
list_app_assessment_resource_drifts	Indicates the list of resource drifts that were detected while running an assessment
list_app_assessments	Lists the assessments for an Resilience Hub application
list_app_component_compliances	Lists the compliances for an Resilience Hub Application Component
list_app_component_recommendations	Lists the recommendations for an Resilience Hub Application Component
list_app_input_sources	Lists all the input sources of the Resilience Hub application
list_apps	Lists your Resilience Hub applications
list_app_version_app_components	Lists all the Application Components in the Resilience Hub application
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 Resilience Hub application
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_resource_grouping_recommendations	Lists the resource grouping recommendations suggested by Resilience Hub for your application
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 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 an Resilience Hub application draft version
reject_resource_grouping_recommendations	Rejects resource grouping recommendations
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
start_resource_grouping_recommendation_task	Starts grouping recommendation task
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_app_version	Updates the Resilience Hub application version
update_app_version_app_component	Updates an existing Application Component in the Resilience Hub application
update_app_version_resource	Updates the resource details in the Resilience Hub application
update_resiliency_policy	Updates a resiliency policy

Examples

## Not run: 
svc <- resiliencehub()
svc$accept_resource_grouping_recommendations(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 17, 2024, 5:07 p.m.