Package software.amazon.awscdk.services.dlm

Interface CfnLifecyclePolicy.RetentionArchiveTierProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecyclePolicy.RetentionArchiveTierProperty.Jsii$Proxy

Enclosing class:

CfnLifecyclePolicy

@Stability(Stable)
public static interface CfnLifecyclePolicy.RetentionArchiveTierProperty
extends software.amazon.jsii.JsiiSerializable

[Custom snapshot policies only] Describes the retention rule for archived snapshots.

Once the archive retention threshold is met, the snapshots are permanently deleted from the archive tier.

The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.

For count-based schedules , you must specify Count . For age-based schedules , you must specify Interval and IntervalUnit .

For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies .

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.*;
 RetentionArchiveTierProperty retentionArchiveTierProperty = RetentionArchiveTierProperty.builder()
         .count(123)
         .interval(123)
         .intervalUnit("intervalUnit")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLifecyclePolicy.RetentionArchiveTierProperty.Builder	A builder for CfnLifecyclePolicy.RetentionArchiveTierProperty
static final class	CfnLifecyclePolicy.RetentionArchiveTierProperty.Jsii$Proxy	An implementation for CfnLifecyclePolicy.RetentionArchiveTierProperty

Method Summary

Modifier and Type	Method	Description
static CfnLifecyclePolicy.RetentionArchiveTierProperty.Builder	builder()
default Number	getCount()	The maximum number of snapshots to retain in the archive storage tier for each volume.
default Number	getInterval()	Specifies the period of time to retain snapshots in the archive tier.
default String	getIntervalUnit()	The unit of time in which to measure the Interval .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCount

@Stability(Stable)
@Nullable
default Number getCount()

The maximum number of snapshots to retain in the archive storage tier for each volume.

The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html#cfn-dlm-lifecyclepolicy-retentionarchivetier-count

getInterval

@Stability(Stable)
@Nullable
default Number getInterval()

Specifies the period of time to retain snapshots in the archive tier.

After this period expires, the snapshot is permanently deleted.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html#cfn-dlm-lifecyclepolicy-retentionarchivetier-interval

getIntervalUnit

@Stability(Stable)
@Nullable
default String getIntervalUnit()

The unit of time in which to measure the Interval .

For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html#cfn-dlm-lifecyclepolicy-retentionarchivetier-intervalunit

builder

@Stability(Stable)
static CfnLifecyclePolicy.RetentionArchiveTierProperty.Builder builder()

Returns:

a CfnLifecyclePolicy.RetentionArchiveTierProperty.Builder of CfnLifecyclePolicy.RetentionArchiveTierProperty