UpdateOntapVolumeConfiguration - Amazon FSx
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

UpdateOntapVolumeConfiguration

Used to specify changes to the ONTAP configuration for the volume you are updating.

Contents

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.

Type: Boolean

Required: No

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: No

SecurityStyle

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

Type: String

Valid Values: UNIX | NTFS | MIXED

Required: No

SizeInBytes

The configured size of the volume, in bytes.

Type: Long

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

Required: No

SizeInMegabytes

Specifies the size of the volume in megabytes.

Type: Integer

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

Required: No

SnaplockConfiguration

The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.

Type: UpdateSnaplockConfiguration object

Required: No

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.

Type: String

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

Required: No

StorageEfficiencyEnabled

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

Type: Boolean

Required: No

TieringPolicy

Update the volume's data tiering policy.

Type: TieringPolicy object

Required: No

See Also

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