AWS::Deadline::Queue - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Deadline::Queue

Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.

Syntax

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

JSON

{
  "Type" : "AWS::Deadline::Queue",
  "Properties" : {
      "AllowedStorageProfileIds" : [ String, ... ],
      "DefaultBudgetAction" : String,
      "Description" : String,
      "DisplayName" : String,
      "FarmId" : String,
      "JobAttachmentSettings" : JobAttachmentSettings,
      "JobRunAsUser" : JobRunAsUser,
      "RequiredFileSystemLocationNames" : [ String, ... ],
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

Properties

AllowedStorageProfileIds

The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.

Required: No

Type: Array of String

Minimum: 0

Maximum: 20

Update requires: No interruption

DefaultBudgetAction

The default action taken on a queue summary if a budget wasn't configured.

Required: No

Type: String

Allowed values: NONE | STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKS

Update requires: No interruption

Description

A description of the queue that helps identify what the queue is used for.

Required: No

Type: String

Minimum: 0

Maximum: 100

Update requires: No interruption

DisplayName

The display name of the queue summary to update.

Important

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

FarmId

The farm ID.

Required: Yes

Type: String

Pattern: ^farm-[0-9a-f]{32}$

Update requires: Replacement

JobAttachmentSettings

The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.

Required: No

Type: JobAttachmentSettings

Update requires: No interruption

JobRunAsUser

Identifies the user for a job.

Required: No

Type: JobRunAsUser

Update requires: No interruption

RequiredFileSystemLocationNames

The file system location that the queue uses.

Required: No

Type: Array of String

Minimum: 1 | 0

Maximum: 64 | 20

Update requires: No interruption

RoleArn

The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.

Required: No

Type: String

Pattern: ^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$

Update requires: No interruption

Tags

The tags to add to your queue. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the specified queue.

For more information about using the Ref function, see Ref.

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 Amazon Resource Name (ARN) of the queue.

QueueId

The queue ID.