Interface ClusterRestrictedInstanceGroupSpecification.Builder

All Superinterfaces:

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

Enclosing class:

ClusterRestrictedInstanceGroupSpecification

@Mutable
@NotThreadSafe
public static interface ClusterRestrictedInstanceGroupSpecification.Builder
extends SdkPojo, CopyableBuilder<ClusterRestrictedInstanceGroupSpecification.Builder,ClusterRestrictedInstanceGroupSpecification>

Method Summary

Modifier and Type	Method	Description
default ClusterRestrictedInstanceGroupSpecification.Builder	environmentConfig(Consumer<EnvironmentConfig.Builder> environmentConfig)	The configuration for the restricted instance groups (RIG) environment.
ClusterRestrictedInstanceGroupSpecification.Builder	environmentConfig(EnvironmentConfig environmentConfig)	The configuration for the restricted instance groups (RIG) environment.
ClusterRestrictedInstanceGroupSpecification.Builder	executionRole(String executionRole)	Specifies an IAM execution role to be assumed by the restricted instance group.
ClusterRestrictedInstanceGroupSpecification.Builder	instanceCount(Integer instanceCount)	Specifies the number of instances to add to the restricted instance group of a SageMaker HyperPod cluster.
ClusterRestrictedInstanceGroupSpecification.Builder	instanceGroupName(String instanceGroupName)	Specifies the name of the restricted instance group.
ClusterRestrictedInstanceGroupSpecification.Builder	instanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)	Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
ClusterRestrictedInstanceGroupSpecification.Builder	instanceStorageConfigs(Consumer<ClusterInstanceStorageConfig.Builder>... instanceStorageConfigs)	Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
ClusterRestrictedInstanceGroupSpecification.Builder	instanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)	Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
ClusterRestrictedInstanceGroupSpecification.Builder	instanceType(String instanceType)	Specifies the instance type of the restricted instance group.
ClusterRestrictedInstanceGroupSpecification.Builder	instanceType(ClusterInstanceType instanceType)	Specifies the instance type of the restricted instance group.
ClusterRestrictedInstanceGroupSpecification.Builder	onStartDeepHealthChecks(Collection<DeepHealthCheckType> onStartDeepHealthChecks)	A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.
ClusterRestrictedInstanceGroupSpecification.Builder	onStartDeepHealthChecks(DeepHealthCheckType... onStartDeepHealthChecks)	A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.
ClusterRestrictedInstanceGroupSpecification.Builder	onStartDeepHealthChecksWithStrings(String... onStartDeepHealthChecks)	A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.
ClusterRestrictedInstanceGroupSpecification.Builder	onStartDeepHealthChecksWithStrings(Collection<String> onStartDeepHealthChecks)	A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.
default ClusterRestrictedInstanceGroupSpecification.Builder	overrideVpcConfig(Consumer<VpcConfig.Builder> overrideVpcConfig)	Sets the value of the OverrideVpcConfig property for this object.
ClusterRestrictedInstanceGroupSpecification.Builder	overrideVpcConfig(VpcConfig overrideVpcConfig)	Sets the value of the OverrideVpcConfig property for this object.
default ClusterRestrictedInstanceGroupSpecification.Builder	scheduledUpdateConfig(Consumer<ScheduledUpdateConfig.Builder> scheduledUpdateConfig)	Sets the value of the ScheduledUpdateConfig property for this object.
ClusterRestrictedInstanceGroupSpecification.Builder	scheduledUpdateConfig(ScheduledUpdateConfig scheduledUpdateConfig)	Sets the value of the ScheduledUpdateConfig property for this object.
ClusterRestrictedInstanceGroupSpecification.Builder	threadsPerCore(Integer threadsPerCore)	The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading.
ClusterRestrictedInstanceGroupSpecification.Builder	trainingPlanArn(String trainingPlanArn)	The Amazon Resource Name (ARN) of the training plan to filter clusters by.

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, sdkFieldNameToField, sdkFields

Method Details

instanceCount

ClusterRestrictedInstanceGroupSpecification.Builder instanceCount(Integer instanceCount)

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

Parameters:

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

Returns:

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

instanceGroupName

ClusterRestrictedInstanceGroupSpecification.Builder instanceGroupName(String instanceGroupName)

Specifies the name of the restricted instance group.

Parameters:

instanceGroupName - Specifies the name of the restricted instance group.

Returns:

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

instanceType

ClusterRestrictedInstanceGroupSpecification.Builder instanceType(String instanceType)

Specifies the instance type of the restricted instance group.

Parameters:

instanceType - Specifies the instance type of the restricted instance group.

Returns:

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

See Also:

• ClusterInstanceType
• ClusterInstanceType

