You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Backup::Types::BackupRuleInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::BackupRuleInput
- Defined in:
- (unknown)
Overview
When passing BackupRuleInput as input to an Aws::Client method, you can use a vanilla 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
},
],
}
Specifies a scheduled task used to back up a selection of resources.
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 AWS Backup.
-
#copy_actions ⇒ Array<Types::CopyAction>
An array of
CopyAction
objects, which contains the details of the copy operation. -
#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
An optional display name for a backup rule.
-
#schedule_expression ⇒ String
A CRON expression specifying when AWS 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 AWS Backup. This value is optional.
#copy_actions ⇒ Array<Types::CopyAction>
An array of CopyAction
objects, which contains the details of the copy
operation.
#lifecycle ⇒ Types::Lifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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.
#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.
#rule_name ⇒ String
An optional display name for a backup rule.
#schedule_expression ⇒ String
A CRON expression specifying when AWS 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. This value is optional.
#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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.