ClusterInstanceGroupDetails
Details of an instance group in a SageMaker HyperPod cluster.
Contents
- CurrentCount
-
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- ExecutionRole
-
The execution role for the instance group to assume.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
Required: No
- InstanceGroupName
-
The name of the instance group of a SageMaker HyperPod cluster.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
Required: No
- InstanceStorageConfigs
-
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
Type: Array of ClusterInstanceStorageConfig objects
Array Members: Maximum number of 1 item.
Required: No
- InstanceType
-
The instance type of the instance group of a SageMaker HyperPod cluster.
Type: String
Valid 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
Required: No
- LifeCycleConfig
-
Details of LifeCycle configuration for the instance group.
Type: ClusterLifeCycleConfig object
Required: No
- OnStartDeepHealthChecks
-
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Valid Values:
InstanceStress | InstanceConnectivity
Required: No
- TargetCount
-
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- ThreadsPerCore
-
The number you specified to
TreadsPerCore
inCreateCluster
for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 2.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: