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.

    • hasInstanceStorageConfigs

      public final boolean hasInstanceStorageConfigs()
      For responses, this returns true if the service returned a value for the InstanceStorageConfigs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • instanceStorageConfigs

      public final List<ClusterInstanceStorageConfig> instanceStorageConfigs()

      The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceStorageConfigs() method.

      Returns:
      The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.

    • onStartDeepHealthChecks

      public final List<DeepHealthCheckType> onStartDeepHealthChecks()

      A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOnStartDeepHealthChecks() method.

      Returns:
      A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

    • hasOnStartDeepHealthChecks

      public final boolean hasOnStartDeepHealthChecks()
      For responses, this returns true if the service returned a value for the OnStartDeepHealthChecks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • onStartDeepHealthChecksAsStrings

      public final List<String> onStartDeepHealthChecksAsStrings()

      A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOnStartDeepHealthChecks() method.

      Returns:
      A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

    • status

      public final InstanceGroupStatus status()

      The current status of the cluster instance group.

      • InService: The instance group is active and healthy.

      • Creating: The instance group is being provisioned.

      • Updating: The instance group is being updated.

      • Failed: The instance group has failed to provision or is no longer healthy.

      • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

      • Deleting: The instance group is being deleted.

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

      Returns:
      The current status of the cluster instance group.

      • InService: The instance group is active and healthy.

      • Creating: The instance group is being provisioned.

      • Updating: The instance group is being updated.

      • Failed: The instance group has failed to provision or is no longer healthy.

      • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

      • Deleting: The instance group is being deleted.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the cluster instance group.

      • InService: The instance group is active and healthy.

      • Creating: The instance group is being provisioned.

      • Updating: The instance group is being updated.

      • Failed: The instance group has failed to provision or is no longer healthy.

      • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

      • Deleting: The instance group is being deleted.

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

      Returns:
      The current status of the cluster instance group.

      • InService: The instance group is active and healthy.

      • Creating: The instance group is being provisioned.

      • Updating: The instance group is being updated.

      • Failed: The instance group has failed to provision or is no longer healthy.

      • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

      • Deleting: The instance group is being deleted.

      See Also:

    • trainingPlanArn

      public final String trainingPlanArn()

      The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.

      For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

      Returns:
      The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.

      For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

    • trainingPlanStatus

      public final String trainingPlanStatus()

      The current status of the training plan associated with this cluster instance group.

      Returns:
      The current status of the training plan associated with this cluster instance group.

    • overrideVpcConfig

      public final VpcConfig overrideVpcConfig()

      The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

      Returns:
      The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

    • scheduledUpdateConfig

      public final ScheduledUpdateConfig scheduledUpdateConfig()

      The configuration object of the schedule that SageMaker follows when updating the AMI.

      Returns:
      The configuration object of the schedule that SageMaker follows when updating the AMI.

    • currentImageId

      public final String currentImageId()

      The ID of the Amazon Machine Image (AMI) currently in use by the instance group.

      Returns:
      The ID of the Amazon Machine Image (AMI) currently in use by the instance group.

    • desiredImageId

      public final String desiredImageId()

      The ID of the Amazon Machine Image (AMI) desired for the instance group.

      Returns:
      The ID of the Amazon Machine Image (AMI) desired for the instance group.

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

    • sdkFieldNameToField

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