AWS::FSx::Volume SnaplockRetentionPeriod

The configuration to set the retention period of an FSx for ONTAP SnapLock volume. The retention period includes default, maximum, and minimum settings. For more information, see Working with the retention period in SnapLock.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON


{
  "DefaultRetention" : RetentionPeriod,
  "MaximumRetention" : RetentionPeriod,
  "MinimumRetention" : RetentionPeriod
}

YAML


  DefaultRetention: 
    RetentionPeriod
  MaximumRetention: 
    RetentionPeriod
  MinimumRetention: 
    RetentionPeriod

Properties

DefaultRetention

The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

Required: Yes

Type: RetentionPeriod

Update requires: No interruption

MaximumRetention

The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

Required: Yes

Type: RetentionPeriod

Update requires: No interruption

MinimumRetention