AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Deadline::Queue

CfnQueue

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.

Import

import { CfnQueue } from 'aws-cdk-lib/aws-deadline';

Or use the module namespace:

import * as deadline from 'aws-cdk-lib/aws-deadline';
// deadline.CfnQueue

Properties

Configuration passed to the constructor as CfnQueueProps.

displayNameRequired
string

The display name of the queue summary to update. > 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.

farmIdRequired
string

The farm ID.

allowedStorageProfileIdsOptional
string[]

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

defaultBudgetActionOptional
string

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

Default: - "NONE"

descriptionOptional
string

A description of the queue that helps identify what the queue is used for. > 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.

Default: - ""

jobAttachmentSettingsOptional
IResolvable | JobAttachmentSettingsProperty

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

jobRunAsUserOptional
IResolvable | JobRunAsUserProperty

Identifies the user for a job.

requiredFileSystemLocationNamesOptional
string[]

The file system location that the queue uses.

roleArnOptional
string

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

tagsOptional
CfnTag[]

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter