software.amazon.awssdk.services.fsx.model

Interface CreateOntapVolumeConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

CreateOntapVolumeConfiguration

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

Method Summary

Modifier and Type	Method and Description
CreateOntapVolumeConfiguration.Builder	copyTagsToBackups(Boolean copyTagsToBackups) A boolean flag indicating whether tags for the volume should be copied to backups.
CreateOntapVolumeConfiguration.Builder	junctionPath(String junctionPath) Specifies the location in the SVM's namespace where the volume is mounted.
CreateOntapVolumeConfiguration.Builder	ontapVolumeType(InputOntapVolumeType ontapVolumeType) Specifies the type of volume you are creating.
CreateOntapVolumeConfiguration.Builder	ontapVolumeType(String ontapVolumeType) Specifies the type of volume you are creating.
CreateOntapVolumeConfiguration.Builder	securityStyle(SecurityStyle securityStyle) Specifies the security style for the volume.
CreateOntapVolumeConfiguration.Builder	securityStyle(String securityStyle) Specifies the security style for the volume.
CreateOntapVolumeConfiguration.Builder	sizeInMegabytes(Integer sizeInMegabytes) Specifies the size of the volume, in megabytes (MB), that you are creating.
default CreateOntapVolumeConfiguration.Builder	snaplockConfiguration(Consumer<CreateSnaplockConfiguration.Builder> snaplockConfiguration) Specifies the SnapLock configuration for an FSx for ONTAP volume.
CreateOntapVolumeConfiguration.Builder	snaplockConfiguration(CreateSnaplockConfiguration snaplockConfiguration) Specifies the SnapLock configuration for an FSx for ONTAP volume.
CreateOntapVolumeConfiguration.Builder	snapshotPolicy(String snapshotPolicy) Specifies the snapshot policy for the volume.
CreateOntapVolumeConfiguration.Builder	storageEfficiencyEnabled(Boolean storageEfficiencyEnabled) Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
CreateOntapVolumeConfiguration.Builder	storageVirtualMachineId(String storageVirtualMachineId) Specifies the ONTAP SVM in which to create the volume.
default CreateOntapVolumeConfiguration.Builder	tieringPolicy(Consumer<TieringPolicy.Builder> tieringPolicy) Sets the value of the TieringPolicy property for this object.
CreateOntapVolumeConfiguration.Builder	tieringPolicy(TieringPolicy tieringPolicy) Sets the value of the TieringPolicy property for this object.

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

CreateOntapVolumeConfiguration.Builder junctionPath(String junctionPath)

Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. 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. This parameter is required. 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

CreateOntapVolumeConfiguration.Builder securityStyle(String 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.

Parameters:

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.

Returns:

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

See Also:

SecurityStyle, SecurityStyle

securityStyle

CreateOntapVolumeConfiguration.Builder securityStyle(SecurityStyle 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.

Parameters:

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.

Returns:

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

See Also:

SecurityStyle, SecurityStyle

sizeInMegabytes

CreateOntapVolumeConfiguration.Builder sizeInMegabytes(Integer sizeInMegabytes)

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

Parameters:

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

Returns:

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

storageEfficiencyEnabled

CreateOntapVolumeConfiguration.Builder storageEfficiencyEnabled(Boolean storageEfficiencyEnabled)

Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. This parameter is required.

Parameters:

storageEfficiencyEnabled - Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. This parameter is required.

Returns:

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

storageVirtualMachineId

CreateOntapVolumeConfiguration.Builder storageVirtualMachineId(String storageVirtualMachineId)

Specifies the ONTAP SVM in which to create the volume.

Parameters:

storageVirtualMachineId - Specifies the ONTAP SVM in which to create the volume.

Returns:

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

tieringPolicy

CreateOntapVolumeConfiguration.Builder tieringPolicy(TieringPolicy tieringPolicy)

Sets the value of the TieringPolicy property for this object.

Parameters:

tieringPolicy - The new value for the TieringPolicy property for this object.

Returns:

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

tieringPolicy

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

Sets the value of the TieringPolicy property for this object. 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)

ontapVolumeType

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

Parameters:

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.

Returns:

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

See Also:

InputOntapVolumeType, InputOntapVolumeType

ontapVolumeType

CreateOntapVolumeConfiguration.Builder ontapVolumeType(InputOntapVolumeType 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.

Parameters:

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.

Returns:

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

See Also:

InputOntapVolumeType, InputOntapVolumeType

snapshotPolicy

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

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

CreateOntapVolumeConfiguration.Builder snaplockConfiguration(CreateSnaplockConfiguration snaplockConfiguration)

Specifies the SnapLock configuration for an FSx for ONTAP volume.

Parameters:

snaplockConfiguration - Specifies the SnapLock configuration for an FSx for ONTAP volume.

Returns:

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

snaplockConfiguration

default CreateOntapVolumeConfiguration.Builder snaplockConfiguration(Consumer<CreateSnaplockConfiguration.Builder> snaplockConfiguration)

Specifies the SnapLock configuration for an FSx for ONTAP volume.

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

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

Parameters:

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

Returns:

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

See Also:

snaplockConfiguration(CreateSnaplockConfiguration)