Interface CreateClusterRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>, SageMakerRequest.Builder, SdkBuilder<CreateClusterRequest.Builder,CreateClusterRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateClusterRequest

public static interface CreateClusterRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

Method Summary

Modifier and Type	Method	Description
CreateClusterRequest.Builder	clusterName(String clusterName)	The name for the new SageMaker HyperPod cluster.
CreateClusterRequest.Builder	instanceGroups(Collection<ClusterInstanceGroupSpecification> instanceGroups)	The instance groups to be created in the SageMaker HyperPod cluster.
CreateClusterRequest.Builder	instanceGroups(Consumer<ClusterInstanceGroupSpecification.Builder>... instanceGroups)	The instance groups to be created in the SageMaker HyperPod cluster.
CreateClusterRequest.Builder	instanceGroups(ClusterInstanceGroupSpecification... instanceGroups)	The instance groups to be created in the SageMaker HyperPod cluster.
CreateClusterRequest.Builder	nodeRecovery(String nodeRecovery)	The node recovery mode for the SageMaker HyperPod cluster.
CreateClusterRequest.Builder	nodeRecovery(ClusterNodeRecovery nodeRecovery)	The node recovery mode for the SageMaker HyperPod cluster.
default CreateClusterRequest.Builder	orchestrator(Consumer<ClusterOrchestrator.Builder> orchestrator)	The type of orchestrator to use for the SageMaker HyperPod cluster.
CreateClusterRequest.Builder	orchestrator(ClusterOrchestrator orchestrator)	The type of orchestrator to use for the SageMaker HyperPod cluster.
CreateClusterRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateClusterRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateClusterRequest.Builder	tags(Collection<Tag> tags)	Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource.
CreateClusterRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource.
CreateClusterRequest.Builder	tags(Tag... tags)	Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource.
default CreateClusterRequest.Builder	vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)	Sets the value of the VpcConfig property for this object.
CreateClusterRequest.Builder	vpcConfig(VpcConfig vpcConfig)	Sets the value of the VpcConfig property for this object.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

clusterName

CreateClusterRequest.Builder clusterName(String clusterName)

The name for the new SageMaker HyperPod cluster.

Parameters:

clusterName - The name for the new SageMaker HyperPod cluster.

Returns:

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

instanceGroups

CreateClusterRequest.Builder instanceGroups(Collection<ClusterInstanceGroupSpecification> instanceGroups)

The instance groups to be created in the SageMaker HyperPod cluster.

Parameters:

instanceGroups - The instance groups to be created in the SageMaker HyperPod cluster.

Returns:

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

instanceGroups

CreateClusterRequest.Builder instanceGroups(ClusterInstanceGroupSpecification... instanceGroups)

The instance groups to be created in the SageMaker HyperPod cluster.

Parameters:

instanceGroups - The instance groups to be created in the SageMaker HyperPod cluster.

Returns:

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

instanceGroups

CreateClusterRequest.Builder instanceGroups(Consumer<ClusterInstanceGroupSpecification.Builder>... instanceGroups)

The instance groups to be created in the SageMaker HyperPod cluster.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceGroups(List<ClusterInstanceGroupSpecification>).

Parameters:

instanceGroups - a consumer that will call methods on ClusterInstanceGroupSpecification.Builder

Returns:

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

See Also:

• instanceGroups(java.util.Collection<ClusterInstanceGroupSpecification>)

vpcConfig

CreateClusterRequest.Builder vpcConfig(VpcConfig vpcConfig)

Sets the value of the VpcConfig property for this object.

Parameters:

vpcConfig - The new value for the VpcConfig property for this object.

Returns:

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

vpcConfig

default CreateClusterRequest.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

Sets the value of the VpcConfig 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 vpcConfig(VpcConfig).

Parameters:

vpcConfig - 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:

• vpcConfig(VpcConfig)

tags

CreateClusterRequest.Builder tags(Collection<Tag> tags)

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

Parameters:

tags - Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

Returns:

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

tags

CreateClusterRequest.Builder tags(Tag... tags)

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

Parameters:

tags - Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

Returns:

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

tags

CreateClusterRequest.Builder tags(Consumer<Tag.Builder>... tags)

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

orchestrator

CreateClusterRequest.Builder orchestrator(ClusterOrchestrator orchestrator)

The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is "eks", which is to use an Amazon Elastic Kubernetes Service (EKS) cluster as the orchestrator.

Parameters:

orchestrator - The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is "eks", which is to use an Amazon Elastic Kubernetes Service (EKS) cluster as the orchestrator.

Returns:

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

orchestrator

default CreateClusterRequest.Builder orchestrator(Consumer<ClusterOrchestrator.Builder> orchestrator)

The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is "eks", which is to use an Amazon Elastic Kubernetes Service (EKS) cluster as the orchestrator.

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

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

Parameters:

orchestrator - a consumer that will call methods on ClusterOrchestrator.Builder

Returns:

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

See Also:

• orchestrator(ClusterOrchestrator)

nodeRecovery

CreateClusterRequest.Builder nodeRecovery(String nodeRecovery)

The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.

Parameters:

nodeRecovery - The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.

Returns:

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

See Also:

• ClusterNodeRecovery
• ClusterNodeRecovery

nodeRecovery

CreateClusterRequest.Builder nodeRecovery(ClusterNodeRecovery nodeRecovery)

The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.

Parameters:

nodeRecovery - The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.

Returns:

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

See Also:

• ClusterNodeRecovery
• ClusterNodeRecovery

overrideConfiguration

CreateClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.