AWS::PCS::Queue - 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::Queue

Creates an AWS PCS queue resource. For more information, see Creating a queue in AWS PCS in the AWS PCS User Guide.

Syntax

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

JSON

{
  "Type" : "AWS::PCS::Queue",
  "Properties" : {
      "ClusterId" : String,
      "ComputeNodeGroupConfigurations" : [ ComputeNodeGroupConfiguration, ... ],
      "Name" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::PCS::Queue
Properties:
  ClusterId: String
  ComputeNodeGroupConfigurations: 
    - ComputeNodeGroupConfiguration
  Name: String
  Tags: 
    Key: Value

Properties

ClusterId

The ID of the cluster of the queue.

Required: Yes

Type: String

Update requires: Replacement

ComputeNodeGroupConfigurations

The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.

Required: No

Type: Array of ComputeNodeGroupConfiguration

Update requires: No interruption

Name

The name that identifies the queue.

Required: No

Type: String

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: Object of String

Pattern: ^.+$

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

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

ErrorInfo

The list of errors that occurred during queue provisioning.

Id

The generated unique ID of the queue.

Status

The provisioning status of the queue.

Note

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

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.