Interface CfnCluster.IClusterRestrictedInstanceGroupProperty

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

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnCluster.IClusterRestrictedInstanceGroupProperty

Syntax (vb)

Public Interface CfnCluster.IClusterRestrictedInstanceGroupProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var clusterRestrictedInstanceGroupProperty = new ClusterRestrictedInstanceGroupProperty {
                 EnvironmentConfig = new EnvironmentConfigProperty {
                     FSxLustreConfig = new FSxLustreConfigProperty {
                         PerUnitStorageThroughput = 123,
                         SizeInGiB = 123
                     }
                 },
                 ExecutionRole = "executionRole",
                 InstanceCount = 123,
                 InstanceGroupName = "instanceGroupName",
                 InstanceType = "instanceType",

                 // the properties below are optional
                 CurrentCount = 123,
                 InstanceStorageConfigs = new [] { new ClusterInstanceStorageConfigProperty {
                     EbsVolumeConfig = new ClusterEbsVolumeConfigProperty {
                         RootVolume = false,
                         VolumeKmsKeyId = "volumeKmsKeyId",
                         VolumeSizeInGb = 123
                     }
                 } },
                 OnStartDeepHealthChecks = new [] { "onStartDeepHealthChecks" },
                 OverrideVpcConfig = new VpcConfigProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     Subnets = new [] { "subnets" }
                 },
                 ThreadsPerCore = 123,
                 TrainingPlanArn = "trainingPlanArn"
             };

Synopsis

Properties

CurrentCount	The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster.
EnvironmentConfig	The configuration for the restricted instance groups (RIG) environment.
ExecutionRole	The execution role for the instance group to assume.
InstanceCount	The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.
InstanceGroupName	The name of the instance group of a SageMaker HyperPod cluster.
InstanceStorageConfigs	The instance storage configuration for the instance group.
InstanceType	The instance type of the instance group of a SageMaker HyperPod cluster.
OnStartDeepHealthChecks	Nodes will undergo advanced stress test to detect and replace faulty instances, based on the type of deep health check(s) passed in.
OverrideVpcConfig	Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
ThreadsPerCore	The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading.
TrainingPlanArn	The Amazon Resource Name (ARN) of the training plan to use for this cluster restricted instance group.

Properties

CurrentCount

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

double? CurrentCount { get; }

Property Value

double?

Remarks

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

EnvironmentConfig

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

object EnvironmentConfig { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnCluster.IEnvironmentConfigProperty

ExecutionRole

The execution role for the instance group to assume.

string ExecutionRole { get; }

Property Value

string

Remarks

InstanceCount

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

double InstanceCount { get; }

Property Value

double

Remarks

InstanceGroupName

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

string InstanceGroupName { get; }

Property Value

string

Remarks

InstanceStorageConfigs

The instance storage configuration for the instance group.

object? InstanceStorageConfigs { get; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnCluster.IClusterInstanceStorageConfigProperty)[]

InstanceType

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

string InstanceType { get; }

Property Value

string

Remarks

OnStartDeepHealthChecks

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

string[]? OnStartDeepHealthChecks { get; }

Property Value

string[]

Remarks

OverrideVpcConfig

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.

object? OverrideVpcConfig { get; }

Property Value

object

Remarks

You can control access to and from your resources by configuring a VPC.

Type union: either IResolvable or CfnCluster.IVpcConfigProperty

ThreadsPerCore

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

double? ThreadsPerCore { get; }

Property Value

double?

Remarks

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

TrainingPlanArn

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

string? TrainingPlanArn { get; }

Property Value

string

Remarks

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