/AWS1/CL_SGMCLSTRESTRICTEDIN00¶
The specifications of a restricted instance group that you need to define.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_instancecount TYPE /AWS1/SGMCLUSTERINSTANCECOUNT /AWS1/SGMCLUSTERINSTANCECOUNT¶
Specifies the number of instances to add to the restricted instance group of a SageMaker HyperPod cluster.
iv_instancegroupname TYPE /AWS1/SGMCLUSTERINSTGROUPNAME /AWS1/SGMCLUSTERINSTGROUPNAME¶
Specifies the name of the restricted instance group.
iv_instancetype TYPE /AWS1/SGMCLUSTERINSTANCETYPE /AWS1/SGMCLUSTERINSTANCETYPE¶
Specifies the instance type of the restricted instance group.
iv_executionrole TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN¶
Specifies an IAM execution role to be assumed by the restricted instance group.
io_environmentconfig TYPE REF TO /AWS1/CL_SGMENVIRONMENTCONFIG /AWS1/CL_SGMENVIRONMENTCONFIG¶
The configuration for the restricted instance groups (RIG) environment.
Optional arguments:¶
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¶
Specifies 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 restricted instance group is created or updated.
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.
io_overridevpcconfig TYPE REF TO /AWS1/CL_SGMVPCCONFIG /AWS1/CL_SGMVPCCONFIG¶
OverrideVpcConfig
io_scheduledupdateconfig TYPE REF TO /AWS1/CL_SGMSCHDDUPDATECONFIG /AWS1/CL_SGMSCHDDUPDATECONFIG¶
ScheduledUpdateConfig
Queryable Attributes¶
InstanceCount¶
Specifies the number of instances to add to the restricted instance group of a SageMaker HyperPod cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCECOUNT() |
Getter for INSTANCECOUNT, with configurable default |
ASK_INSTANCECOUNT() |
Getter for INSTANCECOUNT w/ exceptions if field has no value |
HAS_INSTANCECOUNT() |
Determine if INSTANCECOUNT has a value |
InstanceGroupName¶
Specifies the name of the restricted instance group.
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¶
Specifies the instance type of the restricted instance group.
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¶
Specifies an IAM execution role to be assumed by the restricted instance group.
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¶
Specifies 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 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 |
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 |
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_CLUSTRESTRICTEDINSTGRPSPECS¶
TYPES TT_CLUSTRESTRICTEDINSTGRPSPECS TYPE STANDARD TABLE OF REF TO /AWS1/CL_SGMCLSTRESTRICTEDIN00 WITH DEFAULT KEY
.