AWS::DLM::LifecyclePolicy CreateRule

[Custom snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.

Note

• You must specify either CronExpression, or Interval, IntervalUnit, and Times.

• If you need to specify an ArchiveRule for the schedule, then you must specify a creation frequency of at least 28 days.

Syntax

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

JSON

{
  "CronExpression" : String,
  "Interval" : Integer,
  "IntervalUnit" : String,
  "Location" : String,
  "Scripts" : [ Script, ... ],
  "Times" : [ String, ... ]
}

YAML

  CronExpression: String
  Interval: Integer
  IntervalUnit: String
  Location: String
  Scripts: 
    - Script
  Times: 
    - String

Properties

CronExpression

The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see the Cron expressions reference in the Amazon EventBridge User Guide.

Required: No

Type: String

Pattern: cron\([^\n]{11,100}\)

Minimum: 17

Maximum: 106

Update requires: No interruption

Interval

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

Required: No

Type: Integer

Minimum: 1

Update requires: No interruption

IntervalUnit

The interval unit.

Required: No

Type: String

Allowed values: HOURS

Update requires: No interruption

Location

[Custom snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

If the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

Required: No

Type: String

Allowed values: CLOUD | OUTPOST_LOCAL

Update requires: No interruption

Scripts

[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.

For more information, see Automating application-consistent snapshots with pre and post scripts.

Required: No

Type: Array of Script

Minimum: 0

Maximum: 1

Update requires: No interruption

Times

The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

Required: No

Type: Array of String

Maximum: 1

Update requires: No interruption