RetentionPeriod - Amazon FSx
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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.

Contents

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.

Type: String

Valid Values: SECONDS | MINUTES | HOURS | DAYS | MONTHS | YEARS | INFINITE | UNSPECIFIED

Required: Yes

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 65535.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: