You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Backup::Types::BackupRuleInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

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
    },
  ],
}

Specifies a scheduled task used to back up a selection of resources.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#completion_window_minutes ⇒ Integer

The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

Returns:

  • (Integer) 


474
475
476
477
478
479
480
481
482
483
484
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 474

class BackupRuleInput < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :copy_actions)
  include Aws::Structure
end

#copy_actions ⇒ Array<Types::CopyAction>

An array of CopyAction objects, which contains the details of the copy operation.

Returns:



474
475
476
477
478
479
480
481
482
483
484
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 474

class BackupRuleInput < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :copy_actions)
  include Aws::Structure
end

#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”. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Returns:



474
475
476
477
478
479
480
481
482
483
484
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 474

class BackupRuleInput < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :copy_actions)
  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.

Returns:

  • (Hash<String,String>) 


474
475
476
477
478
479
480
481
482
483
484
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 474

class BackupRuleInput < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :copy_actions)
  include Aws::Structure
end

#rule_name ⇒ String

>An optional display name for a backup rule.

Returns:

  • (String) 


474
475
476
477
478
479
480
481
482
483
484
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 474

class BackupRuleInput < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :copy_actions)
  include Aws::Structure
end

#schedule_expression ⇒ String

A CRON expression specifying when AWS Backup initiates a backup job.

Returns:

  • (String) 


474
475
476
477
478
479
480
481
482
483
484
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 474

class BackupRuleInput < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :copy_actions)
  include Aws::Structure
end

#start_window_minutes ⇒ Integer

The amount of time in minutes before beginning a backup.

Returns:

  • (Integer) 


474
475
476
477
478
479
480
481
482
483
484
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 474

class BackupRuleInput < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :copy_actions)
  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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

  • (String) 


474
475
476
477
478
479
480
481
482
483
484
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 474

class BackupRuleInput < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :copy_actions)
  include Aws::Structure
end