AWS::SageMaker::Cluster ClusterRestrictedInstanceGroup - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::Cluster ClusterRestrictedInstanceGroup

Specialized instance groups for training models like Amazon Nova in the SageMaker HyperPod cluster.

Syntax

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

JSON

{
  "CurrentCount" : Integer,
  "EnvironmentConfig" : EnvironmentConfig,
  "ExecutionRole" : String,
  "InstanceCount" : Integer,
  "InstanceGroupName" : String,
  "InstanceStorageConfigs" : [ ClusterInstanceStorageConfig, ... ],
  "InstanceType" : String,
  "OnStartDeepHealthChecks" : [ String, ... ],
  "OverrideVpcConfig" : VpcConfig,
  "ThreadsPerCore" : Integer,
  "TrainingPlanArn" : String
}

Properties

CurrentCount

The current number of instances in the restricted instance group.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

EnvironmentConfig

Environment configuration for the restricted instance group, including FSx Lustre settings.

Required: Yes

Type: EnvironmentConfig

Update requires: No interruption

ExecutionRole

The Amazon Resource Name (ARN) of the IAM execution role for the restricted instance group.

Required: Yes

Type: String

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

InstanceCount

The number of instances in the restricted instance group.

Required: Yes

Type: Integer

Minimum: 0

Update requires: No interruption

InstanceGroupName

The name of the restricted instance group.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Minimum: 1

Maximum: 63

Update requires: Replacement

InstanceStorageConfigs

Storage configurations for instances in the restricted instance group.

Required: No

Type: Array of ClusterInstanceStorageConfig

Maximum: 4

Update requires: No interruption

InstanceType

The EC2 instance type for the restricted instance group.

Required: Yes

Type: String

Update requires: Replacement

OnStartDeepHealthChecks

Deep health checks to run when instances start in the restricted instance group.

Required: No

Type: Array of String

Update requires: No interruption

OverrideVpcConfig

VPC configuration override for the restricted instance group.

Required: No

Type: VpcConfig

Update requires: Replacement

ThreadsPerCore

The number of threads per CPU core for instances in the restricted instance group.

Required: No

Type: Integer

Minimum: 1

Maximum: 2

Update requires: Replacement

TrainingPlanArn

The Amazon Resource Name (ARN) of the training plan for the restricted instance group.

Required: No

Type: String

Pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*$

Minimum: 50

Maximum: 2048

Update requires: No interruption