backup {paws.storage}

AWS Backup

Description

Backup

Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

Usage

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

cancel_legal_hold	This action removes the specified legal hold on a recovery point
create_backup_plan	Creates a backup plan using a backup plan name and backup rules
create_backup_selection	Creates a JSON document that specifies a set of resources to assign to a backup plan
create_backup_vault	Creates a logical container where backups are stored
create_framework	Creates a framework with one or more controls
create_legal_hold	This action creates a legal hold on a recovery point (backup)
create_logically_air_gapped_backup_vault	This request creates a logical container to where backups may be copied
create_report_plan	Creates a report plan
create_restore_testing_plan	This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection
create_restore_testing_selection	This request can be sent after CreateRestoreTestingPlan request returns successfully
delete_backup_plan	Deletes a backup plan
delete_backup_selection	Deletes the resource selection associated with a backup plan that is specified by the SelectionId
delete_backup_vault	Deletes the backup vault identified by its name
delete_backup_vault_access_policy	Deletes the policy document that manages permissions on a backup vault
delete_backup_vault_lock_configuration	Deletes Backup Vault Lock from a backup vault specified by a backup vault name
delete_backup_vault_notifications	Deletes event notifications for the specified backup vault
delete_framework	Deletes the framework specified by a framework name
delete_recovery_point	Deletes the recovery point specified by a recovery point ID
delete_report_plan	Deletes the report plan specified by a report plan name
delete_restore_testing_plan	This request deletes the specified restore testing plan
delete_restore_testing_selection	Input the Restore Testing Plan name and Restore Testing Selection name
describe_backup_job	Returns backup job details for the specified BackupJobId
describe_backup_vault	Returns metadata about a backup vault specified by its name
describe_copy_job	Returns metadata associated with creating a copy of a resource
describe_framework	Returns the framework details for the specified FrameworkName
describe_global_settings	Describes whether the Amazon Web Services account is opted in to cross-account backup
describe_protected_resource	Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource
describe_recovery_point	Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle
describe_region_settings	Returns the current service opt-in settings for the Region
describe_report_job	Returns the details associated with creating a report as specified by its ReportJobId
describe_report_plan	Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region
describe_restore_job	Returns metadata associated with a restore job that is specified by a job ID
disassociate_recovery_point	Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS
disassociate_recovery_point_from_parent	This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point
export_backup_plan_template	Returns the backup plan that is specified by the plan ID as a backup template
get_backup_plan	Returns BackupPlan details for the specified BackupPlanId
get_backup_plan_from_json	Returns a valid JSON document specifying a backup plan or an error
get_backup_plan_from_template	Returns the template specified by its templateId as a backup plan
get_backup_selection	Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan
get_backup_vault_access_policy	Returns the access policy document that is associated with the named backup vault
get_backup_vault_notifications	Returns event notifications for the specified backup vault
get_legal_hold	This action returns details for a specified legal hold
get_recovery_point_restore_metadata	Returns a set of metadata key-value pairs that were used to create the backup
get_restore_job_metadata	This request returns the metadata for the specified restore job
get_restore_testing_inferred_metadata	This request returns the minimal required set of metadata needed to start a restore job with secure default settings
get_restore_testing_plan	Returns RestoreTestingPlan details for the specified RestoreTestingPlanName
get_restore_testing_selection	Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan
get_supported_resource_types	Returns the Amazon Web Services resource types supported by Backup
list_backup_jobs	Returns a list of existing backup jobs for an authenticated account for the last 30 days
list_backup_job_summaries	This is a request for a summary of backup jobs created or running within the most recent 30 days
list_backup_plans	Returns a list of all active backup plans for an authenticated account
list_backup_plan_templates	Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates
list_backup_plan_versions	Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs
list_backup_selections	Returns an array containing metadata of the resources associated with the target backup plan
list_backup_vaults	Returns a list of recovery point storage containers along with information about them
list_copy_jobs	Returns metadata about your copy jobs
list_copy_job_summaries	This request obtains a list of copy jobs created or running within the the most recent 30 days
list_frameworks	Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region
list_legal_holds	This action returns metadata about active and previous legal holds
list_protected_resources	Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type
list_protected_resources_by_backup_vault	This request lists the protected resources corresponding to each backup vault
list_recovery_points_by_backup_vault	Returns detailed information about the recovery points stored in a backup vault
list_recovery_points_by_legal_hold	This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold
list_recovery_points_by_resource	Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN)
list_report_jobs	Returns details about your report jobs
list_report_plans	Returns a list of your report plans
list_restore_jobs	Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process
list_restore_jobs_by_protected_resource	This returns restore jobs that contain the specified protected resource
list_restore_job_summaries	This request obtains a summary of restore jobs created or running within the the most recent 30 days
list_restore_testing_plans	Returns a list of restore testing plans
list_restore_testing_selections	Returns a list of restore testing selections
list_tags	Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault
put_backup_vault_access_policy	Sets a resource-based policy that is used to manage access permissions on the target backup vault
put_backup_vault_lock_configuration	Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault
put_backup_vault_notifications	Turns on notifications on a backup vault for the specified topic and events
put_restore_validation_result	This request allows you to send your independent self-run restore test validation results
start_backup_job	Starts an on-demand backup job for the specified resource
start_copy_job	Starts a job to create a one-time copy of the specified resource
start_report_job	Starts an on-demand report job for the specified report plan
start_restore_job	Recovers the saved resource identified by an Amazon Resource Name (ARN)
stop_backup_job	Attempts to cancel a job to create a one-time backup of a resource
tag_resource	Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
untag_resource	Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
update_backup_plan	Updates an existing backup plan identified by its backupPlanId with the input document in JSON format
update_framework	Updates an existing framework identified by its FrameworkName with the input document in JSON format
update_global_settings	Updates whether the Amazon Web Services account is opted in to cross-account backup
update_recovery_point_lifecycle	Sets the transition lifecycle of a recovery point
update_region_settings	Updates the current service opt-in settings for the Region
update_report_plan	Updates an existing report plan identified by its ReportPlanName with the input document in JSON format
update_restore_testing_plan	This request will send changes to your specified restore testing plan
update_restore_testing_selection	Most elements except the RestoreTestingSelectionName can be updated with this request

Examples

## Not run: 
svc <- backup()
svc$cancel_legal_hold(
  Foo = 123
)

## End(Not run)