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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClusterInstanceGroupDetails.Builder

Method Summary

Modifier and Type	Method	Description
static ClusterInstanceGroupDetails.Builder	builder()
Integer	currentCount()	The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRole()	The execution role for the instance group to assume.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceStorageConfigs()	For responses, this returns true if the service returned a value for the InstanceStorageConfigs property.
String	instanceGroupName()	The name of the instance group of a SageMaker HyperPod cluster.
List<ClusterInstanceStorageConfig>	instanceStorageConfigs()	The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
ClusterInstanceType	instanceType()	The instance type of the instance group of a SageMaker HyperPod cluster.
String	instanceTypeAsString()	The instance type of the instance group of a SageMaker HyperPod cluster.
ClusterLifeCycleConfig	lifeCycleConfig()	Details of LifeCycle configuration for the instance group.
List<SdkField<?>>	sdkFields()
static Class<? extends ClusterInstanceGroupDetails.Builder>	serializableBuilderClass()
Integer	targetCount()	The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
Integer	threadsPerCore()	The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading.
ClusterInstanceGroupDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ClusterInstanceType

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:

ClusterInstanceType

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.

toBuilder

public ClusterInstanceGroupDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClusterInstanceGroupDetails.Builder,ClusterInstanceGroupDetails>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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