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 TieringPolicy
<a name="aws-properties-fsx-volume-tieringpolicy"></a>

Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:
+ `SNAPSHOT_ONLY` - (Default value) moves cold snapshots to the capacity pool storage tier.
+ `AUTO` - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
+ `ALL` - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
+ `NONE` - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

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

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

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

```
{
  "[CoolingPeriod](#cfn-fsx-volume-tieringpolicy-coolingperiod)" : {{Integer}},
  "[Name](#cfn-fsx-volume-tieringpolicy-name)" : {{String}}
}
```

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

```
  [CoolingPeriod](#cfn-fsx-volume-tieringpolicy-coolingperiod): {{Integer}}
  [Name](#cfn-fsx-volume-tieringpolicy-name): {{String}}
```

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

`CoolingPeriod`  <a name="cfn-fsx-volume-tieringpolicy-coolingperiod"></a>
Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the `AUTO` and `SNAPSHOT_ONLY` tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for `AUTO` and 2 days for `SNAPSHOT_ONLY`.  
*Required*: No  
*Type*: Integer  
*Minimum*: `2`  
*Maximum*: `183`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-fsx-volume-tieringpolicy-name"></a>
Specifies the tiering policy used to transition data. Default value is `SNAPSHOT_ONLY`.  
+ `SNAPSHOT_ONLY` - moves cold snapshots to the capacity pool storage tier.
+ `AUTO` - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
+ `ALL` - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
+ `NONE` - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
*Required*: No  
*Type*: String  
*Allowed values*: `SNAPSHOT_ONLY | AUTO | ALL | NONE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)