software.amazon.awssdk.services.fsx.model

Class CreateOntapVolumeConfiguration

java.lang.Object

software.amazon.awssdk.services.fsx.model.CreateOntapVolumeConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CreateOntapVolumeConfiguration.Builder,CreateOntapVolumeConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateOntapVolumeConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CreateOntapVolumeConfiguration.Builder,CreateOntapVolumeConfiguration>

Specifies the configuration of the ONTAP volume that you are creating.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateOntapVolumeConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static CreateOntapVolumeConfiguration.Builder	builder()
Boolean	copyTagsToBackups() A boolean flag indicating whether tags for the volume should be copied to backups.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	junctionPath() Specifies the location in the SVM's namespace where the volume is mounted.
InputOntapVolumeType	ontapVolumeType() Specifies the type of volume you are creating.
String	ontapVolumeTypeAsString() Specifies the type of volume you are creating.
List<SdkField<?>>	sdkFields()
SecurityStyle	securityStyle() Specifies the security style for the volume.
String	securityStyleAsString() Specifies the security style for the volume.
static Class<? extends CreateOntapVolumeConfiguration.Builder>	serializableBuilderClass()
Integer	sizeInMegabytes() Specifies the size of the volume, in megabytes (MB), that you are creating.
CreateSnaplockConfiguration	snaplockConfiguration() Specifies the SnapLock configuration for an FSx for ONTAP volume.
String	snapshotPolicy() Specifies the snapshot policy for the volume.
Boolean	storageEfficiencyEnabled() Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
String	storageVirtualMachineId() Specifies the ONTAP SVM in which to create the volume.
TieringPolicy	tieringPolicy() Returns the value of the TieringPolicy property for this object.
CreateOntapVolumeConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

junctionPath

public final 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.

Returns:

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.

securityStyle

public final 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.

If the service returns an enum value that is not available in the current SDK version, securityStyle will return SecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityStyleAsString().

Returns:

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.

See Also:

SecurityStyle

securityStyleAsString

public final String securityStyleAsString()

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.

If the service returns an enum value that is not available in the current SDK version, securityStyle will return SecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityStyleAsString().

Returns:

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.

See Also:

SecurityStyle

sizeInMegabytes

public final Integer sizeInMegabytes()

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

Returns:

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

storageEfficiencyEnabled

public final 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.

Returns:

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.

storageVirtualMachineId

public final String storageVirtualMachineId()

Specifies the ONTAP SVM in which to create the volume.

Returns:

Specifies the ONTAP SVM in which to create the volume.

tieringPolicy

public final TieringPolicy tieringPolicy()

Returns the value of the TieringPolicy property for this object.

Returns:

The value of the TieringPolicy property for this object.

ontapVolumeType

public final 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.

If the service returns an enum value that is not available in the current SDK version, ontapVolumeType will return InputOntapVolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ontapVolumeTypeAsString().

Returns:

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.

See Also:

InputOntapVolumeType

ontapVolumeTypeAsString

public final String ontapVolumeTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, ontapVolumeType will return InputOntapVolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ontapVolumeTypeAsString().

Returns:

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.

See Also:

InputOntapVolumeType

snapshotPolicy

public final 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.

Returns:

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.

copyTagsToBackups

public final 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.

Returns:

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.

snaplockConfiguration

public final CreateSnaplockConfiguration snaplockConfiguration()

Specifies the SnapLock configuration for an FSx for ONTAP volume.

Returns:

Specifies the SnapLock configuration for an FSx for ONTAP volume.

toBuilder

public CreateOntapVolumeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateOntapVolumeConfiguration.Builder,CreateOntapVolumeConfiguration>

builder

public static CreateOntapVolumeConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends CreateOntapVolumeConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo