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 AWS 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: 
    ArchiveRule
  CopyTags: Boolean
  CreateRule: 
    CreateRule
  CrossRegionCopyRules: 
    - CrossRegionCopyRule
  DeprecateRule: 
    DeprecateRule
  FastRestoreRule: 
    FastRestoreRule
  Name: String
  RetainRule: 
    RetainRule
  ShareRules: 
    - ShareRule
  TagsToAdd: 
    - Tag
  VariableTags: 
    - 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

CopyTags

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. 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: 0

Maximum: 3

Update 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: 0

Maximum: 120

Update requires: No interruption

RetainRule

The retention rule for snapshots or AMIs created by the policy.

Required: No

Type: RetainRule

Update requires: No interruption

ShareRules

[Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts.

Required: No

Type: Array of ShareRule

Minimum: 0

Maximum: 1

Update requires: No interruption

TagsToAdd

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 45

Update requires: No interruption

VariableTags

[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: 0

Maximum: 45

Update requires: No interruption