AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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
    },
  ],
  enable_continuous_backup: false,
}

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

See Also:

Constant Summary collapse

SENSITIVE = 
[:recovery_point_tags]

Instance Attribute Summary collapse

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.

Returns:

  • (Integer) 


623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 623

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.

Returns:



623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 623

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 AWS Backup creates continuous backups. True causes AWS Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes AWS Backup to create snapshot backups.

Returns:

  • (Boolean) 


623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 623

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. 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Returns:



623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 623

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.

Returns:

  • (Hash<String,String>) 


623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 623

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

An optional display name for a backup rule.

Returns:

  • (String) 


623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 623

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 specifying when AWS Backup initiates a backup job.

Returns:

  • (String) 


623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 623

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.

Returns:

  • (Integer) 


623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 623

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

  • (String) 


623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 623

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