AWS::FSx::Volume RetentionPeriod - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::FSx::Volume RetentionPeriod

Specifies the retention period of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Files can't be deleted or modified during the retention period.

For more information, see Working with the retention period in SnapLock.

Syntax

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

JSON

{
  "Type" : String,
  "Value" : Integer
}

YAML

  Type: String
  Value: Integer

Properties

Type

Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

Required: Yes

Type: String

Allowed values: SECONDS | MINUTES | HOURS | DAYS | MONTHS | YEARS | INFINITE | UNSPECIFIED

Update requires: No interruption

Value

Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

  • Seconds: 0 - 65,535

  • Minutes: 0 - 65,535

  • Hours: 0 - 24

  • Days: 0 - 365

  • Months: 0 - 12

  • Years: 0 - 100

Required: No

Type: Integer

Minimum: 0

Maximum: 65535

Update requires: No interruption