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()`
`boolean`	`hasInstanceStorageConfigs()`	For responses, this returns true if the service returned a value for the InstanceStorageConfigs property.
`boolean`	`hasOnStartDeepHealthChecks()`	For responses, this returns true if the service returned a value for the OnStartDeepHealthChecks property.
`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.
`List<ClusterInstanceStorageConfig>`	`instanceStorageConfigs()`	Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster 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<DeepHealthCheckType>`	`onStartDeepHealthChecks()`	A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
`List<String>`	`onStartDeepHealthChecksAsStrings()`	A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
`VpcConfig`	`overrideVpcConfig()`	Returns the value of the OverrideVpcConfig property for this object.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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.
`String`	`trainingPlanArn()`	The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.

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 return ClusterInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().
    
    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 return ClusterInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().
    
    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 and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. 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 and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. 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()
```
    Specifies 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:
    
    Specifies 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.
  - trainingPlanArn
```
public final String trainingPlanArn()
```
    The Amazon Resource Name (ARN); of the training plan to use for 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 to use for 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 .
  - overrideVpcConfig
```
public final VpcConfig overrideVpcConfig()
```
    Returns the value of the OverrideVpcConfig property for this object.
    
    Returns:
    
    The value of the OverrideVpcConfig property for this object.
  - toBuilder
```
public ClusterInstanceGroupSpecification.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ClusterInstanceGroupSpecification.Builder,ClusterInstanceGroupSpecification>
  - builder
```
public static ClusterInstanceGroupSpecification.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ClusterInstanceGroupSpecification.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ClusterInstanceGroupSpecification

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

instanceCount

instanceGroupName

instanceType

instanceTypeAsString

lifeCycleConfig

executionRole

threadsPerCore

hasInstanceStorageConfigs

instanceStorageConfigs

onStartDeepHealthChecks

hasOnStartDeepHealthChecks

onStartDeepHealthChecksAsStrings

trainingPlanArn

overrideVpcConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField