Class OntapVolumeConfiguration

java.lang.Object
software.amazon.awssdk.services.fsx.model.OntapVolumeConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OntapVolumeConfiguration.Builder,OntapVolumeConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class OntapVolumeConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OntapVolumeConfiguration.Builder,OntapVolumeConfiguration>

The configuration of an Amazon FSx for NetApp ONTAP volume.

See Also:

  • Method Details

    • flexCacheEndpointType

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

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

      Returns:
      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.

      See Also:

    • flexCacheEndpointTypeAsString

      public final String flexCacheEndpointTypeAsString()

      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.

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

      Returns:
      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.

      See Also:

    • junctionPath

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

      Returns:
      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.

    • securityStyle

      public final SecurityStyle securityStyle()

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

      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:
      The security style for the volume, which can be UNIX, NTFS, or MIXED.
      See Also:

    • securityStyleAsString

      public final String securityStyleAsString()

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

      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:
      The security style for the volume, which can be UNIX, NTFS, or MIXED.
      See Also:

    • sizeInMegabytes

      public final Integer sizeInMegabytes()

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

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

    • storageEfficiencyEnabled

      public final Boolean storageEfficiencyEnabled()

      The volume's storage efficiency setting.

      Returns:
      The volume's storage efficiency setting.

    • storageVirtualMachineId

      public final String storageVirtualMachineId()

      The ID of the volume's storage virtual machine.

      Returns:
      The ID of the volume's storage virtual machine.

    • storageVirtualMachineRoot

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

      Returns:
      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.

    • tieringPolicy

      public final TieringPolicy tieringPolicy()

      The volume's TieringPolicy setting.

      Returns:
      The volume's TieringPolicy setting.

    • uuid

      public final String uuid()

      The volume's universally unique identifier (UUID).

      Returns:
      The volume's universally unique identifier (UUID).

    • ontapVolumeType

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

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

      Returns:
      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.

      See Also:

    • ontapVolumeTypeAsString

      public final String ontapVolumeTypeAsString()

      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.

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

      Returns:
      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.

      See Also:

    • 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 SnaplockConfiguration snaplockConfiguration()

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

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

    • volumeStyle

      public final VolumeStyle volumeStyle()

      Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

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

      Returns:
      Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
      See Also:

    • volumeStyleAsString

      public final String volumeStyleAsString()

      Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

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

      Returns:
      Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
      See Also:

    • aggregateConfiguration

      public final AggregateConfiguration aggregateConfiguration()

      This structure specifies configuration options for a volume’s storage aggregate or aggregates.

      Returns:
      This structure specifies configuration options for a volume’s storage aggregate or aggregates.

    • sizeInBytes

      public final Long sizeInBytes()

      The configured size of the volume, in bytes.

      Returns:
      The configured size of the volume, in bytes.

    • toBuilder

      public OntapVolumeConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OntapVolumeConfiguration.Builder,OntapVolumeConfiguration>
      Returns:
      a builder for type T

    • builder

      public static OntapVolumeConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OntapVolumeConfiguration.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.