Class ClusterTieredStorageConfig

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

Defines the configuration for managed tier checkpointing in a HyperPod cluster. Managed tier checkpointing uses multiple storage tiers, including cluster CPU memory, to provide faster checkpoint operations and improved fault tolerance for large-scale model training. The system automatically saves checkpoints at high frequency to memory and periodically persists them to durable storage, like Amazon S3.

See Also:

  • Method Details

    • mode

      public final ClusterConfigMode mode()

      Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to Enable, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to Disable, the feature is turned off and the memory management daemon is removed from the cluster.

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

      Returns:
      Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to Enable, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to Disable, the feature is turned off and the memory management daemon is removed from the cluster.
      See Also:

    • modeAsString

      public final String modeAsString()

      Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to Enable, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to Disable, the feature is turned off and the memory management daemon is removed from the cluster.

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

      Returns:
      Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to Enable, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to Disable, the feature is turned off and the memory management daemon is removed from the cluster.
      See Also:

    • instanceMemoryAllocationPercentage

      public final Integer instanceMemoryAllocationPercentage()

      The percentage (int) of cluster memory to allocate for checkpointing.

      Returns:
      The percentage (int) of cluster memory to allocate for checkpointing.

    • toBuilder

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

    • builder

      public static ClusterTieredStorageConfig.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.