Class TieringPolicy

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

Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:

  • SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

  • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

  • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

  • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

See Also:

  • Method Details

    • coolingPeriod

      public final Integer coolingPeriod()

      Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.

      Returns:
      Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.

    • name

      public final TieringPolicyName name()

      Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

      • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

      • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

      • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

      • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

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

      Returns:
      Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

      • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

      • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

      • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

      • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

      See Also:

    • nameAsString

      public final String nameAsString()

      Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

      • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

      • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

      • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

      • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

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

      Returns:
      Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

      • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

      • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

      • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

      • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

      See Also:

    • toBuilder

      public TieringPolicy.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<TieringPolicy.Builder,TieringPolicy>
      Returns:
      a builder for type T

    • builder

      public static TieringPolicy.Builder builder()

    • serializableBuilderClass

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