Skip to content

CreateClusterRequest

Source code in docs_src/capo_pcs/types/create_cluster_request.py
class CreateClusterRequest(TypedDict, closed=True):
    cluster_name: "capo_pcs.types.cluster_name.ClusterName"
    """<p>A name to identify the cluster. Example: <code>MyCluster</code> </p>"""
    scheduler: "capo_pcs.types.scheduler_request.SchedulerRequest"
    """<p>The cluster management and job scheduling software associated with the cluster.</p>"""
    size: "capo_pcs.types.size.Size"
    """<p>A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).</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>"""
    networking: "capo_pcs.types.networking_request.NetworkingRequest"
    """<p>The networking configuration used to set up the cluster's control plane.</p>"""
    slurm_configuration: NotRequired[
        "capo_pcs.types.cluster_slurm_configuration_request.ClusterSlurmConfigurationRequest"
    ]
    """<p>Additional options related to the Slurm scheduler.</p>"""
    client_token: NotRequired["capo_pcs.types.sb_client_token.SBClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.</p>"""
    tags: NotRequired["capo_pcs.types.request_tag_map.RequestTagMap"]
    """<p>1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.</p>"""

client_token instance-attribute

client_token: NotRequired[SBClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

cluster_name instance-attribute

cluster_name: ClusterName

A name to identify the cluster. Example: MyCluster

networking instance-attribute

networking: NetworkingRequest

The networking configuration used to set up the cluster's control plane.

scheduler instance-attribute

scheduler: SchedulerRequest

The cluster management and job scheduling software associated with the cluster.

size instance-attribute

size: Size

A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).

  • 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[ClusterSlurmConfigurationRequest]

Additional options related to the Slurm scheduler.

tags instance-attribute

tags: NotRequired[RequestTagMap]

1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.