AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The instance group details of the restricted instance group (RIG).

Inheritance Hierarchy

System.Object
  Amazon.SageMaker.Model.ClusterRestrictedInstanceGroupDetails

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C# 
public class ClusterRestrictedInstanceGroupDetails

The ClusterRestrictedInstanceGroupDetails type exposes the following members

Constructors

NameDescription
Public Method ClusterRestrictedInstanceGroupDetails()

Properties

NameTypeDescription
Public Property CurrentCount System.Int32

Gets and sets the property CurrentCount.

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

Public Property EnvironmentConfig Amazon.SageMaker.Model.EnvironmentConfigDetails

Gets and sets the property EnvironmentConfig.

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

Public Property ExecutionRole System.String

Gets and sets the property ExecutionRole.

The execution role for the restricted instance group to assume.

Public Property InstanceGroupName System.String

Gets and sets the property InstanceGroupName.

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

Public Property InstanceStorageConfigs System.Collections.Generic.List<Amazon.SageMaker.Model.ClusterInstanceStorageConfig>

Gets and sets the property InstanceStorageConfigs.

The additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.

Public Property InstanceType Amazon.SageMaker.ClusterInstanceType

Gets and sets the property InstanceType.

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

Public Property OnStartDeepHealthChecks System.Collections.Generic.List<System.String>

Gets and sets the property OnStartDeepHealthChecks.

A flag indicating whether deep health checks should be performed when the cluster's restricted instance group is created or updated.

Public Property OverrideVpcConfig Amazon.SageMaker.Model.VpcConfig

Gets and sets the property OverrideVpcConfig.

Public Property ScheduledUpdateConfig Amazon.SageMaker.Model.ScheduledUpdateConfig

Gets and sets the property ScheduledUpdateConfig.

Public Property Status Amazon.SageMaker.InstanceGroupStatus

Gets and sets the property Status.

The current status of the cluster's restricted instance group.

  • InService: The restricted instance group is active and healthy.

  • Creating: The restricted instance group is being provisioned.

  • Updating: The restricted instance group is being updated.

  • Failed: The restricted instance group has failed to provision or is no longer healthy.

  • Degraded: The restricted instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

  • Deleting: The restricted instance group is being deleted.

Public Property TargetCount System.Int32

Gets and sets the property TargetCount.

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

Public Property ThreadsPerCore System.Int32

Gets and sets the property ThreadsPerCore.

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. 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.

Public Property TrainingPlanArn System.String

Gets and sets the property TrainingPlanArn.

The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

Public Property TrainingPlanStatus System.String

Gets and sets the property TrainingPlanStatus.

The current status of the training plan associated with this cluster restricted instance group.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5