Expand 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.
If you’re using the service, you’re probably looking for BackupClient and Backup.
Structs§
- Backup
Client - A client for the AWS Backup API.
- Backup
Job Contains detailed information about a backup job.
- Backup
Plan Contains an optional backup plan display name and an array of
BackupRuleobjects, 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.- Backup
Plan Input Contains an optional backup plan display name and an array of
BackupRuleobjects, 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.- Backup
Plan Templates List Member An object specifying metadata associated with a backup plan template.
- Backup
Plans List Member Contains metadata about a backup plan.
- Backup
Rule Specifies a scheduled task used to back up a selection of resources.
- Backup
Rule Input Specifies a scheduled task used to back up a selection of resources.
- Backup
Selection Used to specify a set of resources to a backup plan.
- Backup
Selections List Member Contains metadata about a
BackupSelectionobject.- Backup
Vault List Member Contains metadata about a backup vault.
- Calculated
Lifecycle Contains
DeleteAtandMoveToColdStorageAttimestamps, 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.
- Condition
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.- Copy
Action The details of the copy operation.
- CopyJob
Contains detailed information about a copy job.
- Create
Backup Plan Input - Create
Backup Plan Output - Create
Backup Selection Input - Create
Backup Selection Output - Create
Backup Vault Input - Create
Backup Vault Output - Delete
Backup Plan Input - Delete
Backup Plan Output - Delete
Backup Selection Input - Delete
Backup Vault Access Policy Input - Delete
Backup Vault Input - Delete
Backup Vault Notifications Input - Delete
Recovery Point Input - Describe
Backup JobInput - Describe
Backup JobOutput - Describe
Backup Vault Input - Describe
Backup Vault Output - Describe
Copy JobInput - Describe
Copy JobOutput - Describe
Protected Resource Input - Describe
Protected Resource Output - Describe
Recovery Point Input - Describe
Recovery Point Output - Describe
Region Settings Input - Describe
Region Settings Output - Describe
Restore JobInput - Describe
Restore JobOutput - Export
Backup Plan Template Input - Export
Backup Plan Template Output - GetBackup
Plan FromJSON Input - GetBackup
Plan FromJSON Output - GetBackup
Plan From Template Input - GetBackup
Plan From Template Output - GetBackup
Plan Input - GetBackup
Plan Output - GetBackup
Selection Input - GetBackup
Selection Output - GetBackup
Vault Access Policy Input - GetBackup
Vault Access Policy Output - GetBackup
Vault Notifications Input - GetBackup
Vault Notifications Output - GetRecovery
Point Restore Metadata Input - GetRecovery
Point Restore Metadata Output - GetSupported
Resource Types Output - Lifecycle
Contains an array of
Transitionobjects 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.
- List
Backup Jobs Input - List
Backup Jobs Output - List
Backup Plan Templates Input - List
Backup Plan Templates Output - List
Backup Plan Versions Input - List
Backup Plan Versions Output - List
Backup Plans Input - List
Backup Plans Output - List
Backup Selections Input - List
Backup Selections Output - List
Backup Vaults Input - List
Backup Vaults Output - List
Copy Jobs Input - List
Copy Jobs Output - List
Protected Resources Input - List
Protected Resources Output - List
Recovery Points ByBackup Vault Input - List
Recovery Points ByBackup Vault Output - List
Recovery Points ByResource Input - List
Recovery Points ByResource Output - List
Restore Jobs Input - List
Restore Jobs Output - List
Tags Input - List
Tags Output - Protected
Resource A structure that contains information about a backed-up resource.
- PutBackup
Vault Access Policy Input - PutBackup
Vault Notifications Input - Recovery
Point ByBackup Vault Contains detailed information about the recovery points stored in a backup vault.
- Recovery
Point ByResource Contains detailed information about a saved recovery point.
- Recovery
Point Creator Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.
- Restore
Jobs List Member Contains metadata about a restore job.
- Start
Backup JobInput - Start
Backup JobOutput - Start
Copy JobInput - Start
Copy JobOutput - Start
Restore JobInput - Start
Restore JobOutput - Stop
Backup JobInput - TagResource
Input - Untag
Resource Input - Update
Backup Plan Input - Update
Backup Plan Output - Update
Recovery Point Lifecycle Input - Update
Recovery Point Lifecycle Output - Update
Region Settings Input
Enums§
- Create
Backup Plan Error - Errors returned by CreateBackupPlan
- Create
Backup Selection Error - Errors returned by CreateBackupSelection
- Create
Backup Vault Error - Errors returned by CreateBackupVault
- Delete
Backup Plan Error - Errors returned by DeleteBackupPlan
- Delete
Backup Selection Error - Errors returned by DeleteBackupSelection
- Delete
Backup Vault Access Policy Error - Errors returned by DeleteBackupVaultAccessPolicy
- Delete
Backup Vault Error - Errors returned by DeleteBackupVault
- Delete
Backup Vault Notifications Error - Errors returned by DeleteBackupVaultNotifications
- Delete
Recovery Point Error - Errors returned by DeleteRecoveryPoint
- Describe
Backup JobError - Errors returned by DescribeBackupJob
- Describe
Backup Vault Error - Errors returned by DescribeBackupVault
- Describe
Copy JobError - Errors returned by DescribeCopyJob
- Describe
Protected Resource Error - Errors returned by DescribeProtectedResource
- Describe
Recovery Point Error - Errors returned by DescribeRecoveryPoint
- Describe
Region Settings Error - Errors returned by DescribeRegionSettings
- Describe
Restore JobError - Errors returned by DescribeRestoreJob
- Export
Backup Plan Template Error - Errors returned by ExportBackupPlanTemplate
- GetBackup
Plan Error - Errors returned by GetBackupPlan
- GetBackup
Plan FromJSON Error - Errors returned by GetBackupPlanFromJSON
- GetBackup
Plan From Template Error - Errors returned by GetBackupPlanFromTemplate
- GetBackup
Selection Error - Errors returned by GetBackupSelection
- GetBackup
Vault Access Policy Error - Errors returned by GetBackupVaultAccessPolicy
- GetBackup
Vault Notifications Error - Errors returned by GetBackupVaultNotifications
- GetRecovery
Point Restore Metadata Error - Errors returned by GetRecoveryPointRestoreMetadata
- GetSupported
Resource Types Error - Errors returned by GetSupportedResourceTypes
- List
Backup Jobs Error - Errors returned by ListBackupJobs
- List
Backup Plan Templates Error - Errors returned by ListBackupPlanTemplates
- List
Backup Plan Versions Error - Errors returned by ListBackupPlanVersions
- List
Backup Plans Error - Errors returned by ListBackupPlans
- List
Backup Selections Error - Errors returned by ListBackupSelections
- List
Backup Vaults Error - Errors returned by ListBackupVaults
- List
Copy Jobs Error - Errors returned by ListCopyJobs
- List
Protected Resources Error - Errors returned by ListProtectedResources
- List
Recovery Points ByBackup Vault Error - Errors returned by ListRecoveryPointsByBackupVault
- List
Recovery Points ByResource Error - Errors returned by ListRecoveryPointsByResource
- List
Restore Jobs Error - Errors returned by ListRestoreJobs
- List
Tags Error - Errors returned by ListTags
- PutBackup
Vault Access Policy Error - Errors returned by PutBackupVaultAccessPolicy
- PutBackup
Vault Notifications Error - Errors returned by PutBackupVaultNotifications
- Start
Backup JobError - Errors returned by StartBackupJob
- Start
Copy JobError - Errors returned by StartCopyJob
- Start
Restore JobError - Errors returned by StartRestoreJob
- Stop
Backup JobError - Errors returned by StopBackupJob
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Backup Plan Error - Errors returned by UpdateBackupPlan
- Update
Recovery Point Lifecycle Error - Errors returned by UpdateRecoveryPointLifecycle
- Update
Region Settings Error - Errors returned by UpdateRegionSettings
Traits§
- Backup
- Trait representing the capabilities of the AWS Backup API. AWS Backup clients implement this trait.