Interface CfnLifecyclePolicy.CreateRuleProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnLifecyclePolicy.CreateRuleProperty.Jsii$Proxy
- Enclosing class:
CfnLifecyclePolicy
- 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") .scripts(List.of(ScriptProperty.builder() .executeOperationOnScriptFailure(false) .executionHandler("executionHandler") .executionHandlerService("executionHandlerService") .executionTimeout(123) .maximumRetryCount(123) .stages(List.of("stages")) .build())) .times(List.of("times")) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnLifecyclePolicy.CreateRuleProperty
static final class
An implementation forCfnLifecyclePolicy.CreateRuleProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The schedule, as a Cron expression.default Number
The interval between snapshots.default String
The interval unit.default String
[Custom snapshot policies only] Specifies the destination for snapshots created by the policy.default Object
[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances.getTimes()
The time, in UTC, to start the operation.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCronExpression
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 .
- See Also:
-
getInterval
The interval between snapshots.The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
- See Also:
-
getIntervalUnit
The interval unit.- See Also:
-
getLocation
[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
- See Also:
-
getScripts
[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 .
- See Also:
-
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.
- See Also:
-
builder
-