interface ClusterInstanceGroupProperty

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnCluster.ClusterInstanceGroupProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnCluster_ClusterInstanceGroupProperty
Java	software.amazon.awscdk.services.sagemaker.CfnCluster.ClusterInstanceGroupProperty
Python	aws_cdk.aws_sagemaker.CfnCluster.ClusterInstanceGroupProperty
TypeScript	aws-cdk-lib » aws_sagemaker » CfnCluster » ClusterInstanceGroupProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const clusterInstanceGroupProperty: sagemaker.CfnCluster.ClusterInstanceGroupProperty = {
  executionRole: 'executionRole',
  instanceCount: 123,
  instanceGroupName: 'instanceGroupName',
  instanceType: 'instanceType',
  lifeCycleConfig: {
    onCreate: 'onCreate',
    sourceS3Uri: 'sourceS3Uri',
  },

  // the properties below are optional
  currentCount: 123,
  instanceStorageConfigs: [{
    ebsVolumeConfig: {
      volumeSizeInGb: 123,
    },
  }],
  onStartDeepHealthChecks: ['onStartDeepHealthChecks'],
  threadsPerCore: 123,
};

Properties

Name	Type	Description
executionRole	string	The execution role for the instance group to assume.
instanceCount	number	The number of instances in an instance group of the SageMaker HyperPod cluster.
instanceGroupName	string	The name of the instance group of a SageMaker HyperPod cluster.
instanceType	string	The instance type of the instance group of a SageMaker HyperPod cluster.
lifeCycleConfig	IResolvable | ClusterLifeCycleConfigProperty	The lifecycle configuration for a SageMaker HyperPod cluster.
currentCount?	number	The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
instanceStorageConfigs?	IResolvable | IResolvable | ClusterInstanceStorageConfigProperty[]	The configurations of additional storage specified to the instance group where the instance (node) is launched.
onStartDeepHealthChecks?	string[]	A flag indicating whether deep health checks should be performed when the HyperPod cluster instance group is created or updated.
threadsPerCore?	number	The number of threads per CPU core you specified under CreateCluster .

---

executionRole

Type: string

The execution role for the instance group to assume.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-executionrole

---

instanceCount

Type: number

The number of instances in an instance group of the SageMaker HyperPod cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancecount

---

instanceGroupName

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancegroupname

---

instanceType

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancetype

---

lifeCycleConfig

Type: IResolvable | ClusterLifeCycleConfigProperty

The lifecycle configuration for a SageMaker HyperPod cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-lifecycleconfig

---

currentCount?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-currentcount

---

instanceStorageConfigs?

Type: IResolvable | IResolvable | ClusterInstanceStorageConfigProperty[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancestorageconfigs

---

onStartDeepHealthChecks?

Type: string[] (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-onstartdeephealthchecks

---

threadsPerCore?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-threadspercore