BackupRule

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Functions

Link copied to clipboard
inline fun copy(block: BackupRule.Builder.() -> Unit = {}): BackupRule
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String