1.204.0

interface CreateRuleProperty

LanguageType name
.NETAmazon.CDK.AWS.DLM.CfnLifecyclePolicy.CreateRuleProperty
Javasoftware.amazon.awscdk.services.dlm.CfnLifecyclePolicy.CreateRuleProperty
Pythonaws_cdk.aws_dlm.CfnLifecyclePolicy.CreateRuleProperty
TypeScript @aws-cdk/aws-dlm » CfnLifecyclePolicy » CreateRuleProperty

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as dlm from '@aws-cdk/aws-dlm';
const createRuleProperty: dlm.CfnLifecyclePolicy.CreateRuleProperty = {
  cronExpression: 'cronExpression',
  interval: 123,
  intervalUnit: 'intervalUnit',
  location: 'location',
  times: ['times'],
};

Properties

NameTypeDescription
cronExpression?stringThe schedule, as a Cron expression.
interval?numberThe interval between snapshots.
intervalUnit?stringThe interval unit.
location?string[Snapshot policies only] Specifies the destination for snapshots created by the policy.
times?string[]The time, in UTC, to start the operation. The supported format is hh:mm.

cronExpression?

Type: string (optional)

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 .

interval?

Type: number (optional)

The interval between snapshots.

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

intervalUnit?

Type: string (optional)

The interval unit.

location?

Type: string (optional)

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

times?

Type: string[] (optional)

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.

← PreviousNext →