We recommend new projects start with resources from the AWS provider.
aws-native.deadline.Queue
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::Deadline::Queue Resource Type
Create Queue Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Queue(name: string, args: QueueArgs, opts?: CustomResourceOptions);
@overload
def Queue(resource_name: str,
args: QueueArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Queue(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
farm_id: Optional[str] = None,
allowed_storage_profile_ids: Optional[Sequence[str]] = None,
default_budget_action: Optional[QueueDefaultQueueBudgetAction] = None,
description: Optional[str] = None,
job_attachment_settings: Optional[QueueJobAttachmentSettingsArgs] = None,
job_run_as_user: Optional[QueueJobRunAsUserArgs] = None,
required_file_system_location_names: Optional[Sequence[str]] = None,
role_arn: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewQueue(ctx *Context, name string, args QueueArgs, opts ...ResourceOption) (*Queue, error)
public Queue(string name, QueueArgs args, CustomResourceOptions? opts = null)
type: aws-native:deadline:Queue
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Queue Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Queue resource accepts the following input properties:
- Display
Name 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.
- Farm
Id string - The farm ID.
- Allowed
Storage List<string>Profile Ids - The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
- Default
Budget Pulumi.Action Aws Native. Deadline. Queue Default Queue Budget Action - 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.
- Job
Attachment Pulumi.Settings Aws Native. Deadline. Inputs. Queue Job Attachment Settings - The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
- Job
Run Pulumi.As User Aws Native. Deadline. Inputs. Queue Job Run As User - Identifies the user for a job.
- Required
File List<string>System Location Names - The file system location that the queue uses.
- Role
Arn string - The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
- List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Display
Name 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.
- Farm
Id string - The farm ID.
- Allowed
Storage []stringProfile Ids - The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
- Default
Budget QueueAction Default Queue Budget Action - 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.
- Job
Attachment QueueSettings Job Attachment Settings Args - The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
- Job
Run QueueAs User Job Run As User Args - Identifies the user for a job.
- Required
File []stringSystem Location Names - The file system location that the queue uses.
- Role
Arn string - The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
- Tag
Args - An array of key-value pairs to apply to this resource.
- display
Name 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.
- farm
Id String - The farm ID.
- allowed
Storage List<String>Profile Ids - The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
- default
Budget QueueAction Default Queue Budget Action - 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.
- job
Attachment QueueSettings Job Attachment Settings - The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
- job
Run QueueAs User Job Run As User - Identifies the user for a job.
- required
File List<String>System Location Names - The file system location that the queue uses.
- role
Arn String - The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- display
Name 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.
- farm
Id string - The farm ID.
- allowed
Storage string[]Profile Ids - The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
- default
Budget QueueAction Default Queue Budget Action - 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.
- job
Attachment QueueSettings Job Attachment Settings - The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
- job
Run QueueAs User Job Run As User - Identifies the user for a job.
- required
File string[]System Location Names - The file system location that the queue uses.
- role
Arn string - The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
- Tag[]
- An array of key-value pairs to apply to this resource.
- display_
name str 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.
- farm_
id str - The farm ID.
- allowed_
storage_ Sequence[str]profile_ ids - The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
- default_
budget_ Queueaction Default Queue Budget Action - The default action taken on a queue summary if a budget wasn't configured.
- description str
- A description of the queue that helps identify what the queue is used for.
- job_
attachment_ Queuesettings Job Attachment Settings Args - The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
- job_
run_ Queueas_ user Job Run As User Args - Identifies the user for a job.
- required_
file_ Sequence[str]system_ location_ names - The file system location that the queue uses.
- role_
arn str - The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
- Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- display
Name 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.
- farm
Id String - The farm ID.
- allowed
Storage List<String>Profile Ids - The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
- default
Budget "NONE" | "STOP_SCHEDULING_AND_COMPLETE_TASKS" | "STOP_SCHEDULING_AND_CANCEL_TASKS"Action - 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.
- job
Attachment Property MapSettings - The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
- job
Run Property MapAs User - Identifies the user for a job.
- required
File List<String>System Location Names - The file system location that the queue uses.
- role
Arn String - The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the Queue resource produces the following output properties:
Supporting Types
QueueDefaultQueueBudgetAction, QueueDefaultQueueBudgetActionArgs
- None
- NONE
- Stop
Scheduling And Complete Tasks - STOP_SCHEDULING_AND_COMPLETE_TASKS
- Stop
Scheduling And Cancel Tasks - STOP_SCHEDULING_AND_CANCEL_TASKS
- Queue
Default Queue Budget Action None - NONE
- Queue
Default Queue Budget Action Stop Scheduling And Complete Tasks - STOP_SCHEDULING_AND_COMPLETE_TASKS
- Queue
Default Queue Budget Action Stop Scheduling And Cancel Tasks - STOP_SCHEDULING_AND_CANCEL_TASKS
- None
- NONE
- Stop
Scheduling And Complete Tasks - STOP_SCHEDULING_AND_COMPLETE_TASKS
- Stop
Scheduling And Cancel Tasks - STOP_SCHEDULING_AND_CANCEL_TASKS
- None
- NONE
- Stop
Scheduling And Complete Tasks - STOP_SCHEDULING_AND_COMPLETE_TASKS
- Stop
Scheduling And Cancel Tasks - STOP_SCHEDULING_AND_CANCEL_TASKS
- NONE
- NONE
- STOP_SCHEDULING_AND_COMPLETE_TASKS
- STOP_SCHEDULING_AND_COMPLETE_TASKS
- STOP_SCHEDULING_AND_CANCEL_TASKS
- STOP_SCHEDULING_AND_CANCEL_TASKS
- "NONE"
- NONE
- "STOP_SCHEDULING_AND_COMPLETE_TASKS"
- STOP_SCHEDULING_AND_COMPLETE_TASKS
- "STOP_SCHEDULING_AND_CANCEL_TASKS"
- STOP_SCHEDULING_AND_CANCEL_TASKS
QueueJobAttachmentSettings, QueueJobAttachmentSettingsArgs
- Root
Prefix string - The root prefix.
- S3Bucket
Name string - The Amazon S3 bucket name.
- Root
Prefix string - The root prefix.
- S3Bucket
Name string - The Amazon S3 bucket name.
- root
Prefix String - The root prefix.
- s3Bucket
Name String - The Amazon S3 bucket name.
- root
Prefix string - The root prefix.
- s3Bucket
Name string - The Amazon S3 bucket name.
- root_
prefix str - The root prefix.
- s3_
bucket_ strname - The Amazon S3 bucket name.
- root
Prefix String - The root prefix.
- s3Bucket
Name String - The Amazon S3 bucket name.
QueueJobRunAsUser, QueueJobRunAsUserArgs
- Run
As Pulumi.Aws Native. Deadline. Queue Run As - Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
- Posix
Pulumi.
Aws Native. Deadline. Inputs. Queue Posix User - The user and group that the jobs in the queue run as.
- Windows
Pulumi.
Aws Native. Deadline. Inputs. Queue Windows User - Identifies a Microsoft Windows user.
- Run
As QueueRun As - Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
- Posix
Queue
Posix User - The user and group that the jobs in the queue run as.
- Windows
Queue
Windows User - Identifies a Microsoft Windows user.
- run
As QueueRun As - Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
- posix
Queue
Posix User - The user and group that the jobs in the queue run as.
- windows
Queue
Windows User - Identifies a Microsoft Windows user.
- run
As QueueRun As - Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
- posix
Queue
Posix User - The user and group that the jobs in the queue run as.
- windows
Queue
Windows User - Identifies a Microsoft Windows user.
- run_
as QueueRun As - Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
- posix
Queue
Posix User - The user and group that the jobs in the queue run as.
- windows
Queue
Windows User - Identifies a Microsoft Windows user.
- run
As "QUEUE_CONFIGURED_USER" | "WORKER_AGENT_USER" - Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
- posix Property Map
- The user and group that the jobs in the queue run as.
- windows Property Map
- Identifies a Microsoft Windows user.
QueuePosixUser, QueuePosixUserArgs
QueueRunAs, QueueRunAsArgs
- Queue
Configured User - QUEUE_CONFIGURED_USER
- Worker
Agent User - WORKER_AGENT_USER
- Queue
Run As Queue Configured User - QUEUE_CONFIGURED_USER
- Queue
Run As Worker Agent User - WORKER_AGENT_USER
- Queue
Configured User - QUEUE_CONFIGURED_USER
- Worker
Agent User - WORKER_AGENT_USER
- Queue
Configured User - QUEUE_CONFIGURED_USER
- Worker
Agent User - WORKER_AGENT_USER
- QUEUE_CONFIGURED_USER
- QUEUE_CONFIGURED_USER
- WORKER_AGENT_USER
- WORKER_AGENT_USER
- "QUEUE_CONFIGURED_USER"
- QUEUE_CONFIGURED_USER
- "WORKER_AGENT_USER"
- WORKER_AGENT_USER
QueueWindowsUser, QueueWindowsUserArgs
- Password
Arn string - The password ARN for the Windows user.
- User string
- The user.
- Password
Arn string - The password ARN for the Windows user.
- User string
- The user.
- password
Arn String - The password ARN for the Windows user.
- user String
- The user.
- password
Arn string - The password ARN for the Windows user.
- user string
- The user.
- password_
arn str - The password ARN for the Windows user.
- user str
- The user.
- password
Arn String - The password ARN for the Windows user.
- user String
- The user.
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.