Package software.amazon.awssdk.services.sagemaker.model

Interface ClusterInstanceGroupDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ClusterInstanceGroupDetails.Builder,ClusterInstanceGroupDetails>, SdkBuilder<ClusterInstanceGroupDetails.Builder,ClusterInstanceGroupDetails>, SdkPojo

Enclosing class:

ClusterInstanceGroupDetails

public static interface ClusterInstanceGroupDetails.Builder
extends SdkPojo, CopyableBuilder<ClusterInstanceGroupDetails.Builder,ClusterInstanceGroupDetails>

Method Summary

Modifier and Type	Method	Description
ClusterInstanceGroupDetails.Builder	currentCount(Integer currentCount)	The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
ClusterInstanceGroupDetails.Builder	executionRole(String executionRole)	The execution role for the instance group to assume.
ClusterInstanceGroupDetails.Builder	instanceGroupName(String instanceGroupName)	The name of the instance group of a SageMaker HyperPod cluster.
ClusterInstanceGroupDetails.Builder	instanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)	The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
ClusterInstanceGroupDetails.Builder	instanceStorageConfigs(Consumer<ClusterInstanceStorageConfig.Builder>... instanceStorageConfigs)	The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
ClusterInstanceGroupDetails.Builder	instanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)	The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
ClusterInstanceGroupDetails.Builder	instanceType(String instanceType)	The instance type of the instance group of a SageMaker HyperPod cluster.
ClusterInstanceGroupDetails.Builder	instanceType(ClusterInstanceType instanceType)	The instance type of the instance group of a SageMaker HyperPod cluster.
default ClusterInstanceGroupDetails.Builder	lifeCycleConfig(Consumer<ClusterLifeCycleConfig.Builder> lifeCycleConfig)	Details of LifeCycle configuration for the instance group.
ClusterInstanceGroupDetails.Builder	lifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)	Details of LifeCycle configuration for the instance group.
ClusterInstanceGroupDetails.Builder	targetCount(Integer targetCount)	The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
ClusterInstanceGroupDetails.Builder	threadsPerCore(Integer threadsPerCore)	The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

currentCount

ClusterInstanceGroupDetails.Builder currentCount(Integer currentCount)

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

Parameters:

currentCount - The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetCount

ClusterInstanceGroupDetails.Builder targetCount(Integer targetCount)

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

Parameters:

targetCount - The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceGroupName

ClusterInstanceGroupDetails.Builder instanceGroupName(String instanceGroupName)

The name of the instance group of a SageMaker HyperPod cluster.

Parameters:

instanceGroupName - The name of the instance group of a SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceType

ClusterInstanceGroupDetails.Builder instanceType(String instanceType)

The instance type of the instance group of a SageMaker HyperPod cluster.

Parameters:

instanceType - The instance type of the instance group of a SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ClusterInstanceType, ClusterInstanceType

instanceType

ClusterInstanceGroupDetails.Builder instanceType(ClusterInstanceType instanceType)

The instance type of the instance group of a SageMaker HyperPod cluster.

Parameters:

instanceType - The instance type of the instance group of a SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ClusterInstanceType, ClusterInstanceType

lifeCycleConfig

ClusterInstanceGroupDetails.Builder lifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)

Details of LifeCycle configuration for the instance group.

Parameters:

lifeCycleConfig - Details of LifeCycle configuration for the instance group.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifeCycleConfig

default ClusterInstanceGroupDetails.Builder lifeCycleConfig(Consumer<ClusterLifeCycleConfig.Builder> lifeCycleConfig)

Details of LifeCycle configuration for the instance group.

This is a convenience method that creates an instance of the ClusterLifeCycleConfig.Builder avoiding the need to create one manually via ClusterLifeCycleConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lifeCycleConfig(ClusterLifeCycleConfig).

Parameters:

lifeCycleConfig - a consumer that will call methods on ClusterLifeCycleConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lifeCycleConfig(ClusterLifeCycleConfig)

executionRole

ClusterInstanceGroupDetails.Builder executionRole(String executionRole)

The execution role for the instance group to assume.

Parameters:

executionRole - The execution role for the instance group to assume.

Returns:

Returns a reference to this object so that method calls can be chained together.

threadsPerCore

ClusterInstanceGroupDetails.Builder threadsPerCore(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

instanceStorageConfigs

ClusterInstanceGroupDetails.Builder instanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceStorageConfigs

ClusterInstanceGroupDetails.Builder instanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceStorageConfigs

ClusterInstanceGroupDetails.Builder instanceStorageConfigs(Consumer<ClusterInstanceStorageConfig.Builder>... instanceStorageConfigs)

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

This is a convenience method that creates an instance of the ClusterInstanceStorageConfig.Builder avoiding the need to create one manually via ClusterInstanceStorageConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #instanceStorageConfigs(List).

Parameters:

instanceStorageConfigs - a consumer that will call methods on ClusterInstanceStorageConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#instanceStorageConfigs(java.util.Collection)