Class UpdateOntapVolumeConfiguration

java.lang.Object
software.amazon.awssdk.services.fsx.model.UpdateOntapVolumeConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UpdateOntapVolumeConfiguration.Builder,UpdateOntapVolumeConfiguration>

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

Used to specify changes to the ONTAP configuration for the volume you are updating.

See Also:
  • Method Details

    • junctionPath

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

      Returns:
      Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /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()

      Specifies the size of the volume in megabytes.

      Returns:
      Specifies the size of the volume in megabytes.
    • storageEfficiencyEnabled

      public final Boolean storageEfficiencyEnabled()

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

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

      public final TieringPolicy tieringPolicy()

      Update the volume's data tiering policy.

      Returns:
      Update the volume's data tiering policy.
    • 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 UpdateSnaplockConfiguration snaplockConfiguration()

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

      Returns:
      The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
    • sizeInBytes

      public final Long sizeInBytes()

      The configured size of the volume, in bytes.

      Returns:
      The configured size of the volume, in bytes.
    • 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<UpdateOntapVolumeConfiguration.Builder,UpdateOntapVolumeConfiguration>
      Returns:
      a builder for type T
    • builder

      public static UpdateOntapVolumeConfiguration.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UpdateOntapVolumeConfiguration.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.