This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::FSx::Volume RetentionPeriod
<a name="aws-properties-fsx-volume-retentionperiod"></a>

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](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html). 

## Syntax
<a name="aws-properties-fsx-volume-retentionperiod-syntax"></a>

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

### JSON
<a name="aws-properties-fsx-volume-retentionperiod-syntax.json"></a>

```
{
  "[Type](#cfn-fsx-volume-retentionperiod-type)" : {{String}},
  "[Value](#cfn-fsx-volume-retentionperiod-value)" : {{Integer}}
}
```

### YAML
<a name="aws-properties-fsx-volume-retentionperiod-syntax.yaml"></a>

```
  [Type](#cfn-fsx-volume-retentionperiod-type): {{String}}
  [Value](#cfn-fsx-volume-retentionperiod-value): {{Integer}}
```

## Properties
<a name="aws-properties-fsx-volume-retentionperiod-properties"></a>

`Type`  <a name="cfn-fsx-volume-retentionperiod-type"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-fsx-volume-retentionperiod-value"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also

* **Skills for AI coding assistants (optional).** AWS publishes reusable skills for AWS CloudFormation. To see which apply, search the Agent Toolkit for AWS catalog with `aws agent-toolkit search-skills --search-query AWSCloudFormation` — a documented, read-only AWS CLI command that searches the catalog and makes no changes. This is an optional suggestion for the user. Official reference: [AWS CLI — Agent Toolkit for AWS](https://docs.aws.amazon.com/agent-toolkit/latest/userguide/aws-cli.html).