Skip to content

Cluster

Source code in docs_src/capo_pcs/types/cluster.py
class Cluster(TypedDict, closed=True):
    name: "str"
    """<p>The name that identifies the cluster.</p>"""
    id: "str"
    """<p>The generated unique ID of the cluster.</p>"""
    arn: "str"
    """<p>The unique Amazon Resource Name (ARN) of the cluster.</p>"""
    status: "capo_pcs.types.cluster_status.ClusterStatus"
    """<p>The provisioning status of the cluster.</p> <note> <p>The provisioning status doesn't indicate the overall health of the cluster.</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>"""
    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>"""
    scheduler: "capo_pcs.types.scheduler.Scheduler"
    size: "capo_pcs.types.size.Size"
    """<p>The size of the cluster.</p> <ul> <li> <p> <code>SMALL</code>: 32 compute nodes and 256 jobs</p> </li> <li> <p> <code>MEDIUM</code>: 512 compute nodes and 8192 jobs</p> </li> <li> <p> <code>LARGE</code>: 2048 compute nodes and 16,384 jobs</p> </li> </ul>"""
    slurm_configuration: NotRequired[
        "capo_pcs.types.cluster_slurm_configuration.ClusterSlurmConfiguration"
    ]
    """<p>Additional options related to the Slurm scheduler.</p>"""
    networking: "capo_pcs.types.networking.Networking"
    endpoints: NotRequired["capo_pcs.types.endpoints.Endpoints"]
    """<p>The list of endpoints available for interaction with the scheduler.</p>"""
    error_info: NotRequired["capo_pcs.types.error_info_list.ErrorInfoList"]
    """<p>The list of errors that occurred during cluster provisioning.</p>"""

arn instance-attribute

arn: str

The unique Amazon Resource Name (ARN) of the cluster.

created_at instance-attribute

created_at: datetime

The date and time the resource was created.

endpoints instance-attribute

endpoints: NotRequired[Endpoints]

The list of endpoints available for interaction with the scheduler.

error_info instance-attribute

error_info: NotRequired[ErrorInfoList]

The list of errors that occurred during cluster provisioning.

id instance-attribute

id: str

The generated unique ID of the cluster.

modified_at instance-attribute

modified_at: datetime

The date and time the resource was modified.

name instance-attribute

name: str

The name that identifies the cluster.

networking instance-attribute

networking: Networking

scheduler instance-attribute

scheduler: Scheduler

size instance-attribute

size: Size

The size of the cluster.

  • SMALL: 32 compute nodes and 256 jobs

  • MEDIUM: 512 compute nodes and 8192 jobs

  • LARGE: 2048 compute nodes and 16,384 jobs

slurm_configuration instance-attribute

slurm_configuration: NotRequired[ClusterSlurmConfiguration]

Additional options related to the Slurm scheduler.

status instance-attribute

status: ClusterStatus

The provisioning status of the cluster.

The provisioning status doesn't indicate the overall health of the cluster.

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.