Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. deadline
  5. Queue

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.deadline.Queue

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    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)
    public Queue(String name, QueueArgs args)
public Queue(String name, QueueArgs args, CustomResourceOptions options)

    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

    The Queue resource accepts the following input properties:

    DisplayName 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 string
    The farm ID.
    AllowedStorageProfileIds List<string>
    The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
    DefaultBudgetAction Pulumi.AwsNative.Deadline.QueueDefaultQueueBudgetAction
    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 Pulumi.AwsNative.Deadline.Inputs.QueueJobAttachmentSettings
    The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
    JobRunAsUser Pulumi.AwsNative.Deadline.Inputs.QueueJobRunAsUser
    Identifies the user for a job.
    RequiredFileSystemLocationNames List<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 List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    DisplayName 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 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 QueueDefaultQueueBudgetAction
    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 QueueJobAttachmentSettingsArgs
    The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
    JobRunAsUser QueueJobRunAsUserArgs
    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 TagArgs
    An array of key-value pairs to apply to this resource.
    displayName 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 String
    The farm ID.
    allowedStorageProfileIds List<String>
    The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
    defaultBudgetAction QueueDefaultQueueBudgetAction
    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 QueueJobAttachmentSettings
    The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
    jobRunAsUser QueueJobRunAsUser
    Identifies the user for a job.
    requiredFileSystemLocationNames List<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 List<Tag>
    An array of key-value pairs to apply to this resource.
    displayName 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 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 QueueDefaultQueueBudgetAction
    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 QueueJobAttachmentSettings
    The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
    jobRunAsUser QueueJobRunAsUser
    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 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_profile_ids Sequence[str]
    The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
    default_budget_action QueueDefaultQueueBudgetAction
    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_settings QueueJobAttachmentSettingsArgs
    The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
    job_run_as_user QueueJobRunAsUserArgs
    Identifies the user for a job.
    required_file_system_location_names Sequence[str]
    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.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    displayName 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 String
    The farm ID.
    allowedStorageProfileIds List<String>
    The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
    defaultBudgetAction "NONE" | "STOP_SCHEDULING_AND_COMPLETE_TASKS" | "STOP_SCHEDULING_AND_CANCEL_TASKS"
    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 Property Map
    The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
    jobRunAsUser Property Map
    Identifies the user for a job.
    requiredFileSystemLocationNames List<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 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:

    Arn string
    The Amazon Resource Name (ARN) of the queue.
    Id string
    The provider-assigned unique ID for this managed resource.
    QueueId string
    The queue ID.
    Arn string
    The Amazon Resource Name (ARN) of the queue.
    Id string
    The provider-assigned unique ID for this managed resource.
    QueueId string
    The queue ID.
    arn String
    The Amazon Resource Name (ARN) of the queue.
    id String
    The provider-assigned unique ID for this managed resource.
    queueId String
    The queue ID.
    arn string
    The Amazon Resource Name (ARN) of the queue.
    id string
    The provider-assigned unique ID for this managed resource.
    queueId string
    The queue ID.
    arn str
    The Amazon Resource Name (ARN) of the queue.
    id str
    The provider-assigned unique ID for this managed resource.
    queue_id str
    The queue ID.
    arn String
    The Amazon Resource Name (ARN) of the queue.
    id String
    The provider-assigned unique ID for this managed resource.
    queueId String
    The queue ID.

    Supporting Types

    QueueDefaultQueueBudgetAction, QueueDefaultQueueBudgetActionArgs

    None
    NONE
    StopSchedulingAndCompleteTasks
    STOP_SCHEDULING_AND_COMPLETE_TASKS
    StopSchedulingAndCancelTasks
    STOP_SCHEDULING_AND_CANCEL_TASKS
    QueueDefaultQueueBudgetActionNone
    NONE
    QueueDefaultQueueBudgetActionStopSchedulingAndCompleteTasks
    STOP_SCHEDULING_AND_COMPLETE_TASKS
    QueueDefaultQueueBudgetActionStopSchedulingAndCancelTasks
    STOP_SCHEDULING_AND_CANCEL_TASKS
    None
    NONE
    StopSchedulingAndCompleteTasks
    STOP_SCHEDULING_AND_COMPLETE_TASKS
    StopSchedulingAndCancelTasks
    STOP_SCHEDULING_AND_CANCEL_TASKS
    None
    NONE
    StopSchedulingAndCompleteTasks
    STOP_SCHEDULING_AND_COMPLETE_TASKS
    StopSchedulingAndCancelTasks
    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

    RootPrefix string
    The root prefix.
    S3BucketName string
    The Amazon S3 bucket name.
    RootPrefix string
    The root prefix.
    S3BucketName string
    The Amazon S3 bucket name.
    rootPrefix String
    The root prefix.
    s3BucketName String
    The Amazon S3 bucket name.
    rootPrefix string
    The root prefix.
    s3BucketName string
    The Amazon S3 bucket name.
    root_prefix str
    The root prefix.
    s3_bucket_name str
    The Amazon S3 bucket name.
    rootPrefix String
    The root prefix.
    s3BucketName String
    The Amazon S3 bucket name.

    QueueJobRunAsUser, QueueJobRunAsUserArgs

    RunAs Pulumi.AwsNative.Deadline.QueueRunAs
    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.AwsNative.Deadline.Inputs.QueuePosixUser
    The user and group that the jobs in the queue run as.
    Windows Pulumi.AwsNative.Deadline.Inputs.QueueWindowsUser
    Identifies a Microsoft Windows user.
    RunAs QueueRunAs
    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 QueuePosixUser
    The user and group that the jobs in the queue run as.
    Windows QueueWindowsUser
    Identifies a Microsoft Windows user.
    runAs QueueRunAs
    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 QueuePosixUser
    The user and group that the jobs in the queue run as.
    windows QueueWindowsUser
    Identifies a Microsoft Windows user.
    runAs QueueRunAs
    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 QueuePosixUser
    The user and group that the jobs in the queue run as.
    windows QueueWindowsUser
    Identifies a Microsoft Windows user.
    run_as QueueRunAs
    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 QueuePosixUser
    The user and group that the jobs in the queue run as.
    windows QueueWindowsUser
    Identifies a Microsoft Windows user.
    runAs "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

    Group string
    The name of the POSIX user's group.
    User string
    The name of the POSIX user.
    Group string
    The name of the POSIX user's group.
    User string
    The name of the POSIX user.
    group String
    The name of the POSIX user's group.
    user String
    The name of the POSIX user.
    group string
    The name of the POSIX user's group.
    user string
    The name of the POSIX user.
    group str
    The name of the POSIX user's group.
    user str
    The name of the POSIX user.
    group String
    The name of the POSIX user's group.
    user String
    The name of the POSIX user.

    QueueRunAs, QueueRunAsArgs

    QueueConfiguredUser
    QUEUE_CONFIGURED_USER
    WorkerAgentUser
    WORKER_AGENT_USER
    QueueRunAsQueueConfiguredUser
    QUEUE_CONFIGURED_USER
    QueueRunAsWorkerAgentUser
    WORKER_AGENT_USER
    QueueConfiguredUser
    QUEUE_CONFIGURED_USER
    WorkerAgentUser
    WORKER_AGENT_USER
    QueueConfiguredUser
    QUEUE_CONFIGURED_USER
    WorkerAgentUser
    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

    PasswordArn string
    The password ARN for the Windows user.
    User string
    The user.
    PasswordArn string
    The password ARN for the Windows user.
    User string
    The user.
    passwordArn String
    The password ARN for the Windows user.
    user String
    The user.
    passwordArn 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.
    passwordArn String
    The password ARN for the Windows user.
    user String
    The user.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native