Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Prefect Provider
  3. API Docs
  4. WorkQueue
prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq
prefecthq/terraform-provider-prefect

prefect.WorkQueue

Explore with Pulumi AI

prefect logo
prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq
prefecthq/terraform-provider-prefect

    The resource work_queue represents a Prefect Work Queue. Work Queues are used to configure and manage job execution queues in Prefect.

    Work Queues can be associated with a work pool and have configurations like concurrency limits.

    For more information, see work queues.

    This feature is available in the following product plan(s): Prefect OSS, Prefect Cloud (Free), Prefect Cloud (Pro), Prefect Cloud (Enterprise).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as prefect from "@pulumi/prefect";

const exampleWorkspace = new prefect.Workspace("exampleWorkspace", {handle: "my-workspace"});
const exampleWorkPool = new prefect.WorkPool("exampleWorkPool", {
    type: "kubernetes",
    paused: false,
    workspaceId: exampleWorkspace.id,
});
const exampleWorkQueue = new prefect.WorkQueue("exampleWorkQueue", {
    description: "My work queue",
    concurrencyLimit: 2,
    workspaceId: exampleWorkspace.id,
});

    import pulumi
import pulumi_prefect as prefect

example_workspace = prefect.Workspace("exampleWorkspace", handle="my-workspace")
example_work_pool = prefect.WorkPool("exampleWorkPool",
    type="kubernetes",
    paused=False,
    workspace_id=example_workspace.id)
