AWS::SageMaker::Cluster ClusterInstanceGroup

The configuration information of the instance group within the HyperPod cluster.

Syntax

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

JSON

{
  "CurrentCount" : Integer,
  "ExecutionRole" : String,
  "InstanceCount" : Integer,
  "InstanceGroupName" : String,
  "InstanceStorageConfigs" : [ ClusterInstanceStorageConfig, ... ],
  "InstanceType" : String,
  "LifeCycleConfig" : ClusterLifeCycleConfig,
  "OnStartDeepHealthChecks" : [ String, ... ],
  "ThreadsPerCore" : Integer
}

YAML

  CurrentCount: Integer
  ExecutionRole: String
  InstanceCount: Integer
  InstanceGroupName: String
  InstanceStorageConfigs: 
    - ClusterInstanceStorageConfig
  InstanceType: String
  LifeCycleConfig: 
    ClusterLifeCycleConfig
  OnStartDeepHealthChecks: 
    - String
  ThreadsPerCore: Integer

Properties

CurrentCount

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

ExecutionRole

The execution role for the instance group to assume.

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 an instance group of the SageMaker HyperPod cluster.

Required: Yes

Type: Integer

Minimum: 0

Update requires: No interruption

InstanceGroupName

The name of the instance group of a SageMaker HyperPod cluster.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 63

Update requires: Replacement

InstanceStorageConfigs

The configurations of additional storage specified to the instance group where the instance (node) is launched.

Required: No

Type: Array of ClusterInstanceStorageConfig

Maximum: 1

Update requires: No interruption

InstanceType

The instance type of the instance group of a SageMaker HyperPod cluster.

Required: Yes

Type: String

Allowed values: ml.p4d.24xlarge | ml.p4de.24xlarge | ml.p5.48xlarge | ml.trn1.32xlarge | ml.trn1n.32xlarge | ml.g5.xlarge | ml.g5.2xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.48xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5n.large | ml.c5n.2xlarge | ml.c5n.4xlarge | ml.c5n.9xlarge | ml.c5n.18xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge

Update requires: Replacement

LifeCycleConfig

The lifecycle configuration for a SageMaker HyperPod cluster.

Required: Yes

Type: ClusterLifeCycleConfig

Update requires: No interruption

OnStartDeepHealthChecks

A flag indicating whether deep health checks should be performed when the HyperPod cluster instance group is created or updated. Deep health checks are comprehensive, invasive tests that validate the health of the underlying hardware and infrastructure components.

Required: No

Type: Array of String

Update requires: No interruption

ThreadsPerCore

The number of threads per CPU core you specified under CreateCluster.

Required: No

Type: Integer

Minimum: 1

Maximum: 2

Update requires: Replacement