instanceType

ClusterRestrictedInstanceGroupSpecification.Builder instanceType(ClusterInstanceType instanceType)

Specifies the instance type of the restricted instance group.

Parameters:

instanceType - Specifies the instance type of the restricted instance group.

Returns:

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

See Also:

• ClusterInstanceType
• ClusterInstanceType

executionRole

ClusterRestrictedInstanceGroupSpecification.Builder executionRole(String executionRole)

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

Parameters:

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

Returns:

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

threadsPerCore

ClusterRestrictedInstanceGroupSpecification.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

ClusterRestrictedInstanceGroupSpecification.Builder instanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)

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

Parameters:

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

Returns:

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

instanceStorageConfigs

ClusterRestrictedInstanceGroupSpecification.Builder instanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)

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

Parameters:

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

Returns:

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

instanceStorageConfigs

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

Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster restricted 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<ClusterInstanceStorageConfig>).

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

onStartDeepHealthChecksWithStrings

ClusterRestrictedInstanceGroupSpecification.Builder onStartDeepHealthChecksWithStrings(Collection<String> onStartDeepHealthChecks)

A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.

Parameters:

onStartDeepHealthChecks - A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.

Returns:

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

onStartDeepHealthChecksWithStrings

ClusterRestrictedInstanceGroupSpecification.Builder onStartDeepHealthChecksWithStrings(String... onStartDeepHealthChecks)

A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.

Parameters:

onStartDeepHealthChecks - A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.

Returns:

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

onStartDeepHealthChecks

ClusterRestrictedInstanceGroupSpecification.Builder onStartDeepHealthChecks(Collection<DeepHealthCheckType> onStartDeepHealthChecks)

A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.

Parameters:

onStartDeepHealthChecks - A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.

Returns:

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

onStartDeepHealthChecks

ClusterRestrictedInstanceGroupSpecification.Builder onStartDeepHealthChecks(DeepHealthCheckType... onStartDeepHealthChecks)

A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.

Parameters:

onStartDeepHealthChecks - A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.

Returns:

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

trainingPlanArn

ClusterRestrictedInstanceGroupSpecification.Builder trainingPlanArn(String trainingPlanArn)

The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

Parameters:

trainingPlanArn - The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

Returns:

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

overrideVpcConfig

ClusterRestrictedInstanceGroupSpecification.Builder overrideVpcConfig(VpcConfig overrideVpcConfig)

Sets the value of the OverrideVpcConfig property for this object.

Parameters:

overrideVpcConfig - The new value for the OverrideVpcConfig property for this object.

Returns:

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

overrideVpcConfig

default ClusterRestrictedInstanceGroupSpecification.Builder overrideVpcConfig(Consumer<VpcConfig.Builder> overrideVpcConfig)

Sets the value of the OverrideVpcConfig property for this object. This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

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

Parameters:

overrideVpcConfig - a consumer that will call methods on VpcConfig.Builder

Returns:

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

See Also:

• overrideVpcConfig(VpcConfig)

scheduledUpdateConfig

ClusterRestrictedInstanceGroupSpecification.Builder scheduledUpdateConfig(ScheduledUpdateConfig scheduledUpdateConfig)

Sets the value of the ScheduledUpdateConfig property for this object.

Parameters:

scheduledUpdateConfig - The new value for the ScheduledUpdateConfig property for this object.

Returns:

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

scheduledUpdateConfig

default ClusterRestrictedInstanceGroupSpecification.Builder scheduledUpdateConfig(Consumer<ScheduledUpdateConfig.Builder> scheduledUpdateConfig)

Sets the value of the ScheduledUpdateConfig property for this object. This is a convenience method that creates an instance of the ScheduledUpdateConfig.Builder avoiding the need to create one manually via ScheduledUpdateConfig.builder().

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

Parameters:

scheduledUpdateConfig - a consumer that will call methods on ScheduledUpdateConfig.Builder

Returns:

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

See Also:

• scheduledUpdateConfig(ScheduledUpdateConfig)

environmentConfig

ClusterRestrictedInstanceGroupSpecification.Builder environmentConfig(EnvironmentConfig environmentConfig)

The configuration for the restricted instance groups (RIG) environment.

Parameters:

environmentConfig - The configuration for the restricted instance groups (RIG) environment.

Returns:

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

environmentConfig

default ClusterRestrictedInstanceGroupSpecification.Builder environmentConfig(Consumer<EnvironmentConfig.Builder> environmentConfig)

The configuration for the restricted instance groups (RIG) environment.

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

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

Parameters:

environmentConfig - a consumer that will call methods on EnvironmentConfig.Builder

Returns:

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

See Also:

• environmentConfig(EnvironmentConfig)