Skip to content

ComputeNodeGroup

Source code in docs_src/capo_pcs/types/compute_node_group.py
class ComputeNodeGroup(TypedDict, closed=True):
    name: "capo_pcs.types.compute_node_group_name.ComputeNodeGroupName"
    """<p>The name that identifies the compute node group.</p>"""
    id: "str"
    """<p>The generated unique ID of the compute node group.</p>"""
    arn: "str"
    """<p>The unique Amazon Resource Name (ARN) of the compute node group.</p>"""
    cluster_id: "str"
    """<p>The ID of the cluster of the compute node group.</p>"""
    created_at: "datetime.datetime"
    """<p>The date and time the resource was created.</p>"""
    modified_at: "datetime.datetime"
    """<p>The date and time the resource was modified.</p>"""
    status: "capo_pcs.types.compute_node_group_status.ComputeNodeGroupStatus"
    """<p>The provisioning status of the compute node group.</p> <note> <p>The provisioning status doesn't indicate the overall health of the compute node group.</p> </note> <important> <p>The resource enters the <code>SUSPENDING</code> and <code>SUSPENDED</code> 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 <code>SUSPENDED</code>. For more information, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions_faq.html">Frequently asked questions about Slurm versions in PCS</a> in the <i>PCS User Guide</i>.</p> </important>"""
    ami_id: NotRequired["capo_pcs.types.ami_id.AmiId"]
    """<p>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.</p>"""
    subnet_ids: "capo_pcs.types.subnet_id_list.SubnetIdList"
    """<p>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.</p>"""
    purchase_option: NotRequired["capo_pcs.types.purchase_option.PurchaseOption"]
    """<p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html">Amazon EC2 billing and purchasing options</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about PCS support for Capacity Blocks, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/capacity-blocks.html">Using Amazon EC2 Capacity Blocks for ML with PCS</a> in the <i>PCS User Guide</i>. For more information about PCS support for interruptible capacity reservations, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/capacity-reservations-iodcr.html">Using I-ODCRs with PCS</a> in the <i>PCS User Guide</i>. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/capacity-reservations-odcr.html">Using ODCRs with PCS</a>. If you don't provide this option, it defaults to On-Demand.</p>"""
    custom_launch_template: "capo_pcs.types.custom_launch_template.CustomLaunchTemplate"
    iam_instance_profile_arn: "capo_pcs.types.instance_profile_arn.InstanceProfileArn"
    """<p>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 <code>pcs:RegisterComputeNodeGroupInstance</code> permission and the role name must start with <code>AWSPCS</code> or must have the path <code>/aws-pcs/</code>. For more information, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/security-instance-profiles.html">IAM instance profiles for PCS</a> in the <i>PCS User Guide</i>.</p>"""
    scaling_configuration: "capo_pcs.types.scaling_configuration.ScalingConfiguration"
    instance_configs: "capo_pcs.types.instance_list.InstanceList"
    """<p>A list of EC2 instance configurations that PCS can provision in the compute node group.</p>"""
    spot_options: NotRequired["capo_pcs.types.spot_options.SpotOptions"]
    slurm_configuration: NotRequired[
        "capo_pcs.types.compute_node_group_slurm_configuration.ComputeNodeGroupSlurmConfiguration"
    ]
    node_lifecycle_actions: NotRequired[
        "capo_pcs.types.node_lifecycle_actions.NodeLifecycleActions"
    ]
    """<p>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.</p>"""
    error_info: NotRequired["capo_pcs.types.error_info_list.ErrorInfoList"]
    """<p>The list of errors that occurred during compute node group provisioning.</p>"""

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.

arn instance-attribute

arn: str

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

cluster_id instance-attribute

cluster_id: str

The ID of the cluster of the compute node group.

created_at instance-attribute

created_at: datetime

The date and time the resource was created.

custom_launch_template instance-attribute

custom_launch_template: CustomLaunchTemplate

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.

id instance-attribute

id: str

The generated unique ID of the compute node group.

instance_configs instance-attribute

instance_configs: InstanceList

A list of EC2 instance configurations that PCS can provision in the compute node group.

modified_at instance-attribute

modified_at: datetime

The date and time the resource was modified.

name instance-attribute

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.

scaling_configuration instance-attribute

scaling_configuration: ScalingConfiguration

slurm_configuration instance-attribute

slurm_configuration: NotRequired[ComputeNodeGroupSlurmConfiguration]

spot_options instance-attribute

spot_options: NotRequired[SpotOptions]

status instance-attribute

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.