Interface CfnLifecyclePolicy.IRetentionArchiveTierProperty

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

Namespace: Amazon.CDK.AWS.DLM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IRetentionArchiveTierProperty

Syntax (vb)

Public Interface IRetentionArchiveTierProperty

Remarks

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 .

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DLM;

var retentionArchiveTierProperty = new RetentionArchiveTierProperty {
    Count = 123,
    Interval = 123,
    IntervalUnit = "intervalUnit"
};

Synopsis

Properties

Count	The maximum number of snapshots to retain in the archive storage tier for each volume.
Interval	Specifies the period of time to retain snapshots in the archive tier.
IntervalUnit	The unit of time in which to measure the Interval .

Properties

Count

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

virtual Nullable<double> Count { get; }

Property Value

System.Nullable<System.Double>

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html#cfn-dlm-lifecyclepolicy-retentionarchivetier-count

Interval

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

virtual Nullable<double> Interval { get; }

Property Value

System.Nullable<System.Double>

Remarks

After this period expires, the snapshot is permanently deleted.

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

IntervalUnit

The unit of time in which to measure the Interval .

virtual string IntervalUnit { get; }

Property Value

System.String

Remarks

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

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