AWS Backup
Developer Guide

BackupRuleInput

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

Contents

CompletionWindowMinutes

The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

Type: Long

Required: No

Lifecycle

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire 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”. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Type: Lifecycle object

Required: No

RecoveryPointTags

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Type: String to string map

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

The amount of time in minutes before beginning a backup.

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: