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

AWS::PCS::Cluster

The AWS::PCS::Cluster resource creates an AWS PCS cluster.

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

Pattern: ^(?!pcs_)^(?![A-Za-z0-9]{10}$)[A-Za-z][A-Za-z0-9-]+$

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.

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

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN, such as arn:aws:pcs:us-east-1:111122223333:cluster/pcs_i7x3yr1hgm.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see 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. The provisioning status doesn't indicate the overall health of the cluster.