The AWS::PCS::Queue resource creates an AWS PCS queue.
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
-
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
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_hta14wrehh/queue/pcs_nhrw94erov.
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 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. The provisioning status doesn't indicate the overall health of the queue.
