Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more AWS PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. AWS 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 AWS 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.
Request Syntax
{
"amiId": "string",
"clientToken": "string",
"clusterIdentifier": "string",
"computeNodeGroupName": "string",
"customLaunchTemplate": {
"id": "string",
"version": "string"
},
"iamInstanceProfileArn": "string",
"instanceConfigs": [
{
"instanceType": "string"
}
],
"purchaseOption": "string",
"scalingConfiguration": {
"maxInstanceCount": number,
"minInstanceCount": number
},
"slurmConfiguration": {
"slurmCustomSettings": [
{
"parameterName": "string",
"parameterValue": "string"
}
]
},
"spotOptions": {
"allocationStrategy": "string"
},
"subnetIds": [ "string" ],
"tags": {
"string" : "string"
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- amiId
-
The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, AWS PCS uses the AMI ID specified in the custom launch template.
Type: String
Pattern:
ami-[a-z0-9]+Required: No
- clientToken
-
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 AWS CLI and SDK automatically generate 1 for you.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 100.
Required: No
- clusterIdentifier
-
The name or ID of the cluster to create a compute node group in.
Type: String
Pattern:
(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{2,40})Required: Yes
- computeNodeGroupName
-
A name to identify the cluster. Example:
MyClusterType: String
Length Constraints: Minimum length of 3. Maximum length of 25.
Pattern:
(?!pcs_)^[A-Za-z][A-Za-z0-9-]+Required: Yes
- customLaunchTemplate
-
An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
Type: CustomLaunchTemplate object
Required: Yes
- 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:RegisterComputeNodeGroupInstancepermission. The resource identifier of the ARN must start withAWSPCSor 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
Type: String
Pattern:
arn:aws([a-zA-Z-]{0,10})?:iam::[0-9]{12}:instance-profile/.{1,128}Required: Yes
-
- instanceConfigs
-
A list of EC2 instance configurations that AWS PCS can provision in the compute node group.
Type: Array of InstanceConfig objects
Required: Yes
- purchaseOption
-
Specifies how EC2 instances are purchased on your behalf. AWS 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.
Type: String
Valid Values:
ONDEMAND | SPOTRequired: No
- scalingConfiguration
-
Specifies the boundaries of the compute node group auto scaling.
Type: ScalingConfigurationRequest object
Required: Yes
- slurmConfiguration
-
Additional options related to the Slurm scheduler.
Type: ComputeNodeGroupSlurmConfigurationRequest object
Required: No
- spotOptions
-
Additional configuration when you specify
SPOTas thepurchaseOptionfor theCreateComputeNodeGroupAPI action.Type: SpotOptions object
Required: No
- subnetIds
-
The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.
Type: Array of strings
Required: Yes
-
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.
Type: String to string map
Map Entries: Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
{
"computeNodeGroup": {
"amiId": "string",
"arn": "string",
"clusterId": "string",
"createdAt": "string",
"customLaunchTemplate": {
"id": "string",
"version": "string"
},
"errorInfo": [
{
"code": "string",
"message": "string"
}
],
"iamInstanceProfileArn": "string",
"id": "string",
"instanceConfigs": [
{
"instanceType": "string"
}
],
"modifiedAt": "string",
"name": "string",
"purchaseOption": "string",
"scalingConfiguration": {
"maxInstanceCount": number,
"minInstanceCount": number
},
"slurmConfiguration": {
"slurmCustomSettings": [
{
"parameterName": "string",
"parameterValue": "string"
}
]
},
"spotOptions": {
"allocationStrategy": "string"
},
"status": "string",
"subnetIds": [ "string" ]
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- computeNodeGroup
-
A compute node group associated with a cluster.
Type: ComputeNodeGroup object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
HTTP Status Code: 400
-
- ConflictException
-
Your request has conflicting operations. This can occur if you're trying to perform more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
HTTP Status Code: 400
-
- InternalServerException
-
AWS PCS can't process your request right now. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource can't be found. The cluster, node group, or queue you're attempting to get, update, list, or delete doesn't exist.
Examples
HTTP Status Code: 400
- ServiceQuotaExceededException
-
You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account. To learn how to increase your service quota, see Requesting a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
HTTP Status Code: 400
-
- ThrottlingException
-
Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
HTTP Status Code: 400
- ValidationException
-
The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
HTTP Status Code: 400
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
