# Cluster


The cluster resource and configuration.

## Contents


 ** arn **   <a name="PCS-Type-Cluster-arn"></a>
The unique Amazon Resource Name (ARN) of the cluster.  
Type: String  
Required: Yes

 ** createdAt **   <a name="PCS-Type-Cluster-createdAt"></a>
The date and time the resource was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="PCS-Type-Cluster-id"></a>
The generated unique ID of the cluster.  
Type: String  
Required: Yes

 ** modifiedAt **   <a name="PCS-Type-Cluster-modifiedAt"></a>
The date and time the resource was modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="PCS-Type-Cluster-name"></a>
The name that identifies the cluster.  
Type: String  
Required: Yes

 ** networking **   <a name="PCS-Type-Cluster-networking"></a>
The networking configuration for the cluster's control plane.  
Type: [Networking](API_Networking.md) object  
Required: Yes

 ** scheduler **   <a name="PCS-Type-Cluster-scheduler"></a>
The cluster management and job scheduling software associated with the cluster.  
Type: [Scheduler](API_Scheduler.md) object  
Required: Yes

 ** size **   <a name="PCS-Type-Cluster-size"></a>
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
Type: String  
Valid Values: `SMALL | MEDIUM | LARGE`   
Required: Yes

 ** status **   <a name="PCS-Type-Cluster-status"></a>
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 AWS PCS](https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions_faq.html) in the * AWS PCS User Guide*.
Type: String  
Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | CREATE_FAILED | DELETE_FAILED | UPDATE_FAILED | SUSPENDING | SUSPENDED | RESUMING`   
Required: Yes

 ** endpoints **   <a name="PCS-Type-Cluster-endpoints"></a>
The list of endpoints available for interaction with the scheduler.  
Type: Array of [Endpoint](API_Endpoint.md) objects  
Required: No

 ** errorInfo **   <a name="PCS-Type-Cluster-errorInfo"></a>
The list of errors that occurred during cluster provisioning.  
Type: Array of [ErrorInfo](API_ErrorInfo.md) objects  
Required: No

 ** slurmConfiguration **   <a name="PCS-Type-Cluster-slurmConfiguration"></a>
Additional options related to the Slurm scheduler.  
Type: [ClusterSlurmConfiguration](API_ClusterSlurmConfiguration.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/pcs-2023-02-10/Cluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/pcs-2023-02-10/Cluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/pcs-2023-02-10/Cluster)