ComputeNodeGroup
¶
Source code in docs_src/capo_pcs/types/compute_node_group.py
ami_id
instance-attribute
¶
ami_id: NotRequired[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.
error_info
instance-attribute
¶
error_info: NotRequired[ErrorInfoList]
The list of errors that occurred during compute node group provisioning.
iam_instance_profile_arn
instance-attribute
¶
iam_instance_profile_arn: InstanceProfileArn
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.
instance_configs
instance-attribute
¶
instance_configs: InstanceList
A list of EC2 instance configurations that PCS can provision in the compute node group.
name
instance-attribute
¶
name: ComputeNodeGroupName
The name that identifies the compute node group.
node_lifecycle_actions
instance-attribute
¶
node_lifecycle_actions: NotRequired[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.
purchase_option
instance-attribute
¶
purchase_option: NotRequired[PurchaseOption]
Specifies how EC2 instances are purchased on your behalf. 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 PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. For more information about PCS support for interruptible capacity reservations, see Using I-ODCRs with PCS in the PCS User Guide. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see Using ODCRs with PCS. If you don't provide this option, it defaults to On-Demand.
slurm_configuration
instance-attribute
¶
slurm_configuration: NotRequired[ComputeNodeGroupSlurmConfiguration]
status
instance-attribute
¶
status: ComputeNodeGroupStatus
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.
subnet_ids
instance-attribute
¶
subnet_ids: 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.