interface RetentionPeriodProperty

Language	Type name
.NET	`Amazon.CDK.AWS.FSx.CfnVolume.RetentionPeriodProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsfsx#CfnVolume_RetentionPeriodProperty`
Java	`software.amazon.awscdk.services.fsx.CfnVolume.RetentionPeriodProperty`
Python	`aws_cdk.aws_fsx.CfnVolume.RetentionPeriodProperty`
TypeScript	`aws-cdk-lib` » `aws_fsx` » `CfnVolume` » `RetentionPeriodProperty`

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from 'aws-cdk-lib';
const retentionPeriodProperty: fsx.CfnVolume.RetentionPeriodProperty = {
  type: 'type',

  // the properties below are optional
  value: 123,
};

Properties

Name	Type	Description
type	`string`	Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume.
value?	`number`	Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.

type

Type: string

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.

value?

Type: number (optional)

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