CreateOntapVolumeConfiguration - Amazon FSx

CreateOntapVolumeConfiguration

Specifies the configuration of the ONTAP volume that you are creating.

Contents

JunctionPath

Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$

Required: Yes

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. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. 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 if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

Type: String

Valid Values: UNIX | NTFS | MIXED

Required: No

SizeInMegabytes

Specifies the size of the volume, in megabytes (MB), that you are creating.

Type: Integer

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

Required: Yes

StorageEfficiencyEnabled

Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.

Type: Boolean

Required: Yes

StorageVirtualMachineId

Specifies the ONTAP SVM in which to create the volume.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^(svm-[0-9a-f]{17,})$

Required: Yes

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.

Type: TieringPolicy object

Required: No

See Also

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