interface ClusterRestrictedInstanceGroupProperty

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

Details of a restricted instance group in a SageMaker HyperPod cluster.

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 clusterRestrictedInstanceGroupProperty: sagemaker.CfnCluster.ClusterRestrictedInstanceGroupProperty = {
  environmentConfig: {
    fSxLustreConfig: {
      perUnitStorageThroughput: 123,
      sizeInGiB: 123,
    },
  },
  executionRole: 'executionRole',
  instanceCount: 123,
  instanceGroupName: 'instanceGroupName',
  instanceType: 'instanceType',

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

Properties

Name	Type	Description
environmentConfig	`IResolvable` `\|` `EnvironmentConfigProperty`	The configuration for the restricted instance groups (RIG) environment.
executionRole	`string`	The execution role for the instance group to assume.
instanceCount	`number`	The number of instances you specified to add to the restricted instance group of a 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.
currentCount?	`number`	The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster.
instanceStorageConfigs?	`IResolvable` `\|` `IResolvable` `\|` `ClusterInstanceStorageConfigProperty[]`	The instance storage configuration for the instance group.
onStartDeepHealthChecks?	`string[]`	Nodes will undergo advanced stress test to detect and replace faulty instances, based on the type of deep health check(s) passed in.
overrideVpcConfig?	`IResolvable` `\|` `VpcConfigProperty`	Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
threadsPerCore?	`number`	The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading.
trainingPlanArn?	`string`	The Amazon Resource Name (ARN) of the training plan to use for this cluster restricted instance group.

environmentConfig

Type: IResolvable | EnvironmentConfigProperty

The configuration for the restricted instance groups (RIG) environment.

executionRole

Type: string

The execution role for the instance group to assume.

instanceCount

Type: number

The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.

instanceGroupName

Type: string

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

instanceType

Type: string

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

currentCount?

Type: number (optional)

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

instanceStorageConfigs?

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

The instance storage configuration for the instance group.

onStartDeepHealthChecks?

Type: string[] (optional)

Nodes will undergo advanced stress test to detect and replace faulty instances, based on the type of deep health check(s) passed in.

overrideVpcConfig?

Type: IResolvable | VpcConfigProperty (optional)

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.

threadsPerCore?

Type: number (optional)

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading.

For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading.

trainingPlanArn?

Type: string (optional)

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

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan.