Class: Aws::Backup::Types::BackupRuleInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::BackupRuleInput
- Defined in:
- gems/aws-sdk-backup/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.
-
#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>
To help organize your resources, you can assign your own metadata to the resources that you create.
-
#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.
-
#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.
584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 584 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) 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.
584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 584 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) 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.
584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 584 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) 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.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 584 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) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#recovery_point_tags ⇒ Hash<String,String>
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 584 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) 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.
584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 584 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) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |
#schedule_expression ⇒ String
A CRON expression in UTC specifying when Backup initiates a backup job.
584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 584 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) 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.
584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 584 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) 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. They consist of lowercase letters, numbers, and hyphens.
584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 584 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) SENSITIVE = [:recovery_point_tags] include Aws::Structure end |