AWS::PCS::Cluster - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::PCS::Cluster

Creates an AWS PCS cluster resource. For more information, see Creating a cluster in AWS Parallel Computing Service in the AWS PCS User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::PCS::Cluster",
  "Properties" : {
      "Name" : String,
      "Networking" : Networking,
      "Scheduler" : Scheduler,
      "Size" : String,
      "SlurmConfiguration" : SlurmConfiguration,
      "Tags" : String
    }
}

YAML

Type: AWS::PCS::Cluster
Properties:
  Name: String
  Networking: 
    Networking
  Scheduler: 
    Scheduler
  Size: String
  SlurmConfiguration: 
    SlurmConfiguration
  Tags: String

Properties

Name

The name that identifies the cluster.

Required: No

Type: String

Update requires: Replacement

Networking

The networking configuration for the cluster's control plane.

Required: Yes

Type: Networking

Update requires: Replacement

Scheduler

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

Required: Yes

Type: Scheduler

Update requires: Replacement

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

Required: Yes

Type: String

Allowed values: SMALL | MEDIUM | LARGE

Update requires: Replacement

SlurmConfiguration

Additional options related to the Slurm scheduler.

Required: No

Type: SlurmConfiguration

Update requires: Replacement

Tags

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.

Required: No

Type: String

Pattern: ^.+$

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

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

Endpoints

The list of endpoints available for interaction with the scheduler.

ErrorInfo

The list of errors that occurred during cluster provisioning.

Id

The generated unique ID of the cluster.

Status

The provisioning status of the cluster.

Note

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

Important

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 in the AWS PCS User Guide.