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 Amazon CloudFormation template, use the following syntax:
JSON
{ "CompletionWindowMinutes" :
Double
, "CopyActions" :[ CopyActionResourceType, ... ]
, "EnableContinuousBackup" :Boolean
, "Lifecycle" :LifecycleResourceType
, "RecoveryPointTags" :{
, "RuleName" :Key
:Value
, ...}String
, "ScheduleExpression" :String
, "ScheduleExpressionTimezone" :String
, "StartWindowMinutes" :Double
, "TargetBackupVault" :String
}
YAML
CompletionWindowMinutes:
Double
CopyActions:- CopyActionResourceType
EnableContinuousBackup:Boolean
Lifecycle:LifecycleResourceType
RecoveryPointTags:RuleName:
Key
:Value
String
ScheduleExpression:String
ScheduleExpressionTimezone:String
StartWindowMinutes:Double
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 Amazon Backup.
Required: No
Type: Double
Update requires: No interruption
CopyActions
-
An array of CopyAction objects, which contains the details of the copy operation.
Required: No
Type: List 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. Amazon Backup transitions and expires backups automatically according to the lifecycle that you define.
Required: No
Type: LifecycleResourceType
Update requires: No interruption
-
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
Required: No
Type: Map of String
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 Amazon Backup initiates a backup job.
Required: No
Type: String
Update requires: No interruption
ScheduleExpressionTimezone
Property description not available.
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: Double
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 Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
Required: Yes
Type: String
Update requires: No interruption