BackupRule - Amazon Backup
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

BackupRule

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

Contents

RuleName

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

Type: String

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

Required: Yes

TargetBackupVaultName

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

Type: String

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

Required: Yes

CompletionWindowMinutes

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

Type: Long

Required: No

CopyActions

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

Type: Array of CopyAction objects

Required: No

EnableContinuousBackup

Specifies whether Amazon Backup creates continuous backups. True causes Amazon Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Amazon Backup to create snapshot backups.

Type: Boolean

Required: No

Lifecycle

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Amazon 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. Amazon Backup ignores this expression for other resource types.

Type: Lifecycle object

Required: No

RecoveryPointTags

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

Type: String to string map

Required: No

RuleId

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

Type: String

Required: No

ScheduleExpression

A cron expression in UTC specifying when Amazon Backup initiates a backup job. For more information about Amazon cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon 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.

Type: String

Required: No

ScheduleExpressionTimezone

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.

Type: String

Required: No

StartWindowMinutes

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 Amazon Backup receives an error that allows the job to be retried, Amazon 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).

Type: Long

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: