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

Interface ClusterInstanceGroupSpecification.Builder

All Superinterfaces:

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

Enclosing class:

ClusterInstanceGroupSpecification

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

Method Summary

Modifier and Type	Method	Description
ClusterInstanceGroupSpecification.Builder	executionRole(String executionRole)	Specifies an IAM execution role to be assumed by the instance group.
ClusterInstanceGroupSpecification.Builder	instanceCount(Integer instanceCount)	Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
ClusterInstanceGroupSpecification.Builder	instanceGroupName(String instanceGroupName)	Specifies the name of the instance group.
ClusterInstanceGroupSpecification.Builder	instanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)	Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
ClusterInstanceGroupSpecification.Builder	instanceStorageConfigs(Consumer<ClusterInstanceStorageConfig.Builder>... instanceStorageConfigs)	Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
ClusterInstanceGroupSpecification.Builder	instanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)	Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
ClusterInstanceGroupSpecification.Builder	instanceType(String instanceType)	Specifies the instance type of the instance group.
ClusterInstanceGroupSpecification.Builder	instanceType(ClusterInstanceType instanceType)	Specifies the instance type of the instance group.
default ClusterInstanceGroupSpecification.Builder	lifeCycleConfig(Consumer<ClusterLifeCycleConfig.Builder> lifeCycleConfig)	Specifies the LifeCycle configuration for the instance group.
ClusterInstanceGroupSpecification.Builder	lifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)	Specifies the LifeCycle configuration for the instance group.
ClusterInstanceGroupSpecification.Builder	threadsPerCore(Integer threadsPerCore)	Specifies the value for Threads per core.

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

instanceCount

ClusterInstanceGroupSpecification.Builder instanceCount(Integer instanceCount)

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

Parameters:

instanceCount - Specifies the number of instances 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

ClusterInstanceGroupSpecification.Builder instanceGroupName(String instanceGroupName)

Specifies the name of the instance group.

Parameters:

instanceGroupName - Specifies the name of the instance group.

Returns:

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

instanceType

ClusterInstanceGroupSpecification.Builder instanceType(String instanceType)

Specifies the instance type of the instance group.

Parameters:

instanceType - Specifies the instance type of the instance group.

Returns:

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

See Also:

ClusterInstanceType, ClusterInstanceType

instanceType

ClusterInstanceGroupSpecification.Builder instanceType(ClusterInstanceType instanceType)

Specifies the instance type of the instance group.

Parameters:

instanceType - Specifies the instance type of the instance group.

Returns:

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

See Also:

ClusterInstanceType, ClusterInstanceType

lifeCycleConfig

ClusterInstanceGroupSpecification.Builder lifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)

Specifies the LifeCycle configuration for the instance group.

Parameters:

lifeCycleConfig - Specifies the LifeCycle configuration for the instance group.

Returns:

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

lifeCycleConfig

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

Specifies the 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

ClusterInstanceGroupSpecification.Builder executionRole(String executionRole)

Specifies an IAM execution role to be assumed by the instance group.

Parameters:

executionRole - Specifies an IAM execution role to be assumed by the instance group.

Returns:

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

threadsPerCore

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

Parameters:

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:

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

instanceStorageConfigs

ClusterInstanceGroupSpecification.Builder instanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)

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

Parameters:

instanceStorageConfigs - Specifies 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

ClusterInstanceGroupSpecification.Builder instanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)

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

Parameters:

instanceStorageConfigs - Specifies 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

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

Specifies 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)