software.amazon.awssdk.services.fsx.model

Interface UpdateOntapVolumeConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<UpdateOntapVolumeConfiguration.Builder,UpdateOntapVolumeConfiguration>, SdkBuilder<UpdateOntapVolumeConfiguration.Builder,UpdateOntapVolumeConfiguration>, SdkPojo

Enclosing class:

UpdateOntapVolumeConfiguration

public static interface UpdateOntapVolumeConfiguration.Builder
extends SdkPojo, CopyableBuilder<UpdateOntapVolumeConfiguration.Builder,UpdateOntapVolumeConfiguration>

Method Summary

Modifier and Type	Method and Description
UpdateOntapVolumeConfiguration.Builder	copyTagsToBackups(Boolean copyTagsToBackups) A boolean flag indicating whether tags for the volume should be copied to backups.
UpdateOntapVolumeConfiguration.Builder	junctionPath(String junctionPath) Specifies the location in the SVM's namespace where the volume is mounted.
UpdateOntapVolumeConfiguration.Builder	securityStyle(SecurityStyle securityStyle) The security style for the volume, which can be UNIX, NTFS, or MIXED.
UpdateOntapVolumeConfiguration.Builder	securityStyle(String securityStyle) The security style for the volume, which can be UNIX, NTFS, or MIXED.
UpdateOntapVolumeConfiguration.Builder	sizeInMegabytes(Integer sizeInMegabytes) Specifies the size of the volume in megabytes.
default UpdateOntapVolumeConfiguration.Builder	snaplockConfiguration(Consumer<UpdateSnaplockConfiguration.Builder> snaplockConfiguration) The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
UpdateOntapVolumeConfiguration.Builder	snaplockConfiguration(UpdateSnaplockConfiguration snaplockConfiguration) The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
UpdateOntapVolumeConfiguration.Builder	snapshotPolicy(String snapshotPolicy) Specifies the snapshot policy for the volume.
UpdateOntapVolumeConfiguration.Builder	storageEfficiencyEnabled(Boolean storageEfficiencyEnabled) Default is false.
default UpdateOntapVolumeConfiguration.Builder	tieringPolicy(Consumer<TieringPolicy.Builder> tieringPolicy) Update the volume's data tiering policy.
UpdateOntapVolumeConfiguration.Builder	tieringPolicy(TieringPolicy tieringPolicy) Update the volume's data tiering policy.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

junctionPath

UpdateOntapVolumeConfiguration.Builder junctionPath(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityStyle

UpdateOntapVolumeConfiguration.Builder securityStyle(String securityStyle)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SecurityStyle, SecurityStyle

securityStyle

UpdateOntapVolumeConfiguration.Builder securityStyle(SecurityStyle securityStyle)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SecurityStyle, SecurityStyle

sizeInMegabytes

UpdateOntapVolumeConfiguration.Builder sizeInMegabytes(Integer sizeInMegabytes)

Specifies the size of the volume in megabytes.

Parameters:

sizeInMegabytes - Specifies the size of the volume in megabytes.

Returns:

Returns a reference to this object so that method calls can be chained together.

storageEfficiencyEnabled

UpdateOntapVolumeConfiguration.Builder storageEfficiencyEnabled(Boolean storageEfficiencyEnabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tieringPolicy

UpdateOntapVolumeConfiguration.Builder tieringPolicy(TieringPolicy tieringPolicy)

Update the volume's data tiering policy.

Parameters:

tieringPolicy - Update the volume's data tiering policy.

Returns:

Returns a reference to this object so that method calls can be chained together.

tieringPolicy

default UpdateOntapVolumeConfiguration.Builder tieringPolicy(Consumer<TieringPolicy.Builder> tieringPolicy)

Update the volume's data tiering policy.

This is a convenience method that creates an instance of the TieringPolicy.Builder avoiding the need to create one manually via TieringPolicy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tieringPolicy(TieringPolicy).

Parameters:

tieringPolicy - a consumer that will call methods on TieringPolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

tieringPolicy(TieringPolicy)

snapshotPolicy

UpdateOntapVolumeConfiguration.Builder snapshotPolicy(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

copyTagsToBackups

UpdateOntapVolumeConfiguration.Builder copyTagsToBackups(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

snaplockConfiguration

UpdateOntapVolumeConfiguration.Builder snaplockConfiguration(UpdateSnaplockConfiguration snaplockConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

snaplockConfiguration

default UpdateOntapVolumeConfiguration.Builder snaplockConfiguration(Consumer<UpdateSnaplockConfiguration.Builder> snaplockConfiguration)

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

This is a convenience method that creates an instance of the UpdateSnaplockConfiguration.Builder avoiding the need to create one manually via UpdateSnaplockConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to snaplockConfiguration(UpdateSnaplockConfiguration).

Parameters:

snaplockConfiguration - a consumer that will call methods on UpdateSnaplockConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

snaplockConfiguration(UpdateSnaplockConfiguration)