Package software.amazon.awssdk.services.fsx.model

Class 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:
    Serialized Form

    • Method Detail

      • 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:
        TieringPolicyName

      • 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:
        TieringPolicyName

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)