This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.
AWS::DLM::LifecyclePolicy Schedule
[Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "ArchiveRule" :ArchiveRule, "CopyTags" :Boolean, "CreateRule" :CreateRule, "CrossRegionCopyRules" :[ CrossRegionCopyRule, ... ], "DeprecateRule" :DeprecateRule, "FastRestoreRule" :FastRestoreRule, "Name" :String, "RetainRule" :RetainRule, "ShareRules" :[ ShareRule, ... ], "TagsToAdd" :[ Tag, ... ], "VariableTags" :[ Tag, ... ]}
YAML
ArchiveRule:ArchiveRuleCopyTags:BooleanCreateRule:CreateRuleCrossRegionCopyRules:- CrossRegionCopyRuleDeprecateRule:DeprecateRuleFastRestoreRule:FastRestoreRuleName:StringRetainRule:RetainRuleShareRules:- ShareRuleTagsToAdd:- TagVariableTags:- Tag
Properties
ArchiveRule-
[Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
Required: No
Type: ArchiveRule
Update requires: No interruption
-
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
Required: No
Type: Boolean
Update requires: No interruption
CreateRule-
The creation rule.
Required: No
Type: CreateRule
Update requires: No interruption
CrossRegionCopyRules-
Specifies a rule for copying snapshots or AMIs across Regions.
Note
You can't specify cross-Region copy rules for policies that create snapshots on an Outpost or in a Local Zone. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
Required: No
Type: Array of CrossRegionCopyRule
Minimum:
0Maximum:
3Update requires: No interruption
DeprecateRule-
[Custom AMI policies only] The AMI deprecation rule for the schedule.
Required: No
Type: DeprecateRule
Update requires: No interruption
FastRestoreRule-
[Custom snapshot policies only] The rule for enabling fast snapshot restore.
Required: No
Type: FastRestoreRule
Update requires: No interruption
Name-
The name of the schedule.
Required: No
Type: String
Pattern:
[0-9A-Za-z _-]+Minimum:
0Maximum:
120Update requires: No interruption
RetainRule-
The retention rule for snapshots or AMIs created by the policy.
Required: No
Type: RetainRule
Update requires: No interruption
-
[Custom snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
Required: No
Type: Array of ShareRule
Minimum:
0Maximum:
1Update requires: No interruption
-
The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon-added lifecycle tags.
Required: No
Type: Array of Tag
Minimum:
0Maximum:
45Update requires: No interruption
-
[AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats:
$(instance-id)or$(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.Required: No
Type: Array of Tag
Minimum:
0Maximum:
45Update requires: No interruption