interface CfnQueueProps

Language	Type name
.NET	`Amazon.CDK.aws_deadline.CfnQueueProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdeadline#CfnQueueProps`
Java	`software.amazon.awscdk.services.deadline.CfnQueueProps`
Python	`aws_cdk.aws_deadline.CfnQueueProps`
TypeScript	`aws-cdk-lib` » `aws_deadline` » `CfnQueueProps`

Properties for defining a CfnQueue.

Example

// 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';
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',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
displayName	`string`	The display name of the queue summary to update.
farmId	`string`	The farm ID.
allowedStorageProfileIds?	`string[]`	The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
defaultBudgetAction?	`string`	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.
jobAttachmentSettings?	`IResolvable` `\|` `JobAttachmentSettingsProperty`	The job attachment settings.
jobRunAsUser?	`IResolvable` `\|` `JobRunAsUserProperty`	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.
tags?	`CfnTag[]`	The tags to add to your queue.

displayName

Type: 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.

farmId

Type: string

The farm ID.

allowedStorageProfileIds?

Type: string[] (optional)

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

defaultBudgetAction?

Type: string (optional, default: "NONE")

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

description?

Type: string (optional, default: "")

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

jobAttachmentSettings?

Type: IResolvable | JobAttachmentSettingsProperty (optional)

The job attachment settings.

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

jobRunAsUser?

Type: IResolvable | JobRunAsUserProperty (optional)

Identifies the user for a job.

requiredFileSystemLocationNames?

Type: string[] (optional)

The file system location that the queue uses.

roleArn?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

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.