View a markdown version of this page

ComputeNodeGroup - AWS PCS

ComputeNodeGroup

A compute node group associated with a cluster.

Contents

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

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 AWS PCS in the AWS PCS User Guide.

Type: String

Pattern: arn:aws([a-zA-Z-]{0,10})?:iam::[0-9]{12}:instance-profile/([!-~]{1,510}/)?([\w+=,.@-]{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 3. Maximum length of 25.

Pattern: (?!pcs_)^[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.

Important

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 AWS PCS in the AWS PCS User Guide.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | DELETING | CREATE_FAILED | DELETE_FAILED | UPDATE_FAILED | DELETED | SUSPENDING | SUSPENDED | RESUMING

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 present, AWS PCS uses the AMI ID specified in the custom launch template.

Type: String

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

Required: No

customLaunchTemplate

The custom Amazon EC2 launch template associated with the compute node group. This value is present when launchTemplateMode is CUSTOM and isn't present when launchTemplateMode is MANAGED.

Type: CustomLaunchTemplate object

Required: No

errorInfo

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

Type: Array of ErrorInfo objects

Required: No

instanceHealthChecks

The instance health check settings of the compute node group. Instance health checks detect faults on instances in the compute node group and respond with the repair action that you choose.

Type: InstanceHealthChecks object

Required: No

launchTemplateMode

Indicates whether the compute node group uses a custom launch template or a launch template that AWS PCS manages. The default value is CUSTOM.

Valid values:

  • CUSTOM – The compute node group uses the launch template in customLaunchTemplate.

  • MANAGED – AWS PCS creates and manages the launch template.

Type: String

Valid Values: CUSTOM | MANAGED

Required: No

nodeLifecycleActions

The lifecycle actions to run on compute nodes in the compute node group. Use lifecycle actions to run custom scripts at defined stages of a compute node's lifecycle, such as when a compute node finishes bootstrapping or becomes ready to accept jobs.

Type: NodeLifecycleActions object

Required: No

purchaseOption

Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand Instances, Spot Instances, Interruptible Capacity Reservations, On-Demand Capacity Reservations, 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 AWS PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with AWS PCS in the AWS PCS User Guide. For more information about AWS PCS support for interruptible capacity reservations, see Using I-ODCRs with AWS PCS in the AWS PCS User Guide. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see Using ODCRs with AWS PCS. If you don't provide this option, it defaults to On-Demand.

Type: String

Valid Values: ONDEMAND | SPOT | CAPACITY_BLOCK | INTERRUPTIBLE_CAPACITY_RESERVATION

Required: No

securityGroupIds

The IDs of the EC2 security groups configured directly on the compute node group. AWS PCS uses these security groups instead of the security groups in the custom launch template. This value isn't present if security groups aren't configured directly on the compute node group. In that case, AWS PCS uses the security groups in the custom launch template.

Type: Array of strings

Pattern: sg-\w{8,17}

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

sshKeyName

The name of the EC2 key pair configured directly on the compute node group. AWS PCS uses this key pair instead of the key pair in the custom launch template. This value isn't present if a key pair isn't configured directly on the compute node group. In that case, AWS PCS uses the key pair in the custom launch template, if one is specified.

Type: String

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: