Skip to content

UpdateClusterRequest

Source code in docs_src/capo_pcs/types/update_cluster_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class UpdateClusterRequest(TypedDict, closed=True):
    cluster_identifier: "capo_pcs.types.cluster_identifier.ClusterIdentifier"
    """<p>The name or ID of the cluster to update.</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>"""
    slurm_configuration: NotRequired[
        "capo_pcs.types.update_cluster_slurm_configuration_request.UpdateClusterSlurmConfigurationRequest"
    ]
    """<p>Additional options related to the Slurm scheduler.</p>"""
    scheduler: NotRequired[
        "capo_pcs.types.update_scheduler_request.UpdateSchedulerRequest"
    ]
    """<p>The scheduler configuration to update for the cluster. Use this to update the scheduler version. For more information, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/working-with_clusters_version_update.html">Updating the scheduler version on a cluster</a> in the <i>PCS User Guide</i>.</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_identifier instance-attribute 

cluster_identifier: ClusterIdentifier

The name or ID of the cluster to update.

scheduler instance-attribute 

scheduler: NotRequired[UpdateSchedulerRequest]

The scheduler configuration to update for the cluster. Use this to update the scheduler version. For more information, see Updating the scheduler version on a cluster in the PCS User Guide.

slurm_configuration instance-attribute 

slurm_configuration: NotRequired[UpdateClusterSlurmConfigurationRequest]

Additional options related to the Slurm scheduler.