This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::FSx::Volume OntapConfiguration Specifies the configuration of the ONTAP volume that you are creating. ## Syntax To declare this entity in your Amazon CloudFormation template, use the following syntax: ### JSON ``` { "[AggregateConfiguration](#cfn-fsx-volume-ontapconfiguration-aggregateconfiguration)" : AggregateConfiguration, "[CopyTagsToBackups](#cfn-fsx-volume-ontapconfiguration-copytagstobackups)" : String, "[JunctionPath](#cfn-fsx-volume-ontapconfiguration-junctionpath)" : String, "[OntapVolumeType](#cfn-fsx-volume-ontapconfiguration-ontapvolumetype)" : String, "[SecurityStyle](#cfn-fsx-volume-ontapconfiguration-securitystyle)" : String, "[SizeInBytes](#cfn-fsx-volume-ontapconfiguration-sizeinbytes)" : String, "[SizeInMegabytes](#cfn-fsx-volume-ontapconfiguration-sizeinmegabytes)" : String, "[SnaplockConfiguration](#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration)" : SnaplockConfiguration, "[SnapshotPolicy](#cfn-fsx-volume-ontapconfiguration-snapshotpolicy)" : String, "[StorageEfficiencyEnabled](#cfn-fsx-volume-ontapconfiguration-storageefficiencyenabled)" : String, "[StorageVirtualMachineId](#cfn-fsx-volume-ontapconfiguration-storagevirtualmachineid)" : String, "[TieringPolicy](#cfn-fsx-volume-ontapconfiguration-tieringpolicy)" : TieringPolicy, "[VolumeStyle](#cfn-fsx-volume-ontapconfiguration-volumestyle)" : String } ``` ### YAML ``` [AggregateConfiguration](#cfn-fsx-volume-ontapconfiguration-aggregateconfiguration): AggregateConfiguration [CopyTagsToBackups](#cfn-fsx-volume-ontapconfiguration-copytagstobackups): String [JunctionPath](#cfn-fsx-volume-ontapconfiguration-junctionpath): String [OntapVolumeType](#cfn-fsx-volume-ontapconfiguration-ontapvolumetype): String [SecurityStyle](#cfn-fsx-volume-ontapconfiguration-securitystyle): String [SizeInBytes](#cfn-fsx-volume-ontapconfiguration-sizeinbytes): String [SizeInMegabytes](#cfn-fsx-volume-ontapconfiguration-sizeinmegabytes): String [SnaplockConfiguration](#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration): SnaplockConfiguration [SnapshotPolicy](#cfn-fsx-volume-ontapconfiguration-snapshotpolicy): String [StorageEfficiencyEnabled](#cfn-fsx-volume-ontapconfiguration-storageefficiencyenabled): String [StorageVirtualMachineId](#cfn-fsx-volume-ontapconfiguration-storagevirtualmachineid): String [TieringPolicy](#cfn-fsx-volume-ontapconfiguration-tieringpolicy): TieringPolicy [VolumeStyle](#cfn-fsx-volume-ontapconfiguration-volumestyle): String ``` ## Properties `AggregateConfiguration` Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates. *Required*: No *Type*: [AggregateConfiguration](aws-properties-fsx-volume-aggregateconfiguration.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CopyTagsToBackups` A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JunctionPath` Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The `JunctionPath` must have a leading forward slash, such as `/vol3`. *Required*: No *Type*: String *Pattern*: `^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OntapVolumeType` Specifies the type of volume you are creating. Valid values are the following: + `RW` specifies a read/write volume. `RW` is the default. + `DP` specifies a data-protection volume. A `DP` volume is read-only and can be used as the destination of a NetApp SnapMirror relationship. For more information, see [Volume types](https://docs.amazonaws.cn/fsx/latest/ONTAPGuide/managing-volumes.html#volume-types) in the Amazon FSx for NetApp ONTAP User Guide. *Required*: No *Type*: String *Allowed values*: `RW | DP` *Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SecurityStyle` Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values: + `UNIX` if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. + `NTFS` if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. + `MIXED` This is an advanced setting. For more information, see the topic [What the security styles and their effects are](https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html) in the NetApp Documentation Center. For more information, see [Volume security style](https://docs.amazonaws.cn/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style) in the FSx for ONTAP User Guide. *Required*: No *Type*: String *Allowed values*: `UNIX | NTFS | MIXED` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SizeInBytes` Specifies the configured size of the volume, in bytes. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SizeInMegabytes` Use `SizeInBytes` instead. Specifies the size of the volume, in megabytes (MB), that you are creating. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `2147483647` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SnaplockConfiguration` The SnapLock configuration object for an FSx for ONTAP SnapLock volume. *Required*: No *Type*: [SnaplockConfiguration](aws-properties-fsx-volume-snaplockconfiguration.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SnapshotPolicy` Specifies the snapshot policy for the volume. There are three built-in snapshot policies: + `default`: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. + `default-1weekly`: This policy is the same as the `default` policy except that it only retains one snapshot from the weekly schedule. + `none`: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see [Snapshot policies](https://docs.amazonaws.cn/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) in the Amazon FSx for NetApp ONTAP User Guide. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StorageEfficiencyEnabled` Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. `StorageEfficiencyEnabled` is required when creating a `RW` volume (`OntapVolumeType` set to `RW`). *Required*: Conditional *Type*: String *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StorageVirtualMachineId` Specifies the ONTAP SVM in which to create the volume. *Required*: Yes *Type*: String *Pattern*: `^(svm-[0-9a-f]{17,})$` *Minimum*: `21` *Maximum*: `21` *Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TieringPolicy` 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. *Required*: No *Type*: [TieringPolicy](aws-properties-fsx-volume-tieringpolicy.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VolumeStyle` Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see [Volume styles](https://docs.amazonaws.cn/fsx/latest/ONTAPGuide/managing-volumes.html#volume-styles) in the Amazon FSx for NetApp ONTAP User Guide. *Required*: No *Type*: String *Allowed values*: `FLEXVOL | FLEXGROUP` *Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)