AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateCluster operation. Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.CreateClusterRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public class CreateClusterRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The CreateClusterRequest type exposes the following members

Constructors

NameDescription
Public Method CreateClusterRequest()

Properties

NameTypeDescription
Public Property AutoScaling Amazon.SageMaker.Model.ClusterAutoScalingConfig

Gets and sets the property AutoScaling.

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

Public Property ClusterName System.String

Gets and sets the property ClusterName.

The name for the new SageMaker HyperPod cluster.

Public Property ClusterRole System.String

Gets and sets the property 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.

Public Property InstanceGroups System.Collections.Generic.List<Amazon.SageMaker.Model.ClusterInstanceGroupSpecification>

Gets and sets the property InstanceGroups.

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

Public Property NodeProvisioningMode Amazon.SageMaker.ClusterNodeProvisioningMode

Gets and sets the property 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.

Public Property NodeRecovery Amazon.SageMaker.ClusterNodeRecovery

Gets and sets the property 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.

Public Property Orchestrator Amazon.SageMaker.Model.ClusterOrchestrator

Gets and sets the property 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.

Public Property RestrictedInstanceGroups System.Collections.Generic.List<Amazon.SageMaker.Model.ClusterRestrictedInstanceGroupSpecification>

Gets and sets the property RestrictedInstanceGroups.

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

Public Property Tags System.Collections.Generic.List<Amazon.SageMaker.Model.Tag>

Gets and sets the property 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.

Public Property TieredStorageConfig Amazon.SageMaker.Model.ClusterTieredStorageConfig

Gets and sets the property 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.

Public Property VpcConfig Amazon.SageMaker.Model.VpcConfig

Gets and sets the property 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:

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5