Class: Aws::Backup::Types::BackupRule

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#completion_window_minutesInteger

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.

Returns:

  • (Integer)


534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 534

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup)
  SENSITIVE = [:recovery_point_tags]
  include Aws::Structure
end

#copy_actionsArray<Types::CopyAction>

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

Returns:



534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 534

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup)
  SENSITIVE = [:recovery_point_tags]
  include Aws::Structure
end

#enable_continuous_backupBoolean

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.

Returns:

  • (Boolean)


534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 534

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup)
  SENSITIVE = [:recovery_point_tags]
  include Aws::Structure
end

#lifecycleTypes::Lifecycle

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires 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.

Returns:



534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 534

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup)
  SENSITIVE = [:recovery_point_tags]
  include Aws::Structure
end

#recovery_point_tagsHash<String,String>

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Returns:

  • (Hash<String,String>)


534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 534

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup)
  SENSITIVE = [:recovery_point_tags]
  include Aws::Structure
end

#rule_idString

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Returns:

  • (String)


534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 534

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup)
  SENSITIVE = [:recovery_point_tags]
  include Aws::Structure
end

#rule_nameString

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

Returns:

  • (String)


534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 534

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup)
  SENSITIVE = [:recovery_point_tags]
  include Aws::Structure
end

#schedule_expressionString

A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.

Returns:

  • (String)


534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 534

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup)
  SENSITIVE = [:recovery_point_tags]
  include Aws::Structure
end

#start_window_minutesInteger

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)


534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 534

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup)
  SENSITIVE = [:recovery_point_tags]
  include Aws::Structure
end

#target_backup_vault_nameString

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.

Returns:

  • (String)


534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 534

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup)
  SENSITIVE = [:recovery_point_tags]
  include Aws::Structure
end