example_work_queue = prefect.WorkQueue("exampleWorkQueue",
    description="My work queue",
    concurrency_limit=2,
    workspace_id=example_workspace.id)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/prefect/v2/prefect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleWorkspace, err := prefect.NewWorkspace(ctx, "exampleWorkspace", &prefect.WorkspaceArgs{
			Handle: pulumi.String("my-workspace"),
		})
		if err != nil {
			return err
		}
		_, err = prefect.NewWorkPool(ctx, "exampleWorkPool", &prefect.WorkPoolArgs{
			Type:        pulumi.String("kubernetes"),
			Paused:      pulumi.Bool(false),
			WorkspaceId: exampleWorkspace.ID(),
		})
		if err != nil {
			return err
		}
		_, err = prefect.NewWorkQueue(ctx, "exampleWorkQueue", &prefect.WorkQueueArgs{
			Description:      pulumi.String("My work queue"),
			ConcurrencyLimit: pulumi.Float64(2),
			WorkspaceId:      exampleWorkspace.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prefect = Pulumi.Prefect;

return await Deployment.RunAsync(() => 
{
    var exampleWorkspace = new Prefect.Workspace("exampleWorkspace", new()
    {
        Handle = "my-workspace",
    });

    var exampleWorkPool = new Prefect.WorkPool("exampleWorkPool", new()
    {
        Type = "kubernetes",
        Paused = false,
        WorkspaceId = exampleWorkspace.Id,
    });

    var exampleWorkQueue = new Prefect.WorkQueue("exampleWorkQueue", new()
    {
        Description = "My work queue",
        ConcurrencyLimit = 2,
        WorkspaceId = exampleWorkspace.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prefect.Workspace;
import com.pulumi.prefect.WorkspaceArgs;
import com.pulumi.prefect.WorkPool;
import com.pulumi.prefect.WorkPoolArgs;
import com.pulumi.prefect.WorkQueue;
import com.pulumi.prefect.WorkQueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
            .handle("my-workspace")
            .build());

        var exampleWorkPool = new WorkPool("exampleWorkPool", WorkPoolArgs.builder()
            .type("kubernetes")
            .paused(false)
            .workspaceId(exampleWorkspace.id())
            .build());

        var exampleWorkQueue = new WorkQueue("exampleWorkQueue", WorkQueueArgs.builder()
            .description("My work queue")
            .concurrencyLimit(2)
            .workspaceId(exampleWorkspace.id())
            .build());

    }
}

    resources:
  exampleWorkspace:
    type: prefect:Workspace
    properties:
      handle: my-workspace
  exampleWorkPool:
    type: prefect:WorkPool
    properties:
      type: kubernetes
      paused: false
      workspaceId: ${exampleWorkspace.id}
  exampleWorkQueue:
    type: prefect:WorkQueue
    properties:
      description: My work queue
      concurrencyLimit: 2
      workspaceId: ${exampleWorkspace.id}

    Create WorkQueue Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkQueue(name: string, args: WorkQueueArgs, opts?: CustomResourceOptions);
    @overload
def WorkQueue(resource_name: str,
              args: WorkQueueArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def WorkQueue(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              work_pool_name: Optional[str] = None,
              account_id: Optional[str] = None,
              concurrency_limit: Optional[float] = None,
              description: Optional[str] = None,
              is_paused: Optional[bool] = None,
              name: Optional[str] = None,
              priority: Optional[float] = None,
              workspace_id: Optional[str] = None)
    func NewWorkQueue(ctx *Context, name string, args WorkQueueArgs, opts ...ResourceOption) (*WorkQueue, error)
    public WorkQueue(string name, WorkQueueArgs args, CustomResourceOptions? opts = null)
    public WorkQueue(String name, WorkQueueArgs args)
public WorkQueue(String name, WorkQueueArgs args, CustomResourceOptions options)

    type: prefect:WorkQueue
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 WorkQueueArgs
    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 WorkQueueArgs
    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 WorkQueueArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkQueueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkQueueArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var workQueueResource = new Prefect.WorkQueue("workQueueResource", new()
{
    WorkPoolName = "string",
    AccountId = "string",
    ConcurrencyLimit = 0,
    Description = "string",
    IsPaused = false,
    Name = "string",
    Priority = 0,
    WorkspaceId = "string",
});

    example, err := prefect.NewWorkQueue(ctx, "workQueueResource", &prefect.WorkQueueArgs{
WorkPoolName: pulumi.String("string"),
AccountId: pulumi.String("string"),
ConcurrencyLimit: pulumi.Float64(0),
Description: pulumi.String("string"),
IsPaused: pulumi.Bool(false),
Name: pulumi.String("string"),
Priority: pulumi.Float64(0),
WorkspaceId: pulumi.String("string"),
})

    var workQueueResource = new WorkQueue("workQueueResource", WorkQueueArgs.builder()
    .workPoolName("string")
    .accountId("string")
    .concurrencyLimit(0)
    .description("string")
    .isPaused(false)
    .name("string")
    .priority(0)
    .workspaceId("string")
    .build());

    work_queue_resource = prefect.WorkQueue("workQueueResource",
    work_pool_name="string",
    account_id="string",
    concurrency_limit=0,
    description="string",
    is_paused=False,
    name="string",
    priority=0,
    workspace_id="string")

    const workQueueResource = new prefect.WorkQueue("workQueueResource", {
    workPoolName: "string",
    accountId: "string",
    concurrencyLimit: 0,
    description: "string",
    isPaused: false,
    name: "string",
    priority: 0,
    workspaceId: "string",
});

    type: prefect:WorkQueue
properties:
    accountId: string
    concurrencyLimit: 0
    description: string
    isPaused: false
    name: string
    priority: 0
    workPoolName: string
    workspaceId: string

    WorkQueue 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 WorkQueue resource accepts the following input properties:

    WorkPoolName string
    The name of the work pool associated with this work queue
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    ConcurrencyLimit double
    The concurrency limit applied to this work queue
    Description string
    Description of the work queue
    IsPaused bool
    Whether this work queue is paused
    Name string
    Name of the work queue
    Priority double
    The priority of this work queue
    WorkspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.
    WorkPoolName string
    The name of the work pool associated with this work queue
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    ConcurrencyLimit float64
    The concurrency limit applied to this work queue
    Description string
    Description of the work queue
    IsPaused bool
    Whether this work queue is paused
    Name string
    Name of the work queue
    Priority float64
    The priority of this work queue
    WorkspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.
    workPoolName String
    The name of the work pool associated with this work queue
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit Double
    The concurrency limit applied to this work queue
    description String
    Description of the work queue
    isPaused Boolean
    Whether this work queue is paused
    name String
    Name of the work queue
    priority Double
    The priority of this work queue
    workspaceId String
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.
    workPoolName string
    The name of the work pool associated with this work queue
    accountId string
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit number
    The concurrency limit applied to this work queue
    description string
    Description of the work queue
    isPaused boolean
    Whether this work queue is paused
    name string
    Name of the work queue
    priority number
    The priority of this work queue
    workspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.
    work_pool_name str
    The name of the work pool associated with this work queue
    account_id str
    Account ID (UUID), defaults to the account set in the provider
    concurrency_limit float
    The concurrency limit applied to this work queue
    description str
    Description of the work queue
    is_paused bool
    Whether this work queue is paused
    name str
    Name of the work queue
    priority float
    The priority of this work queue
    workspace_id str
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.
    workPoolName String
    The name of the work pool associated with this work queue
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit Number
    The concurrency limit applied to this work queue
    description String
    Description of the work queue
    isPaused Boolean
    Whether this work queue is paused
    name String
    Name of the work queue
    priority Number
    The priority of this work queue
    workspaceId String
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkQueue resource produces the following output properties:

    Created string
    Timestamp of when the resource was created (RFC3339)
    Id string
    The provider-assigned unique ID for this managed resource.
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    Created string
    Timestamp of when the resource was created (RFC3339)
    Id string
    The provider-assigned unique ID for this managed resource.
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    created String
    Timestamp of when the resource was created (RFC3339)
    id String
    The provider-assigned unique ID for this managed resource.
    updated String
    Timestamp of when the resource was updated (RFC3339)
    created string
    Timestamp of when the resource was created (RFC3339)
    id string
    The provider-assigned unique ID for this managed resource.
    updated string
    Timestamp of when the resource was updated (RFC3339)
    created str
    Timestamp of when the resource was created (RFC3339)
    id str
    The provider-assigned unique ID for this managed resource.
    updated str
    Timestamp of when the resource was updated (RFC3339)
    created String
    Timestamp of when the resource was created (RFC3339)
    id String
    The provider-assigned unique ID for this managed resource.
    updated String
    Timestamp of when the resource was updated (RFC3339)

    Look up Existing WorkQueue Resource

    Get an existing WorkQueue resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkQueueState, opts?: CustomResourceOptions): WorkQueue
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        concurrency_limit: Optional[float] = None,
        created: Optional[str] = None,
        description: Optional[str] = None,
        is_paused: Optional[bool] = None,
        name: Optional[str] = None,
        priority: Optional[float] = None,
        updated: Optional[str] = None,
        work_pool_name: Optional[str] = None,
        workspace_id: Optional[str] = None) -> WorkQueue
    func GetWorkQueue(ctx *Context, name string, id IDInput, state *WorkQueueState, opts ...ResourceOption) (*WorkQueue, error)
    public static WorkQueue Get(string name, Input<string> id, WorkQueueState? state, CustomResourceOptions? opts = null)
    public static WorkQueue get(String name, Output<String> id, WorkQueueState state, CustomResourceOptions options)
    resources:  _:    type: prefect:WorkQueue    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    ConcurrencyLimit double
    The concurrency limit applied to this work queue
    Created string
    Timestamp of when the resource was created (RFC3339)
    Description string
    Description of the work queue
    IsPaused bool
    Whether this work queue is paused
    Name string
    Name of the work queue
    Priority double
    The priority of this work queue
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    WorkPoolName string
    The name of the work pool associated with this work queue
    WorkspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    ConcurrencyLimit float64
    The concurrency limit applied to this work queue
    Created string
    Timestamp of when the resource was created (RFC3339)
    Description string
    Description of the work queue
    IsPaused bool
    Whether this work queue is paused
    Name string
    Name of the work queue
    Priority float64
    The priority of this work queue
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    WorkPoolName string
    The name of the work pool associated with this work queue
    WorkspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit Double
    The concurrency limit applied to this work queue
    created String
    Timestamp of when the resource was created (RFC3339)
    description String
    Description of the work queue
    isPaused Boolean
    Whether this work queue is paused
    name String
    Name of the work queue
    priority Double
    The priority of this work queue
    updated String
    Timestamp of when the resource was updated (RFC3339)
    workPoolName String
    The name of the work pool associated with this work queue
    workspaceId String
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.
    accountId string
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit number
    The concurrency limit applied to this work queue
    created string
    Timestamp of when the resource was created (RFC3339)
    description string
    Description of the work queue
    isPaused boolean
    Whether this work queue is paused
    name string
    Name of the work queue
    priority number
    The priority of this work queue
    updated string
    Timestamp of when the resource was updated (RFC3339)
    workPoolName string
    The name of the work pool associated with this work queue
    workspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.
    account_id str
    Account ID (UUID), defaults to the account set in the provider
    concurrency_limit float
    The concurrency limit applied to this work queue
    created str
    Timestamp of when the resource was created (RFC3339)
    description str
    Description of the work queue
    is_paused bool
    Whether this work queue is paused
    name str
    Name of the work queue
    priority float
    The priority of this work queue
    updated str
    Timestamp of when the resource was updated (RFC3339)
    work_pool_name str
    The name of the work pool associated with this work queue
    workspace_id str
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit Number
    The concurrency limit applied to this work queue
    created String
    Timestamp of when the resource was created (RFC3339)
    description String
    Description of the work queue
    isPaused Boolean
    Whether this work queue is paused
    name String
    Name of the work queue
    priority Number
    The priority of this work queue
    updated String
    Timestamp of when the resource was updated (RFC3339)
    workPoolName String
    The name of the work pool associated with this work queue
    workspaceId String
    Workspace ID (UUID), defaults to the workspace set in the provider. In Prefect Cloud, either the work_pool resource or the provider's workspace_id must be set.

    Import

    Prefect Work Queues can be imported using work_pool_name,work_queue_name,workspace_id

    $ pulumi import prefect:index/workQueue:WorkQueue example kubernetes-work-pool,my-work-queue,00000000-0000-0000-0000-000000000000

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    prefect prefecthq/terraform-provider-prefect
    License
    Notes
    This Pulumi package is based on the prefect Terraform Provider.
    prefect logo
    prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq
    prefecthq/terraform-provider-prefect