Class ClusterInstanceGroupSpecification
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.ClusterInstanceGroupSpecification
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ClusterInstanceGroupSpecification.Builder,ClusterInstanceGroupSpecification>
@Generated("software.amazon.awssdk:codegen") public final class ClusterInstanceGroupSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClusterInstanceGroupSpecification.Builder,ClusterInstanceGroupSpecification>
The specifications of an instance group that you need to define.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ClusterInstanceGroupSpecification.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ClusterInstanceGroupSpecification.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
executionRole()
Specifies an IAM execution role to be assumed by the instance group.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Integer
instanceCount()
Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.String
instanceGroupName()
Specifies the name of the instance group.ClusterInstanceType
instanceType()
Specifies the instance type of the instance group.String
instanceTypeAsString()
Specifies the instance type of the instance group.ClusterLifeCycleConfig
lifeCycleConfig()
Specifies the LifeCycle configuration for the instance group.List<SdkField<?>>
sdkFields()
static Class<? extends ClusterInstanceGroupSpecification.Builder>
serializableBuilderClass()
Integer
threadsPerCore()
Specifies the value for Threads per core.ClusterInstanceGroupSpecification.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
-
instanceCount
public final Integer instanceCount()
Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
- Returns:
- Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
-
instanceGroupName
public final String instanceGroupName()
Specifies the name of the instance group.
- Returns:
- Specifies the name of the instance group.
-
instanceType
public final ClusterInstanceType instanceType()
Specifies the instance type of the instance group.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnClusterInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- Specifies the instance type of the instance group.
- See Also:
ClusterInstanceType
-
instanceTypeAsString
public final String instanceTypeAsString()
Specifies the instance type of the instance group.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnClusterInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- Specifies the instance type of the instance group.
- See Also:
ClusterInstanceType
-
lifeCycleConfig
public final ClusterLifeCycleConfig lifeCycleConfig()
Specifies the LifeCycle configuration for the instance group.
- Returns:
- Specifies the LifeCycle configuration for the instance group.
-
executionRole
public final String executionRole()
Specifies an IAM execution role to be assumed by the instance group.
- Returns:
- Specifies an IAM execution role to be assumed by the instance group.
-
threadsPerCore
public final Integer threadsPerCore()
Specifies the value for Threads per core. For instance types that support multithreading, you can specify
1
for disabling multithreading and2
for enabling multithreading. For instance types that doesn't support multithreading, specify1
. 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:
- Specifies the value for Threads per core. For instance types that support multithreading, you can
specify
1
for disabling multithreading and2
for enabling multithreading. For instance types that doesn't support multithreading, specify1
. 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 ClusterInstanceGroupSpecification.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ClusterInstanceGroupSpecification.Builder,ClusterInstanceGroupSpecification>
-
builder
public static ClusterInstanceGroupSpecification.Builder builder()
-
serializableBuilderClass
public static Class<? extends ClusterInstanceGroupSpecification.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-