software.amazon.awssdk.services.fsx.model

Interface OntapVolumeConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

OntapVolumeConfiguration

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

Method Summary

Modifier and Type	Method and Description
OntapVolumeConfiguration.Builder	copyTagsToBackups(Boolean copyTagsToBackups) A boolean flag indicating whether tags for the volume should be copied to backups.
OntapVolumeConfiguration.Builder	flexCacheEndpointType(FlexCacheEndpointType flexCacheEndpointType) Specifies the FlexCache endpoint type of the volume.
OntapVolumeConfiguration.Builder	flexCacheEndpointType(String flexCacheEndpointType) Specifies the FlexCache endpoint type of the volume.
OntapVolumeConfiguration.Builder	junctionPath(String 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.
OntapVolumeConfiguration.Builder	ontapVolumeType(OntapVolumeType ontapVolumeType) Specifies the type of volume.
OntapVolumeConfiguration.Builder	ontapVolumeType(String ontapVolumeType) Specifies the type of volume.
OntapVolumeConfiguration.Builder	securityStyle(SecurityStyle securityStyle) The security style for the volume, which can be UNIX, NTFS, or MIXED.
OntapVolumeConfiguration.Builder	securityStyle(String securityStyle) The security style for the volume, which can be UNIX, NTFS, or MIXED.
OntapVolumeConfiguration.Builder	sizeInMegabytes(Integer sizeInMegabytes) The configured size of the volume, in megabytes (MBs).
default OntapVolumeConfiguration.Builder	snaplockConfiguration(Consumer<SnaplockConfiguration.Builder> snaplockConfiguration) The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
OntapVolumeConfiguration.Builder	snaplockConfiguration(SnaplockConfiguration snaplockConfiguration) The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
OntapVolumeConfiguration.Builder	snapshotPolicy(String snapshotPolicy) Specifies the snapshot policy for the volume.
OntapVolumeConfiguration.Builder	storageEfficiencyEnabled(Boolean storageEfficiencyEnabled) The volume's storage efficiency setting.
OntapVolumeConfiguration.Builder	storageVirtualMachineId(String storageVirtualMachineId) The ID of the volume's storage virtual machine.
OntapVolumeConfiguration.Builder	storageVirtualMachineRoot(Boolean storageVirtualMachineRoot) A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM).
default OntapVolumeConfiguration.Builder	tieringPolicy(Consumer<TieringPolicy.Builder> tieringPolicy) The volume's TieringPolicy setting.
OntapVolumeConfiguration.Builder	tieringPolicy(TieringPolicy tieringPolicy) The volume's TieringPolicy setting.
OntapVolumeConfiguration.Builder	uuid(String uuid) The volume's universally unique identifier (UUID).

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

flexCacheEndpointType

OntapVolumeConfiguration.Builder flexCacheEndpointType(String 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.

Parameters:

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.

Returns:

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

See Also:

FlexCacheEndpointType, FlexCacheEndpointType

flexCacheEndpointType

OntapVolumeConfiguration.Builder flexCacheEndpointType(FlexCacheEndpointType 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.

Parameters:

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.

Returns:

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

See Also:

FlexCacheEndpointType, FlexCacheEndpointType

junctionPath

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

Parameters:

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.

Returns:

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

securityStyle

OntapVolumeConfiguration.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

OntapVolumeConfiguration.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

OntapVolumeConfiguration.Builder sizeInMegabytes(Integer sizeInMegabytes)

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

Parameters:

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

Returns:

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

storageEfficiencyEnabled

OntapVolumeConfiguration.Builder storageEfficiencyEnabled(Boolean storageEfficiencyEnabled)

The volume's storage efficiency setting.

Parameters:

storageEfficiencyEnabled - The volume's storage efficiency setting.

Returns:

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

storageVirtualMachineId

OntapVolumeConfiguration.Builder storageVirtualMachineId(String storageVirtualMachineId)

The ID of the volume's storage virtual machine.

Parameters:

storageVirtualMachineId - The ID of the volume's storage virtual machine.

Returns:

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

storageVirtualMachineRoot

OntapVolumeConfiguration.Builder storageVirtualMachineRoot(Boolean 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.

Parameters:

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.

Returns:

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

tieringPolicy

OntapVolumeConfiguration.Builder tieringPolicy(TieringPolicy tieringPolicy)

The volume's TieringPolicy setting.

Parameters:

tieringPolicy - The volume's TieringPolicy setting.

Returns:

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

tieringPolicy

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

The volume's TieringPolicy setting.

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)

uuid

OntapVolumeConfiguration.Builder uuid(String uuid)

The volume's universally unique identifier (UUID).

Parameters:

uuid - The volume's universally unique identifier (UUID).

Returns:

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

ontapVolumeType

OntapVolumeConfiguration.Builder ontapVolumeType(String 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.

Parameters:

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.

Returns:

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

See Also:

OntapVolumeType, OntapVolumeType

ontapVolumeType

OntapVolumeConfiguration.Builder ontapVolumeType(OntapVolumeType 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.

Parameters:

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.

Returns:

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

See Also:

OntapVolumeType, OntapVolumeType

snapshotPolicy

OntapVolumeConfiguration.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

OntapVolumeConfiguration.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

OntapVolumeConfiguration.Builder snaplockConfiguration(SnaplockConfiguration snaplockConfiguration)

The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

Parameters:

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

Returns:

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

snaplockConfiguration

default OntapVolumeConfiguration.Builder snaplockConfiguration(Consumer<SnaplockConfiguration.Builder> snaplockConfiguration)

The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

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

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

Parameters:

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

Returns:

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

See Also:

snaplockConfiguration(SnaplockConfiguration)