logo
Expand description

AWS Backup

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.

If you’re using the service, you’re probably looking for BackupClient and Backup.

Structs

A list of backup options for each resource type.

A client for the AWS Backup API.

Contains detailed information about a backup job.

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

An object specifying metadata associated with a backup plan template.

Contains metadata about a backup plan.

Specifies a scheduled task used to back up a selection of resources.

Specifies a scheduled task used to back up a selection of resources.

Used to specify a set of resources to a backup plan.

Contains metadata about a BackupSelection object.

Contains metadata about a backup vault.

Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

Contains an array of triplets made up of a condition type (such as StringEquals), a key, and a value. Conditions are used to filter resources in a selection that is assigned to a backup plan.

The details of the copy operation.

Contains detailed information about a copy job.

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

A structure that contains information about a backed-up resource.

Contains detailed information about the recovery points stored in a backup vault.

Contains detailed information about a saved recovery point.

Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.

Contains metadata about a restore job.

Enums

Errors returned by CreateBackupPlan

Errors returned by CreateBackupSelection

Errors returned by CreateBackupVault

Errors returned by DeleteBackupPlan

Errors returned by DeleteBackupSelection

Errors returned by DeleteBackupVaultAccessPolicy

Errors returned by DeleteBackupVault

Errors returned by DeleteBackupVaultNotifications

Errors returned by DeleteRecoveryPoint

Errors returned by DescribeBackupJob

Errors returned by DescribeBackupVault

Errors returned by DescribeCopyJob

Errors returned by DescribeGlobalSettings

Errors returned by DescribeProtectedResource

Errors returned by DescribeRecoveryPoint

Errors returned by DescribeRegionSettings

Errors returned by DescribeRestoreJob

Errors returned by DisassociateRecoveryPoint

Errors returned by ExportBackupPlanTemplate

Errors returned by GetBackupPlan

Errors returned by GetBackupPlanFromJSON

Errors returned by GetBackupPlanFromTemplate

Errors returned by GetBackupSelection

Errors returned by GetBackupVaultAccessPolicy

Errors returned by GetBackupVaultNotifications

Errors returned by GetRecoveryPointRestoreMetadata

Errors returned by GetSupportedResourceTypes

Errors returned by ListBackupJobs

Errors returned by ListBackupPlanTemplates

Errors returned by ListBackupPlanVersions

Errors returned by ListBackupPlans

Errors returned by ListBackupSelections

Errors returned by ListBackupVaults

Errors returned by ListCopyJobs

Errors returned by ListProtectedResources

Errors returned by ListRecoveryPointsByBackupVault

Errors returned by ListRecoveryPointsByResource

Errors returned by ListRestoreJobs

Errors returned by ListTags

Errors returned by PutBackupVaultAccessPolicy

Errors returned by PutBackupVaultNotifications

Errors returned by StartBackupJob

Errors returned by StartCopyJob

Errors returned by StartRestoreJob

Errors returned by StopBackupJob

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateBackupPlan

Errors returned by UpdateGlobalSettings

Errors returned by UpdateRecoveryPointLifecycle

Errors returned by UpdateRegionSettings

Traits

Trait representing the capabilities of the AWS Backup API. AWS Backup clients implement this trait.