Learn R Programming

paws.storage (version 0.1.12)

backup: AWS Backup

Description

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

Usage

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

Service syntax

svc <- backup(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_backup_planCreates a backup plan using a backup plan name and backup rules
create_backup_selectionCreates a JSON document that specifies a set of resources to assign to a backup plan
create_backup_vaultCreates a logical container where backups are stored
delete_backup_planDeletes a backup plan
delete_backup_selectionDeletes the resource selection associated with a backup plan that is specified by the SelectionId
delete_backup_vaultDeletes the backup vault identified by its name
delete_backup_vault_access_policyDeletes the policy document that manages permissions on a backup vault
delete_backup_vault_notificationsDeletes event notifications for the specified backup vault
delete_recovery_pointDeletes the recovery point specified by a recovery point ID
describe_backup_jobReturns backup job details for the specified BackupJobId
describe_backup_vaultReturns metadata about a backup vault specified by its name
describe_copy_jobReturns metadata associated with creating a copy of a resource
describe_global_settingsThe current feature settings for the AWS Account
describe_protected_resourceReturns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource
describe_recovery_pointReturns metadata associated with a recovery point, including ID, status, encryption, and lifecycle
describe_region_settingsReturns the current service opt-in settings for the Region
describe_restore_jobReturns metadata associated with a restore job that is specified by a job ID
export_backup_plan_templateReturns the backup plan that is specified by the plan ID as a backup template
get_backup_planReturns BackupPlan details for the specified BackupPlanId
get_backup_plan_from_jsonReturns a valid JSON document specifying a backup plan or an error
get_backup_plan_from_templateReturns the template specified by its templateId as a backup plan
get_backup_selectionReturns 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_policyReturns the access policy document that is associated with the named backup vault
get_backup_vault_notificationsReturns event notifications for the specified backup vault
get_recovery_point_restore_metadataReturns a set of metadata key-value pairs that were used to create the backup
get_supported_resource_typesReturns the AWS resource types supported by AWS Backup
list_backup_jobsReturns a list of existing backup jobs for an authenticated account
list_backup_plansReturns a list of existing backup plans for an authenticated account
list_backup_plan_templatesReturns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates
list_backup_plan_versionsReturns 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_selectionsReturns an array containing metadata of the resources associated with the target backup plan
list_backup_vaultsReturns a list of recovery point storage containers along with information about them
list_copy_jobsReturns metadata about your copy jobs
list_protected_resourcesReturns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type
list_recovery_points_by_backup_vaultReturns detailed information about the recovery points stored in a backup vault
list_recovery_points_by_resourceReturns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN)
list_restore_jobsReturns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process
list_tagsReturns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault
put_backup_vault_access_policySets a resource-based policy that is used to manage access permissions on the target backup vault
put_backup_vault_notificationsTurns on notifications on a backup vault for the specified topic and events
start_backup_jobStarts an on-demand backup job for the specified resource
start_copy_jobStarts a job to create a one-time copy of the specified resource
start_restore_jobRecovers the saved resource identified by an Amazon Resource Name (ARN)
stop_backup_jobAttempts to cancel a job to create a one-time backup of a resource
tag_resourceAssigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
untag_resourceRemoves a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
update_backup_planUpdates an existing backup plan identified by its backupPlanId with the input document in JSON format
update_global_settingsUpdates the current global settings for the AWS Account
update_recovery_point_lifecycleSets the transition lifecycle of a recovery point
update_region_settingsUpdates the current service opt-in settings for the Region

Examples

Run this code
if (FALSE) {
svc <- backup()
svc$create_backup_plan(
  Foo = 123
)
}

Run the code above in your browser using DataLab