AWS::SageMaker::Cluster

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SageMaker::Cluster",
  "Properties" : {
      "ClusterName" : String,
      "InstanceGroups" : [ ClusterInstanceGroup, ... ],
      "NodeRecovery" : String,
      "Orchestrator" : Orchestrator,
      "Tags" : [ Tag, ... ],
      "VpcConfig" : VpcConfig
    }
}

YAML

Type: AWS::SageMaker::Cluster
Properties:
  ClusterName: String
  InstanceGroups: 
    - ClusterInstanceGroup
  NodeRecovery: String
  Orchestrator: 
    Orchestrator
  Tags: 
    - Tag
  VpcConfig: 
    VpcConfig

Properties

ClusterName

The name of the SageMaker HyperPod cluster.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Minimum: 1

Maximum: 63

Update requires: Replacement

InstanceGroups

The instance groups of the SageMaker HyperPod cluster.

Required: Yes

Type: Array of ClusterInstanceGroup

Minimum: 1

Update requires: No interruption

NodeRecovery

Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod. Available values are Automatic for enabling and None for disabling.

Required: No

Type: String

Allowed values: Automatic | None

Update requires: No interruption

Orchestrator

The orchestrator type for the SageMaker HyperPod cluster. Currently, 'eks' is the only available option.

Required: No

Type: Orchestrator

Update requires: Replacement

Tags

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your AWS resources with tagging, see Tagging AWS resources. For advice on best practices for managing AWS resources with tagging, see Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

VpcConfig

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

Required: No

Type: VpcConfig

Update requires: Replacement

Return values

Ref

Fn::GetAtt

ClusterArn

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

ClusterStatus

The status of the SageMaker HyperPod cluster.

CreationTime

The time when the SageMaker HyperPod cluster is created.

FailureMessage

The failure message of the SageMaker HyperPod cluster.