/AWS1/CL_HPPCOMPUTENODEGROUP

A compute node group associated with a cluster.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/HPPCOMPUTENODEGROUPNAME /AWS1/HPPCOMPUTENODEGROUPNAME

The name that identifies the compute node group.

iv_id TYPE /AWS1/HPPSTRING /AWS1/HPPSTRING

The generated unique ID of the compute node group.

iv_arn TYPE /AWS1/HPPSTRING /AWS1/HPPSTRING

The unique Amazon Resource Name (ARN) of the compute node group.

iv_clusterid TYPE /AWS1/HPPSTRING /AWS1/HPPSTRING

The ID of the cluster of the compute node group.

iv_createdat TYPE /AWS1/HPPTIMESTAMP /AWS1/HPPTIMESTAMP

The date and time the resource was created.

iv_modifiedat TYPE /AWS1/HPPTIMESTAMP /AWS1/HPPTIMESTAMP

The date and time the resource was modified.

iv_status TYPE /AWS1/HPPCOMPUTENODEGROUPSTAT /AWS1/HPPCOMPUTENODEGROUPSTAT

The provisioning status of the compute node group.

The provisioning status doesn't indicate the overall health of the compute node group.

The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

it_subnetids TYPE /AWS1/CL_HPPSUBNETIDLIST_W=>TT_SUBNETIDLIST TT_SUBNETIDLIST

The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.

io_customlaunchtemplate TYPE REF TO /AWS1/CL_HPPCUSTOMLAUNCHTMPL /AWS1/CL_HPPCUSTOMLAUNCHTMPL

customLaunchTemplate

iv_iaminstanceprofilearn TYPE /AWS1/HPPINSTANCEPROFILEARN /AWS1/HPPINSTANCEPROFILEARN

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission and the role name must start with AWSPCS or must have the path /aws-pcs/. For more information, see IAM instance profiles for PCS in the PCS User Guide.

io_scalingconfiguration TYPE REF TO /AWS1/CL_HPPSCALINGCONF /AWS1/CL_HPPSCALINGCONF

scalingConfiguration

it_instanceconfigs TYPE /AWS1/CL_HPPINSTANCECONFIG=>TT_INSTANCELIST TT_INSTANCELIST

A list of EC2 instance configurations that PCS can provision in the compute node group.

Optional arguments:

iv_amiid TYPE /AWS1/HPPAMIID /AWS1/HPPAMIID

The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not provided, PCS uses the AMI ID specified in the custom launch template.

iv_purchaseoption TYPE /AWS1/HPPPURCHASEOPTION /AWS1/HPPPURCHASEOPTION

Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.

io_spotoptions TYPE REF TO /AWS1/CL_HPPSPOTOPTIONS /AWS1/CL_HPPSPOTOPTIONS

spotOptions

io_slurmconfiguration TYPE REF TO /AWS1/CL_HPPCOMPUTENODEGRSLU00 /AWS1/CL_HPPCOMPUTENODEGRSLU00

slurmConfiguration

it_errorinfo TYPE /AWS1/CL_HPPERRORINFO=>TT_ERRORINFOLIST TT_ERRORINFOLIST

The list of errors that occurred during compute node group provisioning.

---

Queryable Attributes

name

The name that identifies the compute node group.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

id

The generated unique ID of the compute node group.

Accessible with the following methods

Method	Description
GET_ID()	Getter for ID, with configurable default
ASK_ID()	Getter for ID w/ exceptions if field has no value
HAS_ID()	Determine if ID has a value

arn

The unique Amazon Resource Name (ARN) of the compute node group.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

clusterId

The ID of the cluster of the compute node group.

Accessible with the following methods

Method	Description
GET_CLUSTERID()	Getter for CLUSTERID, with configurable default
ASK_CLUSTERID()	Getter for CLUSTERID w/ exceptions if field has no value
HAS_CLUSTERID()	Determine if CLUSTERID has a value

createdAt

The date and time the resource was created.

Accessible with the following methods

Method	Description
GET_CREATEDAT()	Getter for CREATEDAT, with configurable default
ASK_CREATEDAT()	Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT()	Determine if CREATEDAT has a value

modifiedAt

The date and time the resource was modified.

Accessible with the following methods

Method	Description
GET_MODIFIEDAT()	Getter for MODIFIEDAT, with configurable default
ASK_MODIFIEDAT()	Getter for MODIFIEDAT w/ exceptions if field has no value
HAS_MODIFIEDAT()	Determine if MODIFIEDAT has a value

status

The provisioning status of the compute node group.

The provisioning status doesn't indicate the overall health of the compute node group.

The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

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

amiId

The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not provided, PCS uses the AMI ID specified in the custom launch template.

Accessible with the following methods

Method	Description
GET_AMIID()	Getter for AMIID, with configurable default
ASK_AMIID()	Getter for AMIID w/ exceptions if field has no value
HAS_AMIID()	Determine if AMIID has a value

subnetIds

The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.

Accessible with the following methods

Method	Description
GET_SUBNETIDS()	Getter for SUBNETIDS, with configurable default
ASK_SUBNETIDS()	Getter for SUBNETIDS w/ exceptions if field has no value
HAS_SUBNETIDS()	Determine if SUBNETIDS has a value

purchaseOption

Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.

Accessible with the following methods

Method	Description
GET_PURCHASEOPTION()	Getter for PURCHASEOPTION, with configurable default
ASK_PURCHASEOPTION()	Getter for PURCHASEOPTION w/ exceptions if field has no valu
HAS_PURCHASEOPTION()	Determine if PURCHASEOPTION has a value

customLaunchTemplate

customLaunchTemplate

Accessible with the following methods

Method	Description
GET_CUSTOMLAUNCHTEMPLATE()	Getter for CUSTOMLAUNCHTEMPLATE

iamInstanceProfileArn

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission and the role name must start with AWSPCS or must have the path /aws-pcs/. For more information, see IAM instance profiles for PCS in the PCS User Guide.

Accessible with the following methods

Method	Description
GET_IAMINSTANCEPROFILEARN()	Getter for IAMINSTANCEPROFILEARN, with configurable default
ASK_IAMINSTANCEPROFILEARN()	Getter for IAMINSTANCEPROFILEARN w/ exceptions if field has
HAS_IAMINSTANCEPROFILEARN()	Determine if IAMINSTANCEPROFILEARN has a value

scalingConfiguration

scalingConfiguration

Accessible with the following methods

Method	Description
GET_SCALINGCONFIGURATION()	Getter for SCALINGCONFIGURATION

instanceConfigs

A list of EC2 instance configurations that PCS can provision in the compute node group.

Accessible with the following methods

Method	Description
GET_INSTANCECONFIGS()	Getter for INSTANCECONFIGS, with configurable default
ASK_INSTANCECONFIGS()	Getter for INSTANCECONFIGS w/ exceptions if field has no val
HAS_INSTANCECONFIGS()	Determine if INSTANCECONFIGS has a value

spotOptions

spotOptions

Accessible with the following methods

Method	Description
GET_SPOTOPTIONS()	Getter for SPOTOPTIONS

slurmConfiguration

slurmConfiguration

Accessible with the following methods

Method	Description
GET_SLURMCONFIGURATION()	Getter for SLURMCONFIGURATION

errorInfo

The list of errors that occurred during compute node group provisioning.

Accessible with the following methods

Method	Description
GET_ERRORINFO()	Getter for ERRORINFO, with configurable default
ASK_ERRORINFO()	Getter for ERRORINFO w/ exceptions if field has no value
HAS_ERRORINFO()	Determine if ERRORINFO has a value