CreateRule - Amazon Data Lifecycle Manager

CreateRule

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

Important

You must specify either a Cron expression or an interval, interval unit, and start time. You cannot specify both.

Contents

CronExpression

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

Type: String

Length Constraints: Minimum length of 17. Maximum length of 106.

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

Required: No

Interval

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

IntervalUnit

The interval unit.

Type: String

Valid Values: HOURS

Required: No

Location

[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.

Type: String

Valid Values: CLOUD | OUTPOST_LOCAL

Required: No

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.

Type: Array of strings

Array Members: Maximum number of 1 item.

Length Constraints: Fixed length of 5.

Pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: