class Aws::Backup::Types::BackupRule
Specifies a scheduled task used to back up a selection of resources.
@!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. For more information about cron expressions, see [Schedule Expressions for Rules][1] in the *Amazon CloudWatch Events User Guide.*. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools. [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html @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 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. @return [Types::Lifecycle]
@!attribute [rw] recovery_point_tags
An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup. @return [Hash<String,String>]
@!attribute [rw] rule_id
Uniquely identifies a rule that is used to schedule the backup of a selection of resources. @return [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/BackupRule AWS API Documentation
Constants
- SENSITIVE