Class ClusterNodeDetails

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

Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

See Also:

  • Method Details

    • instanceGroupName

      public final String instanceGroupName()

      The instance group name in which the instance is.

      Returns:
      The instance group name in which the instance is.

    • instanceId

      public final String instanceId()

      The ID of the instance.

      Returns:
      The ID of the instance.

    • instanceStatus

      public final ClusterInstanceStatusDetails instanceStatus()

      The status of the instance.

      Returns:
      The status of the instance.

    • instanceType

      public final ClusterInstanceType instanceType()

      The type of the instance.

      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 type of the instance.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The type of the instance.

      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 type of the instance.
      See Also:

    • launchTime

      public final Instant launchTime()

      The time when the instance is launched.

      Returns:
      The time when the instance is launched.

    • lastSoftwareUpdateTime

      public final Instant lastSoftwareUpdateTime()

      The time when the cluster was last updated.

      Returns:
      The time when the cluster was last updated.

    • lifeCycleConfig

      public final ClusterLifeCycleConfig lifeCycleConfig()

      The LifeCycle configuration applied to the instance.

      Returns:
      The LifeCycle configuration applied to the instance.

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

    • threadsPerCore

      public final Integer threadsPerCore()

      The number of threads per CPU core you specified under CreateCluster.

      Returns:
      The number of threads per CPU core you specified under CreateCluster.

    • 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 configurations of additional storage specified to the instance group where the instance (node) is launched.

      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 configurations of additional storage specified to the instance group where the instance (node) is launched.

    • privatePrimaryIp

      public final String privatePrimaryIp()

      The private primary IP address of the SageMaker HyperPod cluster node.

      Returns:
      The private primary IP address of the SageMaker HyperPod cluster node.

    • privatePrimaryIpv6

      public final String privatePrimaryIpv6()

      The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.

      Returns:
      The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.

    • privateDnsHostname

      public final String privateDnsHostname()

      The private DNS hostname of the SageMaker HyperPod cluster node.

      Returns:
      The private DNS hostname of the SageMaker HyperPod cluster node.

    • placement

      public final ClusterInstancePlacement placement()

      The placement details of the SageMaker HyperPod cluster node.

      Returns:
      The placement details of the SageMaker HyperPod cluster node.

    • toBuilder

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

    • builder

      public static ClusterNodeDetails.Builder builder()

    • serializableBuilderClass

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