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

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

Overview

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 Backup. This value is optional.

Returns:

  • (Integer) 


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :target_logically_air_gapped_backup_vault_arn,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup,
  :schedule_expression_timezone,
  :index_actions,
  :scan_actions)
  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:



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :target_logically_air_gapped_backup_vault_arn,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup,
  :schedule_expression_timezone,
  :index_actions,
  :scan_actions)
  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.

Returns:

  • (Boolean) 


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

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

#index_actions ⇒ Array<Types::IndexAction>

IndexActions is an array you use to specify how backup data should be indexed.

eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up to one index associated with it.

Within the array is ResourceType. Only one will be accepted for each BackupRule.

Returns:



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :target_logically_air_gapped_backup_vault_arn,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup,
  :schedule_expression_timezone,
  :index_actions,
  :scan_actions)
  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 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 can transition to cold storage are listed in the

Feature availability by resource][1

table. Backup ignores this

expression for other resource types.

[1]: docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource

Returns:



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

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

#recovery_point_tags ⇒ Hash<String,String>

The tags that are assigned to resources that are associated with this rule when restored from backup.

Returns:

  • (Hash<String,String>) 


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

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

#rule_id ⇒ String

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

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :target_logically_air_gapped_backup_vault_arn,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup,
  :schedule_expression_timezone,
  :index_actions,
  :scan_actions)
  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.

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

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

#scan_actions ⇒ Array<Types::ScanAction>

Contains your scanning configuration for the backup rule and includes the malware scanner, and scan mode of either full or incremental.

Returns:



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

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

#schedule_expression ⇒ String

A cron expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression ‘cron(0 5 ? * * *)`.

For more information about Amazon Web Services cron expressions, see

Schedule Expressions for Rules][1

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.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

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

#schedule_expression_timezone ⇒ String

The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :target_logically_air_gapped_backup_vault_arn,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup,
  :schedule_expression_timezone,
  :index_actions,
  :scan_actions)
  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.

During the start window, the backup job status remains in ‘CREATED` status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to `RUNNING`) or until the job status changes to `EXPIRED` (which is expected to occur when the start window time is over).

Returns:

  • (Integer) 


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

class BackupRule < Struct.new(
  :rule_name,
  :target_backup_vault_name,
  :target_logically_air_gapped_backup_vault_arn,
  :schedule_expression,
  :start_window_minutes,
  :completion_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :rule_id,
  :copy_actions,
  :enable_continuous_backup,
  :schedule_expression_timezone,
  :index_actions,
  :scan_actions)
  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.

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

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

#target_logically_air_gapped_backup_vault_arn ⇒ String

The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-backup/types.rb', line 806

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