Documentation

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

See: newCreateOntapVolumeConfiguration smart constructor.

Create a value of CreateOntapVolumeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:copyTagsToBackups:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_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.

$sel:junctionPath:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_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.

$sel:ontapVolumeType:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_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 in the Amazon FSx for NetApp ONTAP User Guide.

$sel:securityStyle:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_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.

$sel:snapshotPolicy:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_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 in the Amazon FSx for NetApp ONTAP User Guide.

$sel:storageEfficiencyEnabled:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_storageEfficiencyEnabled - Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.

$sel:tieringPolicy:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_tieringPolicy - Undocumented member.

$sel:sizeInMegabytes:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_sizeInMegabytes - Specifies the size of the volume, in megabytes (MB), that you are creating.

$sel:storageVirtualMachineId:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_storageVirtualMachineId - Specifies the ONTAP SVM in which to create the volume.

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.

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

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 in the Amazon FSx for NetApp ONTAP User Guide.

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.

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 in the Amazon FSx for NetApp ONTAP User Guide.

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

Undocumented member.

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

Specifies the ONTAP SVM in which to create the volume.