# CfnQueueProps

Properties for defining a `CfnQueue`.

Extends: CfnQueueProps
Used as props by: CfnQueue

- Source: Generated code
- Type last changed: v2.251.0 · 24 Apr 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_deadline as deadline } from 'aws-cdk-lib';

declare const alwaysScheduleFirst: any;
declare const alwaysScheduleLast: any;
declare const priorityFifo: any;
const cfnQueueProps: deadline.CfnQueueProps = {
  displayName: 'displayName',
  farmId: 'farmId',

  // the properties below are optional
  allowedStorageProfileIds: ['allowedStorageProfileIds'],
  defaultBudgetAction: 'defaultBudgetAction',
  description: 'description',
  jobAttachmentSettings: {
    rootPrefix: 'rootPrefix',
    s3BucketName: 's3BucketName',
  },
  jobRunAsUser: {
    runAs: 'runAs',

    // the properties below are optional
    posix: {
      group: 'group',
      user: 'user',
    },
    windows: {
      passwordArn: 'passwordArn',
      user: 'user',
    },
  },
  requiredFileSystemLocationNames: ['requiredFileSystemLocationNames'],
  roleArn: 'roleArn',
  schedulingConfiguration: {
    priorityBalanced: {
      renderingTaskBuffer: 123,
    },
    priorityFifo: priorityFifo,
    weightedBalanced: {
      errorWeight: 123,
      maxPriorityOverride: {
        alwaysScheduleFirst: alwaysScheduleFirst,
      },
      minPriorityOverride: {
        alwaysScheduleLast: alwaysScheduleLast,
      },
      priorityWeight: 123,
      renderingTaskBuffer: 123,
      renderingTaskWeight: 123,
      submissionTimeWeight: 123,
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
```

## Properties

- `allowedStorageProfileIds`: string[] — The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.

- `defaultBudgetAction`: string = "NONE" — The default action taken on a queue summary if a budget wasn't configured.

- `description`: 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.

- `displayName`: string (required) — 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.

- `farmId`: string (required) — The farm ID.

- `jobAttachmentSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnQueue.JobAttachmentSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_deadline.CfnQueue.JobAttachmentSettingsProperty.html) — The job attachment settings.

  These are the Amazon S3 bucket name and the Amazon S3 prefix.

- `jobRunAsUser`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnQueue.JobRunAsUserProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_deadline.CfnQueue.JobRunAsUserProperty.html) — Identifies the user for a job.

- `requiredFileSystemLocationNames`: string[] — The file system location that the queue uses.

- `roleArn`: string — The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.

- `schedulingConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnQueue.SchedulingConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_deadline.CfnQueue.SchedulingConfigurationProperty.html)

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — 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.
