ComputeNodeGroup

A compute node group associated with a cluster.

arn

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

Type: String

Required: Yes

clusterId

The ID of the cluster of the compute node group.

Type: String

Required: Yes

createdAt

The date and time the resource was created.

Type: Timestamp

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: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

Type: String

Pattern: arn:aws([a-zA-Z-]{0,10})?:iam::[0-9]{12}:instance-profile/.{1,128}

Required: Yes

id

The generated unique ID of the compute node group.

Type: String

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

modifiedAt

The date and time the resource was modified.

Type: Timestamp

Required: Yes

name

The name that identifies the compute node group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 25.

Pattern: (?!pcs_)^(?![A-Za-z0-9]{10}$)[A-Za-z][A-Za-z0-9-]+

Required: Yes

scalingConfiguration

Specifies the boundaries of the compute node group auto scaling.

Type: ScalingConfiguration object

Required: Yes

status

The provisioning status of the compute node group.

Note

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

Type: String

Required: Yes

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.

Type: Array of strings

Array Members: Minimum number of 1 item.

Pattern: subnet-\w{8,17}

Required: Yes

amiId

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

Type: String

Pattern: ami-[a-z0-9]+

Required: No

errorInfo

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

Type: Array of ErrorInfo objects

Required: No

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 | SPOT

Required: No

slurmConfiguration

Additional options related to the Slurm scheduler.

Type: ComputeNodeGroupSlurmConfiguration object

Required: No

spotOptions

Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

Type: SpotOptions object

Required: No

ComputeNodeGroup

Contents

Examples

Note

See Also