AWS Backup
Developer Guide

BackupRule

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

Contents

CompletionWindowMinutes

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.

Type: Long

Required: No

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.

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

RuleName

An optional display name for a backup rule.

Type: String

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

Required: Yes

ScheduleExpression

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

Type: String

Required: No

StartWindowMinutes

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.

Type: Long

Required: No

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

Type: String

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

Required: Yes

See Also

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

On this page: