Skip to content

/AWS1/CL_HPP=>CREATECOMPUTENODEGROUP()

About CreateComputeNodeGroup

Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must already have a launch template before you call this API. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

Method Signature

IMPORTING

Required arguments:

IV_CLUSTERIDENTIFIER TYPE /AWS1/HPPCLUSTERIDENTIFIER /AWS1/HPPCLUSTERIDENTIFIER

The name or ID of the cluster to create a compute node group in.

IV_COMPUTENODEGROUPNAME TYPE /AWS1/HPPCOMPUTENODEGROUPNAME /AWS1/HPPCOMPUTENODEGROUPNAME

A name to identify the cluster. Example: MyCluster

IT_SUBNETIDS TYPE /AWS1/CL_HPPSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

The list of subnet IDs where the compute node group launches instances. 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. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.

Examples

  • arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1

  • arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2

IO_SCALINGCONFIGURATION TYPE REF TO /AWS1/CL_HPPSCALINGCONFREQUEST /AWS1/CL_HPPSCALINGCONFREQUEST

Specifies the boundaries of the compute node group auto scaling.

IT_INSTANCECONFIGS TYPE /AWS1/CL_HPPINSTANCECONFIG=>TT_INSTANCELIST TT_INSTANCELIST

A list of EC2 instance configurations that Amazon Web Services 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 Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services 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. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud 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_HPPCOMPUTENODEGRSLU01 /AWS1/CL_HPPCOMPUTENODEGRSLU01

Additional options related to the Slurm scheduler.

IV_CLIENTTOKEN TYPE /AWS1/HPPSBCLIENTTOKEN /AWS1/HPPSBCLIENTTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

IT_TAGS TYPE /AWS1/CL_HPPREQUESTTAGMAP_W=>TT_REQUESTTAGMAP TT_REQUESTTAGMAP

1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_HPPCRECOMPUTENODEGR01 /AWS1/CL_HPPCRECOMPUTENODEGR01