Interface CfnLifecyclePolicy.RetainRuleProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnLifecyclePolicy.RetainRuleProperty.Jsii$Proxy
- Enclosing class:
CfnLifecyclePolicy
For snapshot policies that have an
ArchiveRule
, this retention rule applies to standard tier retention. When the retention threshold is met, snapshots are moved from the standard to the archive tier.For snapshot policies that do not have an ArchiveRule , snapshots are permanently deleted when this retention threshold is met.
You can retain snapshots based on either a count or a time interval.
- Count-based retention
You must specify Count . If you specify an ArchiveRule
for the schedule, then you can specify a retention count of 0
to archive snapshots immediately after creation. If you specify a FastRestoreRule
, ShareRule
, or a CrossRegionCopyRule
, then you must specify a retention count of 1
or more.
- Age-based retention
You must specify Interval and IntervalUnit . If you specify an ArchiveRule
for the schedule, then you can specify a retention interval of 0
days to archive snapshots immediately after creation. If you specify a FastRestoreRule
, ShareRule
, or a CrossRegionCopyRule
, then you must specify a retention interval of 1
day or more.
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.*; RetainRuleProperty retainRuleProperty = RetainRuleProperty.builder() .count(123) .interval(123) .intervalUnit("intervalUnit") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnLifecyclePolicy.RetainRuleProperty
static final class
An implementation forCfnLifecyclePolicy.RetainRuleProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCount
The number of snapshots to retain for each volume, up to a maximum of 1000.For example if you want to retain a maximum of three snapshots, specify
3
. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified anArchiveRule
. -
getInterval
The amount of time to retain each snapshot.The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
-
getIntervalUnit
The unit of time for time-based retention.For example, to retain snapshots for 3 months, specify
Interval=3
andIntervalUnit=MONTHS
. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified anArchiveRule
. -
builder
-