Documentation

The configuration of an Amazon FSx for NetApp ONTAP volume.

See: newOntapVolumeConfiguration smart constructor.

Create a value of OntapVolumeConfiguration 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:OntapVolumeConfiguration', ontapVolumeConfiguration_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:flexCacheEndpointType:OntapVolumeConfiguration', ontapVolumeConfiguration_flexCacheEndpointType - Specifies the FlexCache endpoint type of the volume. Valid values are the following:

• NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
• ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
• CACHE specifies that the volume is a FlexCache volume.

$sel:junctionPath:OntapVolumeConfiguration', ontapVolumeConfiguration_junctionPath - Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

$sel:ontapVolumeType:OntapVolumeConfiguration', ontapVolumeConfiguration_ontapVolumeType - Specifies the type of volume. Valid values are the following:

• RW specifies a read/write volume. RW is the default.
• DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
• LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

$sel:securityStyle:OntapVolumeConfiguration', ontapVolumeConfiguration_securityStyle - The security style for the volume, which can be UNIX, NTFS, or MIXED.

$sel:sizeInMegabytes:OntapVolumeConfiguration', ontapVolumeConfiguration_sizeInMegabytes - The configured size of the volume, in megabytes (MBs).

$sel:snapshotPolicy:OntapVolumeConfiguration', ontapVolumeConfiguration_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:OntapVolumeConfiguration', ontapVolumeConfiguration_storageEfficiencyEnabled - The volume's storage efficiency setting.

$sel:storageVirtualMachineId:OntapVolumeConfiguration', ontapVolumeConfiguration_storageVirtualMachineId - The ID of the volume's storage virtual machine.

$sel:storageVirtualMachineRoot:OntapVolumeConfiguration', ontapVolumeConfiguration_storageVirtualMachineRoot - A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

$sel:tieringPolicy:OntapVolumeConfiguration', ontapVolumeConfiguration_tieringPolicy - The volume's TieringPolicy setting.

$sel:uuid:OntapVolumeConfiguration', ontapVolumeConfiguration_uuid - The volume's universally unique identifier (UUID).

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 FlexCache endpoint type of the volume. Valid values are the following:

• NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
• ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
• CACHE specifies that the volume is a FlexCache volume.

Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

Specifies the type of volume. Valid values are the following:

• RW specifies a read/write volume. RW is the default.
• DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
• LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

The security style for the volume, which can be UNIX, NTFS, or MIXED.

The configured size of the volume, in megabytes (MBs).

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.

The volume's storage efficiency setting.

The ID of the volume's storage virtual machine.

A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

The volume's TieringPolicy setting.

The volume's universally unique identifier (UUID).