Class ClusterInstanceStorageConfig

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

Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

See Also:

  • Method Details

    • ebsVolumeConfig

      public final ClusterEbsVolumeConfig ebsVolumeConfig()

      Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

      Returns:
      Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

    • fsxLustreConfig

      public final ClusterFsxLustreConfig fsxLustreConfig()

      Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.

      Returns:
      Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.

    • fsxOpenZfsConfig

      public final ClusterFsxOpenZfsConfig fsxOpenZfsConfig()

      Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.

      Returns:
      Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.

    • toBuilder

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

    • builder

      public static ClusterInstanceStorageConfig.Builder builder()

    • serializableBuilderClass

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

    • fromEbsVolumeConfig

      public static ClusterInstanceStorageConfig fromEbsVolumeConfig(ClusterEbsVolumeConfig ebsVolumeConfig)
      Create an instance of this class with ebsVolumeConfig() initialized to the given value.

      Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

      Parameters:
      ebsVolumeConfig - Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

    • fromEbsVolumeConfig

      public static ClusterInstanceStorageConfig fromEbsVolumeConfig(Consumer<ClusterEbsVolumeConfig.Builder> ebsVolumeConfig)
      Create an instance of this class with ebsVolumeConfig() initialized to the given value.

      Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

      Parameters:
      ebsVolumeConfig - Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

    • fromFsxLustreConfig

      public static ClusterInstanceStorageConfig fromFsxLustreConfig(ClusterFsxLustreConfig fsxLustreConfig)
      Create an instance of this class with fsxLustreConfig() initialized to the given value.

      Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.

      Parameters:
      fsxLustreConfig - Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.

    • fromFsxLustreConfig

      public static ClusterInstanceStorageConfig fromFsxLustreConfig(Consumer<ClusterFsxLustreConfig.Builder> fsxLustreConfig)
      Create an instance of this class with fsxLustreConfig() initialized to the given value.

      Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.

      Parameters:
      fsxLustreConfig - Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.

    • fromFsxOpenZfsConfig

      public static ClusterInstanceStorageConfig fromFsxOpenZfsConfig(ClusterFsxOpenZfsConfig fsxOpenZfsConfig)
      Create an instance of this class with fsxOpenZfsConfig() initialized to the given value.

      Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.

      Parameters:
      fsxOpenZfsConfig - Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.

    • fromFsxOpenZfsConfig

      public static ClusterInstanceStorageConfig fromFsxOpenZfsConfig(Consumer<ClusterFsxOpenZfsConfig.Builder> fsxOpenZfsConfig)
      Create an instance of this class with fsxOpenZfsConfig() initialized to the given value.

      Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.

      Parameters:
      fsxOpenZfsConfig - Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.

    • type

      public ClusterInstanceStorageConfig.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ClusterInstanceStorageConfig.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ClusterInstanceStorageConfig.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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