AWS::Backup::BackupPlan BackupRuleResourceType

Specifies an object containing properties used to schedule a task to back up a selection of resources.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "CompletionWindowMinutes" : Number,
  "CopyActions" : [ CopyActionResourceType, ... ],
  "EnableContinuousBackup" : Boolean,
  "Lifecycle" : LifecycleResourceType,
  "RecoveryPointTags" : {Key: Value, ...},
  "RuleName" : String,
  "ScheduleExpression" : String,
  "ScheduleExpressionTimezone" : String,
  "StartWindowMinutes" : Number,
  "TargetBackupVault" : String
}

YAML

  CompletionWindowMinutes: Number
  CopyActions: 
    - CopyActionResourceType
  EnableContinuousBackup: Boolean
  Lifecycle: 
    LifecycleResourceType
  RecoveryPointTags: 
    Key: Value
  RuleName: String
  ScheduleExpression: String
  ScheduleExpressionTimezone: String
  StartWindowMinutes: Number
  TargetBackupVault: String

Properties

CompletionWindowMinutes

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

Required: No

Type: Number

Update requires: No interruption

CopyActions

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

Required: No

Type: Array of CopyActionResourceType

Update requires: No interruption

EnableContinuousBackup

Enables continuous backup and point-in-time restores (PITR).

Required: No

Type: Boolean

Update requires: No interruption

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.

Required: No

Type: LifecycleResourceType

Update requires: No interruption

RecoveryPointTags

The tags to assign to the resources.

Required: No

Type: Object of String

Pattern: ^.{1,128}$

Update requires: No interruption

RuleName

A display name for a backup rule.

Required: Yes

Type: String

Update requires: No interruption

ScheduleExpression

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

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

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.

If this value is included, it must be at least 60 minutes to avoid errors.

Required: No

Type: Number

Update requires: No interruption

TargetBackupVault

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 letters, numbers, and hyphens.

Required: Yes

Type: String

Update requires: No interruption