Package software.amazon.awscdk.services.dlm

Interface CfnLifecyclePolicy.CreateRuleProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnLifecyclePolicy.CreateRuleProperty.Jsii$Proxy
Enclosing class:
CfnLifecyclePolicy
@Stability(Stable) public static interface CfnLifecyclePolicy.CreateRuleProperty extends software.amazon.jsii.JsiiSerializable
[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 software.amazon.awscdk.services.dlm.*;
 CreateRuleProperty createRuleProperty = CreateRuleProperty.builder()
         .cronExpression("cronExpression")
         .interval(123)
         .intervalUnit("intervalUnit")
         .location("location")
         .times(List.of("times"))
         .build();

  • Method Details

    • getCronExpression

      @Stability(Stable) @Nullable default String getCronExpression()
      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 .

    • getInterval

      @Stability(Stable) @Nullable default Number getInterval()
      The interval between snapshots.

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

    • getIntervalUnit

      @Stability(Stable) @Nullable default String getIntervalUnit()
      The interval unit.

    • getLocation

      @Stability(Stable) @Nullable default String getLocation()
      [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.

    • getTimes

      @Stability(Stable) @Nullable default List<String> getTimes()
      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.

    • builder

      @Stability(Stable) static CfnLifecyclePolicy.CreateRuleProperty.Builder builder()
      Returns:
      a CfnLifecyclePolicy.CreateRuleProperty.Builder of CfnLifecyclePolicy.CreateRuleProperty