interface RetentionArchiveTierProperty

Language	Type name
.NET	`Amazon.CDK.AWS.DLM.CfnLifecyclePolicy.RetentionArchiveTierProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdlm#CfnLifecyclePolicy_RetentionArchiveTierProperty`
Java	`software.amazon.awscdk.services.dlm.CfnLifecyclePolicy.RetentionArchiveTierProperty`
Python	`aws_cdk.aws_dlm.CfnLifecyclePolicy.RetentionArchiveTierProperty`
TypeScript	`aws-cdk-lib` » `aws_dlm` » `CfnLifecyclePolicy` » `RetentionArchiveTierProperty`

[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 { aws_dlm as dlm } from 'aws-cdk-lib';
const retentionArchiveTierProperty: dlm.CfnLifecyclePolicy.RetentionArchiveTierProperty = {
  count: 123,
  interval: 123,
  intervalUnit: 'intervalUnit',
};

Properties

Name	Type	Description
count?	`number`	The maximum number of snapshots to retain in the archive storage tier for each volume.
interval?	`number`	Specifies the period of time to retain snapshots in the archive tier.
intervalUnit?	`string`	The unit of time in which to measure the Interval .

count?

Type: number (optional)

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.

interval?

Type: number (optional)

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

After this period expires, the snapshot is permanently deleted.

intervalUnit?

Type: string (optional)

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 .