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

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.deadline.getQueue

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Deadline::Queue Resource Type

    Using getQueue

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getQueue(args: GetQueueArgs, opts?: InvokeOptions): Promise<GetQueueResult>
function getQueueOutput(args: GetQueueOutputArgs, opts?: InvokeOptions): Output<GetQueueResult>
    def get_queue(arn: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetQueueResult
def get_queue_output(arn: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetQueueResult]
    func LookupQueue(ctx *Context, args *LookupQueueArgs, opts ...InvokeOption) (*LookupQueueResult, error)
func LookupQueueOutput(ctx *Context, args *LookupQueueOutputArgs, opts ...InvokeOption) LookupQueueResultOutput

    > Note: This function is named LookupQueue in the Go SDK.

    public static class GetQueue 
{
    public static Task<GetQueueResult> InvokeAsync(GetQueueArgs args, InvokeOptions? opts = null)
    public static Output<GetQueueResult> Invoke(GetQueueInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetQueueResult> getQueue(GetQueueArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:deadline:getQueue
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the queue.
    Arn string
    The Amazon Resource Name (ARN) of the queue.
    arn String
    The Amazon Resource Name (ARN) of the queue.
    arn string
    The Amazon Resource Name (ARN) of the queue.
    arn str
    The Amazon Resource Name (ARN) of the queue.
    arn String
    The Amazon Resource Name (ARN) of the queue.

    getQueue Result

    The following output properties are available:

    AllowedStorageProfileIds List<string>
    The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
    Arn string
    The Amazon Resource Name (ARN) of the queue.
    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.
    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.

    JobAttachmentSettings Pulumi.AwsNative.Deadline.Outputs.QueueJobAttachmentSettings
    The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
    JobRunAsUser Pulumi.AwsNative.Deadline.Outputs.QueueJobRunAsUser
    Identifies the user for a job.
    QueueId string
    The queue ID.
    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.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    AllowedStorageProfileIds []string
    The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
    Arn string
    The Amazon Resource Name (ARN) of the queue.
    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.
    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.

    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.
    QueueId string
    The queue ID.
    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.
    allowedStorageProfileIds List<String>
    The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
    arn String
    The Amazon Resource Name (ARN) of the queue.
    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.
    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.

    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.
    queueId String
    The queue ID.
    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.
    allowedStorageProfileIds string[]
    The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
    arn string
    The Amazon Resource Name (ARN) of the queue.
    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.
    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.

    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.
    queueId string
    The queue ID.
    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.
    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.
    arn str
    The Amazon Resource Name (ARN) of the queue.
    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.
    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.

    job_attachment_settings QueueJobAttachmentSettings
    The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
    job_run_as_user QueueJobRunAsUser
    Identifies the user for a job.
    queue_id str
    The queue ID.
    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[root_Tag]
    An array of key-value pairs to apply to this resource.
    allowedStorageProfileIds List<String>
    The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
    arn String
    The Amazon Resource Name (ARN) of the queue.
    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.
    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.

    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.
    queueId String
    The queue ID.
    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.

    Supporting Types

    QueueDefaultQueueBudgetAction

    QueueJobAttachmentSettings

    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

    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

    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

    QueueWindowsUser

    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

    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 Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native