Interface CreateClusterRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>, SageMakerRequest.Builder, SdkBuilder<CreateClusterRequest.Builder,CreateClusterRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateClusterRequest
@Mutable @NotThreadSafe public static interface CreateClusterRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

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

    • restrictedInstanceGroups

      CreateClusterRequest.Builder restrictedInstanceGroups(Collection<ClusterRestrictedInstanceGroupSpecification> restrictedInstanceGroups)

      The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

      Parameters:
      restrictedInstanceGroups - The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • restrictedInstanceGroups

      CreateClusterRequest.Builder restrictedInstanceGroups(ClusterRestrictedInstanceGroupSpecification... restrictedInstanceGroups)

      The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

      Parameters:
      restrictedInstanceGroups - The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • restrictedInstanceGroups

      CreateClusterRequest.Builder restrictedInstanceGroups(Consumer<ClusterRestrictedInstanceGroupSpecification.Builder>... restrictedInstanceGroups)

      The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

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

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

      Parameters:
      restrictedInstanceGroups - a consumer that will call methods on ClusterRestrictedInstanceGroupSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcConfig

      CreateClusterRequest.Builder vpcConfig(VpcConfig vpcConfig)

      Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.

      When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:

      • Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.

      • In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.

      Additional resources for IPv6 configuration:

      Parameters:
      vpcConfig - Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.

      When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:

      • Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.

      • In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.

      Additional resources for IPv6 configuration:

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

    • vpcConfig

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

      Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.

      When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:

      • Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.

      • In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.

      Additional resources for IPv6 configuration:

      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:

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

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

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

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

    • tieredStorageConfig

      CreateClusterRequest.Builder tieredStorageConfig(ClusterTieredStorageConfig tieredStorageConfig)

      The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.

      Parameters:
      tieredStorageConfig - The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tieredStorageConfig

      default CreateClusterRequest.Builder tieredStorageConfig(Consumer<ClusterTieredStorageConfig.Builder> tieredStorageConfig)

      The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.

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

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

      Parameters:
      tieredStorageConfig - a consumer that will call methods on ClusterTieredStorageConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nodeProvisioningMode

      CreateClusterRequest.Builder nodeProvisioningMode(String nodeProvisioningMode)

      The mode for provisioning nodes in the cluster. You can specify the following modes:

      • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

      Parameters:
      nodeProvisioningMode - The mode for provisioning nodes in the cluster. You can specify the following modes:

      • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

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

    • nodeProvisioningMode

      CreateClusterRequest.Builder nodeProvisioningMode(ClusterNodeProvisioningMode nodeProvisioningMode)

      The mode for provisioning nodes in the cluster. You can specify the following modes:

      • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

      Parameters:
      nodeProvisioningMode - The mode for provisioning nodes in the cluster. You can specify the following modes:

      • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

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

    • clusterRole

      CreateClusterRequest.Builder clusterRole(String clusterRole)

      The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations. This role must have permissions for sagemaker:BatchAddClusterNodes and sagemaker:BatchDeleteClusterNodes. This is only required when autoscaling is enabled and when HyperPod is performing autoscaling operations.

      Parameters:
      clusterRole - The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations. This role must have permissions for sagemaker:BatchAddClusterNodes and sagemaker:BatchDeleteClusterNodes. This is only required when autoscaling is enabled and when HyperPod is performing autoscaling operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoScaling

      CreateClusterRequest.Builder autoScaling(ClusterAutoScalingConfig autoScaling)

      The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.

      Parameters:
      autoScaling - The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoScaling

      default CreateClusterRequest.Builder autoScaling(Consumer<ClusterAutoScalingConfig.Builder> autoScaling)

      The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.

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

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

      Parameters:
      autoScaling - a consumer that will call methods on ClusterAutoScalingConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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