route53recoveryreadiness function

AWS Route53 Recovery Readiness

AWS Route53 Recovery Readiness

Recovery readiness

route53recoveryreadiness( 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 <- route53recoveryreadiness(
  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

create_cellCreates a cell in an account
create_cross_account_authorizationCreates a cross-account readiness authorization
create_readiness_checkCreates a readiness check in an account
create_recovery_groupCreates a recovery group in an account
create_resource_setCreates a resource set
delete_cellDelete a cell
delete_cross_account_authorizationDeletes cross account readiness authorization
delete_readiness_checkDeletes a readiness check
delete_recovery_groupDeletes a recovery group
delete_resource_setDeletes a resource set
get_architecture_recommendationsGets recommendations about architecture designs for improving resiliency for an application, based on a recovery group
get_cellGets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs
get_cell_readiness_summaryGets readiness for a cell
get_readiness_checkGets details about a readiness check
get_readiness_check_resource_statusGets individual readiness status for a readiness check
get_readiness_check_statusGets the readiness status for an individual readiness check
get_recovery_groupGets details about a recovery group, including a list of the cells that are included in it
get_recovery_group_readiness_summaryDisplays a summary of information about a recovery group's readiness status
get_resource_setDisplays the details about a resource set, including a list of the resources in the set
list_cellsLists the cells for an account
list_cross_account_authorizationsLists the cross-account readiness authorizations that are in place for an account
list_readiness_checksLists the readiness checks for an account
list_recovery_groupsLists the recovery groups in an account
list_resource_setsLists the resource sets in an account
list_rulesLists all readiness rules, or lists the readiness rules for a specific resource type
list_tags_for_resourcesLists the tags for a resource
tag_resourceAdds a tag to a resource
untag_resourceRemoves a tag from a resource
update_cellUpdates a cell to replace the list of nested cells with a new list of nested cells
update_readiness_checkUpdates a readiness check
update_recovery_groupUpdates a recovery group
update_resource_setUpdates a resource set

Examples

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