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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

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

Returns:

  • (Integer)

    A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup.

#lifecycleTypes::Lifecycle

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

Returns:

  • (Types::Lifecycle)

    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.

#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>)

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

#rule_idString

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

Returns:

  • (String)

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

#rule_nameString

An optional display name for a backup rule.

Returns:

  • (String)

    An optional display name for a backup rule.

#schedule_expressionString

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

Returns:

  • (String)

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

#start_window_minutesInteger

An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn\'t start successfully.

Returns:

  • (Integer)

    An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn\'t start successfully.

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

Returns:

  • (String)

    The name of a logical container where backups are stored.