CreateRule - Amazon Data Lifecycle Manager
ContentsSee Also
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).

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.

Contents

CronExpression

The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see the Cron and rate expressions in the Amazon EventBridge 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

[Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

  • If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.

  • If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.

  • If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

Specify one of the following values:

  • To create snapshots in the same Region as the source resource, specify CLOUD.

  • To create snapshots in the same Local Zone as the source resource, specify LOCAL_ZONE.

  • To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL.

Default: CLOUD

Type: String

Valid Values: CLOUD | OUTPOST_LOCAL | LOCAL_ZONE

Required: No

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.

Type: Array of Script objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

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 Amazon SDKs, see the following: