Class: Aws::Backup::Types::BackupRuleInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::BackupRuleInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-backup/types.rb
Overview
Specifies a scheduled task used to back up a selection of resources.
Constant Summary collapse
- SENSITIVE =
[:recovery_point_tags]
Instance Attribute Summary collapse
-
#completion_window_minutes ⇒ Integer
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup.
-
#copy_actions ⇒ Array<Types::CopyAction>
An array of ‘CopyAction` objects, which contains the details of the copy operation.
-
#enable_continuous_backup ⇒ Boolean
Specifies whether Backup creates continuous backups.
-
#index_actions ⇒ Array<Types::IndexAction>
There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.
-
#lifecycle ⇒ Types::Lifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
-
#recovery_point_tags ⇒ Hash<String,String>
The tags to assign to the resources.
-
#rule_name ⇒ String
A display name for a backup rule.
-
#schedule_expression ⇒ String
A CRON expression in UTC specifying when Backup initiates a backup job.
-
#schedule_expression_timezone ⇒ String
The timezone in which the schedule expression is set.
-
#start_window_minutes ⇒ Integer
A value in minutes after a backup is scheduled before a job will be canceled if it doesn’t start successfully.
-
#target_backup_vault_name ⇒ String
The name of a logical container where backups are stored.
Instance Attribute Details
#completion_window_minutes ⇒ Integer
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.
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#copy_actions ⇒ Array<Types::CopyAction>
An array of ‘CopyAction` objects, which contains the details of the copy operation.
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#enable_continuous_backup ⇒ Boolean
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.
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#index_actions ⇒ Array<Types::IndexAction>
There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.
Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:
-
‘EBS` for Amazon Elastic Block Store
-
‘S3` for Amazon Simple Storage Service (Amazon S3)
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#lifecycle ⇒ Types::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 “retention” 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 storage.
Resource types that can transition to cold storage are listed in the
- Feature availability by resource][1
-
table. Backup ignores this
expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
[1]: docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#recovery_point_tags ⇒ Hash<String,String>
The tags to assign to the resources.
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#rule_name ⇒ String
A display name for a backup rule. Must contain 1 to 50 alphanumeric or ‘-_.’ characters.
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#schedule_expression ⇒ String
A CRON expression in UTC specifying when Backup initiates a backup job.
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#schedule_expression_timezone ⇒ String
The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#start_window_minutes ⇒ Integer
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. If this value is included, it must be at least 60 minutes to avoid errors.
This parameter has a maximum value of 100 years (52,560,000 minutes).
During the start window, the backup job status remains in ‘CREATED` status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to `RUNNING`) or until the job status changes to `EXPIRED` (which is expected to occur when the start window time is over).
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#target_backup_vault_name ⇒ String
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.
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/aws-sdk-backup/types.rb', line 750 class BackupRuleInput < Struct.new( :rule_name, :target_backup_vault_name, :schedule_expression, :start_window_minutes, :completion_window_minutes, :lifecycle, :recovery_point_tags, :copy_actions, :enable_continuous_backup, :schedule_expression_timezone, :index_actions) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |