/AWS1/CL_SGMCLSTRESTRICTEDIN01¶
The instance group details of the restricted instance group (RIG).
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_currentcount TYPE /AWS1/SGMCLUSTNONNEGINSTCOUNT /AWS1/SGMCLUSTNONNEGINSTCOUNT¶
The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster.
iv_targetcount TYPE /AWS1/SGMCLUSTERINSTANCECOUNT /AWS1/SGMCLUSTERINSTANCECOUNT¶
The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.
iv_instancegroupname TYPE /AWS1/SGMCLUSTERINSTGROUPNAME /AWS1/SGMCLUSTERINSTGROUPNAME¶
The name of the restricted instance group of a SageMaker HyperPod cluster.
iv_instancetype TYPE /AWS1/SGMCLUSTERINSTANCETYPE /AWS1/SGMCLUSTERINSTANCETYPE¶
The instance type of the restricted instance group of a SageMaker HyperPod cluster.
iv_executionrole TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN¶
The execution role for the restricted instance group to assume.
iv_threadspercore TYPE /AWS1/SGMCLUSTERTHREADSPERCORE /AWS1/SGMCLUSTERTHREADSPERCORE¶
The number you specified to
TreadsPerCoreinCreateClusterfor 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.
it_instancestorageconfigs TYPE /AWS1/CL_SGMCLUSTINSTSTRGCFG=>TT_CLUSTERINSTSTORAGECONFIGS TT_CLUSTERINSTSTORAGECONFIGS¶
The additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
it_onstartdeephealthchecks TYPE /AWS1/CL_SGMONSTRTDEEPHEALTH00=>TT_ONSTARTDEEPHEALTHCHECKS TT_ONSTARTDEEPHEALTHCHECKS¶
A flag indicating whether deep health checks should be performed when the cluster's restricted instance group is created or updated.
iv_status TYPE /AWS1/SGMINSTANCEGROUPSTATUS /AWS1/SGMINSTANCEGROUPSTATUS¶
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.
iv_trainingplanarn TYPE /AWS1/SGMTRAININGPLANARN /AWS1/SGMTRAININGPLANARN¶
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.
iv_trainingplanstatus TYPE /AWS1/SGMINSTGROUPTRNPLANSTAT /AWS1/SGMINSTGROUPTRNPLANSTAT¶
The current status of the training plan associated with this cluster restricted instance group.
io_overridevpcconfig TYPE REF TO /AWS1/CL_SGMVPCCONFIG /AWS1/CL_SGMVPCCONFIG¶
OverrideVpcConfig
io_scheduledupdateconfig TYPE REF TO /AWS1/CL_SGMSCHDDUPDATECONFIG /AWS1/CL_SGMSCHDDUPDATECONFIG¶
ScheduledUpdateConfig
io_environmentconfig TYPE REF TO /AWS1/CL_SGMENVCONFIGDETAILS /AWS1/CL_SGMENVCONFIGDETAILS¶
The configuration for the restricted instance groups (RIG) environment.
Queryable Attributes¶
CurrentCount¶
The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CURRENTCOUNT() |
Getter for CURRENTCOUNT, with configurable default |
ASK_CURRENTCOUNT() |
Getter for CURRENTCOUNT w/ exceptions if field has no value |
HAS_CURRENTCOUNT() |
Determine if CURRENTCOUNT has a value |
TargetCount¶
The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETCOUNT() |
Getter for TARGETCOUNT, with configurable default |
ASK_TARGETCOUNT() |
Getter for TARGETCOUNT w/ exceptions if field has no value |
HAS_TARGETCOUNT() |
Determine if TARGETCOUNT has a value |
InstanceGroupName¶
The name of the restricted instance group of a SageMaker HyperPod cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCEGROUPNAME() |
Getter for INSTANCEGROUPNAME, with configurable default |
ASK_INSTANCEGROUPNAME() |
Getter for INSTANCEGROUPNAME w/ exceptions if field has no v |
HAS_INSTANCEGROUPNAME() |
Determine if INSTANCEGROUPNAME has a value |
InstanceType¶
The instance type of the restricted instance group of a SageMaker HyperPod cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCETYPE() |
Getter for INSTANCETYPE, with configurable default |
ASK_INSTANCETYPE() |
Getter for INSTANCETYPE w/ exceptions if field has no value |
HAS_INSTANCETYPE() |
Determine if INSTANCETYPE has a value |
ExecutionRole¶
The execution role for the restricted instance group to assume.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTIONROLE() |
Getter for EXECUTIONROLE, with configurable default |
ASK_EXECUTIONROLE() |
Getter for EXECUTIONROLE w/ exceptions if field has no value |
HAS_EXECUTIONROLE() |
Determine if EXECUTIONROLE has a value |
ThreadsPerCore¶
The number you specified to
TreadsPerCoreinCreateClusterfor 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_THREADSPERCORE() |
Getter for THREADSPERCORE, with configurable default |
ASK_THREADSPERCORE() |
Getter for THREADSPERCORE w/ exceptions if field has no valu |
HAS_THREADSPERCORE() |
Determine if THREADSPERCORE has a value |
InstanceStorageConfigs¶
The additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCESTORAGECONFIGS() |
Getter for INSTANCESTORAGECONFIGS, with configurable default |
ASK_INSTANCESTORAGECONFIGS() |
Getter for INSTANCESTORAGECONFIGS w/ exceptions if field has |
HAS_INSTANCESTORAGECONFIGS() |
Determine if INSTANCESTORAGECONFIGS has a value |
OnStartDeepHealthChecks¶
A flag indicating whether deep health checks should be performed when the cluster's restricted instance group is created or updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ONSTARTDEEPHEALTHCHECKS() |
Getter for ONSTARTDEEPHEALTHCHECKS, with configurable defaul |
ASK_ONSTARTDEEPHEALTHCHECKS() |
Getter for ONSTARTDEEPHEALTHCHECKS w/ exceptions if field ha |
HAS_ONSTARTDEEPHEALTHCHECKS() |
Determine if ONSTARTDEEPHEALTHCHECKS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRAININGPLANARN() |
Getter for TRAININGPLANARN, with configurable default |
ASK_TRAININGPLANARN() |
Getter for TRAININGPLANARN w/ exceptions if field has no val |
HAS_TRAININGPLANARN() |
Determine if TRAININGPLANARN has a value |
TrainingPlanStatus¶
The current status of the training plan associated with this cluster restricted instance group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRAININGPLANSTATUS() |
Getter for TRAININGPLANSTATUS, with configurable default |
ASK_TRAININGPLANSTATUS() |
Getter for TRAININGPLANSTATUS w/ exceptions if field has no |
HAS_TRAININGPLANSTATUS() |
Determine if TRAININGPLANSTATUS has a value |
OverrideVpcConfig¶
OverrideVpcConfig
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OVERRIDEVPCCONFIG() |
Getter for OVERRIDEVPCCONFIG |
ScheduledUpdateConfig¶
ScheduledUpdateConfig
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULEDUPDATECONFIG() |
Getter for SCHEDULEDUPDATECONFIG |
EnvironmentConfig¶
The configuration for the restricted instance groups (RIG) environment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENTCONFIG() |
Getter for ENVIRONMENTCONFIG |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_CLSTRESTRICTEDINSTGRDETSLST¶
TYPES TT_CLSTRESTRICTEDINSTGRDETSLST TYPE STANDARD TABLE OF REF TO /AWS1/CL_SGMCLSTRESTRICTEDIN01 WITH DEFAULT KEY
.