class Aws::Backup::Types::BackupRuleInput
Specifies a scheduled task used to back up a selection of resources.
@note When making an API call, you may pass BackupRuleInput
data as a hash: { rule_name: "BackupRuleName", # required target_backup_vault_name: "BackupVaultName", # required schedule_expression: "CronExpression", start_window_minutes: 1, completion_window_minutes: 1, lifecycle: { move_to_cold_storage_after_days: 1, delete_after_days: 1, }, recovery_point_tags: { "TagKey" => "TagValue", }, copy_actions: [ { lifecycle: { move_to_cold_storage_after_days: 1, delete_after_days: 1, }, destination_backup_vault_arn: "ARN", # required }, ], enable_continuous_backup: false, }
@!attribute [rw] rule_name
An optional display name for a backup rule. @return [String]
@!attribute [rw] target_backup_vault_name
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens. @return [String]
@!attribute [rw] schedule_expression
A CRON expression in UTC specifying when Backup initiates a backup job. @return [String]
@!attribute [rw] start_window_minutes
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. @return [Integer]
@!attribute [rw] completion_window_minutes
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional. @return [Integer]
@!attribute [rw] lifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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. @return [Types::Lifecycle]
@!attribute [rw] recovery_point_tags
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. @return [Hash<String,String>]
@!attribute [rw] copy_actions
An array of `CopyAction` objects, which contains the details of the copy operation. @return [Array<Types::CopyAction>]
@!attribute [rw] enable_continuous_backup
Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups. @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupRuleInput AWS API Documentation
Constants
- SENSITIVE