AWS::DLM::LifecyclePolicy RetentionArchiveTier - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::DLM::LifecyclePolicy RetentionArchiveTier

[Custom snapshot policies only] Describes the retention rule for archived snapshots. Once the archive retention threshold is met, the snapshots are permanently deleted from the archive tier.

Note

The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.

For count-based schedules, you must specify Count. For age-based schedules, you must specify Interval and IntervalUnit.

For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.

Syntax

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

JSON

{
  "Count" : Integer,
  "Interval" : Integer,
  "IntervalUnit" : String
}

YAML

  Count: Integer
  Interval: Integer
  IntervalUnit: String

Properties

Count

The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.

Required: No

Type: Integer

Minimum: 1

Maximum: 1000

Update requires: No interruption

Interval

Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.

Required: No

Type: Integer

Minimum: 1

Update requires: No interruption

IntervalUnit

The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.

Required: No

Type: String

Allowed values: DAYS | WEEKS | MONTHS | YEARS

Update requires: No interruption