Package software.amazon.awssdk.services.sagemaker.model

Class ClusterInstanceGroupDetails

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

Details of an instance group in a SageMaker HyperPod cluster.

See Also:

  • Method Details

    • currentCount

      public final Integer currentCount()

      The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

      Returns:
      The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

    • targetCount

      public final Integer targetCount()

      The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

      Returns:
      The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

    • instanceGroupName

      public final String instanceGroupName()

      The name of the instance group of a SageMaker HyperPod cluster.

      Returns:
      The name of the instance group of a SageMaker HyperPod cluster.

    • instanceType

      public final ClusterInstanceType instanceType()

      The instance type of the instance group of a SageMaker HyperPod cluster.

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

      Returns:
      The instance type of the instance group of a SageMaker HyperPod cluster.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The instance type of the instance group of a SageMaker HyperPod cluster.

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

      Returns:
      The instance type of the instance group of a SageMaker HyperPod cluster.
      See Also:

    • lifeCycleConfig

      public final ClusterLifeCycleConfig lifeCycleConfig()

      Details of LifeCycle configuration for the instance group.

      Returns:
      Details of LifeCycle configuration for the instance group.

    • executionRole

      public final String executionRole()

      The execution role for the instance group to assume.

      Returns:
      The execution role for the instance group to assume.

    • threadsPerCore

      public final Integer threadsPerCore()

      The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

      Returns:
      The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

    • toBuilder

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

    • builder

      public static ClusterInstanceGroupDetails.Builder builder()

    • serializableBuilderClass

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