Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Prefect Provider
  3. API Docs
  4. GlobalConcurrencyLimit
prefect 2.22.3 published on Thursday, Mar 20, 2025 by prefecthq
prefecthq/terraform-provider-prefect

prefect.GlobalConcurrencyLimit

Explore with Pulumi AI

prefect logo
prefect 2.22.3 published on Thursday, Mar 20, 2025 by prefecthq
prefecthq/terraform-provider-prefect

    The resource global_concurrency_limit represents a global concurrency limit. Global concurrency limits allow you to control how many tasks can run simultaneously across all workspaces. For more information, see apply global concurrency and rate limits.

    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 testWorkspace = prefect.getWorkspace({
    handle: "my-workspace",
});
const testGlobalConcurrencyLimit = new prefect.GlobalConcurrencyLimit("testGlobalConcurrencyLimit", {
    workspaceId: testWorkspace.then(testWorkspace => testWorkspace.id),
    limit: 1,
    active: true,
    activeSlots: 0,
    slotDecayPerSecond: 1.5,
});

    import pulumi
import pulumi_prefect as prefect

test_workspace = prefect.get_workspace(handle="my-workspace")
test_global_concurrency_limit = prefect.GlobalConcurrencyLimit("testGlobalConcurrencyLimit",
    workspace_id=test_workspace.id,
    limit=1,
    active=True,
    active_slots=0,
    slot_decay_per_second=1.5)

    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 {
		testWorkspace, err := prefect.LookupWorkspace(ctx, &prefect.LookupWorkspaceArgs{
			Handle: pulumi.StringRef("my-workspace"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = prefect.NewGlobalConcurrencyLimit(ctx, "testGlobalConcurrencyLimit", &prefect.GlobalConcurrencyLimitArgs{
			WorkspaceId:        pulumi.String(testWorkspace.Id),
			Limit:              pulumi.Float64(1),
			Active:             pulumi.Bool(true),
			ActiveSlots:        pulumi.Float64(0),
			SlotDecayPerSecond: pulumi.Float64(1.5),
		})
		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 testWorkspace = Prefect.GetWorkspace.Invoke(new()
    {
        Handle = "my-workspace",
    });

    var testGlobalConcurrencyLimit = new Prefect.GlobalConcurrencyLimit("testGlobalConcurrencyLimit", new()
    {
        WorkspaceId = testWorkspace.Apply(getWorkspaceResult => getWorkspaceResult.Id),
        Limit = 1,
        Active = true,
        ActiveSlots = 0,
        SlotDecayPerSecond = 1.5,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prefect.PrefectFunctions;
import com.pulumi.prefect.inputs.GetWorkspaceArgs;
import com.pulumi.prefect.GlobalConcurrencyLimit;
import com.pulumi.prefect.GlobalConcurrencyLimitArgs;
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) {
        final var testWorkspace = PrefectFunctions.getWorkspace(GetWorkspaceArgs.builder()
            .handle("my-workspace")
            .build());

        var testGlobalConcurrencyLimit = new GlobalConcurrencyLimit("testGlobalConcurrencyLimit", GlobalConcurrencyLimitArgs.builder()
            .workspaceId(testWorkspace.applyValue(getWorkspaceResult -> getWorkspaceResult.id()))
            .limit(1)
            .active(true)
            .activeSlots(0)
            .slotDecayPerSecond(1.5)
            .build());

    }
}

    resources:
  testGlobalConcurrencyLimit:
    type: prefect:GlobalConcurrencyLimit
    properties:
      workspaceId: ${testWorkspace.id}
      limit: 1
      active: true
      activeSlots: 0
      slotDecayPerSecond: 1.5
variables:
  testWorkspace:
    fn::invoke:
      function: prefect:getWorkspace
      arguments:
        handle: my-workspace

    Create GlobalConcurrencyLimit Resource

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

    Constructor syntax

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

@overload
def GlobalConcurrencyLimit(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           limit: Optional[float] = None,
                           account_id: Optional[str] = None,
                           active: Optional[bool] = None,
                           active_slots: Optional[float] = None,
                           name: Optional[str] = None,
                           slot_decay_per_second: Optional[float] = None,
                           workspace_id: Optional[str] = None)
    func NewGlobalConcurrencyLimit(ctx *Context, name string, args GlobalConcurrencyLimitArgs, opts ...ResourceOption) (*GlobalConcurrencyLimit, error)
    public GlobalConcurrencyLimit(string name, GlobalConcurrencyLimitArgs args, CustomResourceOptions? opts = null)
    public GlobalConcurrencyLimit(String name, GlobalConcurrencyLimitArgs args)
public GlobalConcurrencyLimit(String name, GlobalConcurrencyLimitArgs args, CustomResourceOptions options)

    type: prefect:GlobalConcurrencyLimit
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 GlobalConcurrencyLimitArgs
    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 GlobalConcurrencyLimitArgs
    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 GlobalConcurrencyLimitArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalConcurrencyLimitArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalConcurrencyLimitArgs
    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 globalConcurrencyLimitResource = new Prefect.GlobalConcurrencyLimit("globalConcurrencyLimitResource", new()
{
    Limit = 0,
    AccountId = "string",
    Active = false,
    ActiveSlots = 0,
    Name = "string",
    SlotDecayPerSecond = 0,
    WorkspaceId = "string",
});

    example, err := prefect.NewGlobalConcurrencyLimit(ctx, "globalConcurrencyLimitResource", &prefect.GlobalConcurrencyLimitArgs{
Limit: pulumi.Float64(0),
AccountId: pulumi.String("string"),
Active: pulumi.Bool(false),
ActiveSlots: pulumi.Float64(0),
Name: pulumi.String("string"),
SlotDecayPerSecond: pulumi.Float64(0),
WorkspaceId: pulumi.String("string"),
})

    var globalConcurrencyLimitResource = new GlobalConcurrencyLimit("globalConcurrencyLimitResource", GlobalConcurrencyLimitArgs.builder()
    .limit(0)
    .accountId("string")
    .active(false)
    .activeSlots(0)
    .name("string")
    .slotDecayPerSecond(0)
    .workspaceId("string")
    .build());

    global_concurrency_limit_resource = prefect.GlobalConcurrencyLimit("globalConcurrencyLimitResource",
    limit=0,
    account_id="string",
    active=False,
    active_slots=0,
    name="string",
    slot_decay_per_second=0,
    workspace_id="string")

    const globalConcurrencyLimitResource = new prefect.GlobalConcurrencyLimit("globalConcurrencyLimitResource", {
    limit: 0,
    accountId: "string",
    active: false,
    activeSlots: 0,
    name: "string",
    slotDecayPerSecond: 0,
    workspaceId: "string",
});

    type: prefect:GlobalConcurrencyLimit
properties:
    accountId: string
    active: false
    activeSlots: 0
    limit: 0
    name: string
    slotDecayPerSecond: 0
    workspaceId: string

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

    Limit double
    The maximum number of tasks that can run simultaneously.
    AccountId string
    Account ID (UUID)
    Active bool
    Whether the global concurrency limit is active.
    ActiveSlots double
    The number of active slots.
    Name string
    The name of the global concurrency limit.
    SlotDecayPerSecond double
    Slot Decay Per Second (number or null)
    WorkspaceId string
    Workspace ID (UUID)
    Limit float64
    The maximum number of tasks that can run simultaneously.
    AccountId string
    Account ID (UUID)
    Active bool
    Whether the global concurrency limit is active.
    ActiveSlots float64
    The number of active slots.
    Name string
    The name of the global concurrency limit.
    SlotDecayPerSecond float64
    Slot Decay Per Second (number or null)
    WorkspaceId string
    Workspace ID (UUID)
    limit Double
    The maximum number of tasks that can run simultaneously.
    accountId String
    Account ID (UUID)
    active Boolean
    Whether the global concurrency limit is active.
    activeSlots Double
    The number of active slots.
    name String
    The name of the global concurrency limit.
    slotDecayPerSecond Double
    Slot Decay Per Second (number or null)
    workspaceId String
    Workspace ID (UUID)
    limit number
    The maximum number of tasks that can run simultaneously.
    accountId string
    Account ID (UUID)
    active boolean
    Whether the global concurrency limit is active.
    activeSlots number
    The number of active slots.
    name string
    The name of the global concurrency limit.
    slotDecayPerSecond number
    Slot Decay Per Second (number or null)
    workspaceId string
    Workspace ID (UUID)
    limit float
    The maximum number of tasks that can run simultaneously.
    account_id str
    Account ID (UUID)
    active bool
    Whether the global concurrency limit is active.
    active_slots float
    The number of active slots.
    name str
    The name of the global concurrency limit.
    slot_decay_per_second float
    Slot Decay Per Second (number or null)
    workspace_id str
    Workspace ID (UUID)
    limit Number
    The maximum number of tasks that can run simultaneously.
    accountId String
    Account ID (UUID)
    active Boolean
    Whether the global concurrency limit is active.
    activeSlots Number
    The number of active slots.
    name String
    The name of the global concurrency limit.
    slotDecayPerSecond Number
    Slot Decay Per Second (number or null)
    workspaceId String
    Workspace ID (UUID)

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GlobalConcurrencyLimit 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 GlobalConcurrencyLimit Resource

    Get an existing GlobalConcurrencyLimit 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?: GlobalConcurrencyLimitState, opts?: CustomResourceOptions): GlobalConcurrencyLimit
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        active: Optional[bool] = None,
        active_slots: Optional[float] = None,
        created: Optional[str] = None,
        limit: Optional[float] = None,
        name: Optional[str] = None,
        slot_decay_per_second: Optional[float] = None,
        updated: Optional[str] = None,
        workspace_id: Optional[str] = None) -> GlobalConcurrencyLimit
    func GetGlobalConcurrencyLimit(ctx *Context, name string, id IDInput, state *GlobalConcurrencyLimitState, opts ...ResourceOption) (*GlobalConcurrencyLimit, error)
    public static GlobalConcurrencyLimit Get(string name, Input<string> id, GlobalConcurrencyLimitState? state, CustomResourceOptions? opts = null)
    public static GlobalConcurrencyLimit get(String name, Output<String> id, GlobalConcurrencyLimitState state, CustomResourceOptions options)
    resources:  _:    type: prefect:GlobalConcurrencyLimit    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)
    Active bool
    Whether the global concurrency limit is active.
    ActiveSlots double
    The number of active slots.
    Created string
    Timestamp of when the resource was created (RFC3339)
    Limit double
    The maximum number of tasks that can run simultaneously.
    Name string
    The name of the global concurrency limit.
    SlotDecayPerSecond double
    Slot Decay Per Second (number or null)
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    WorkspaceId string
    Workspace ID (UUID)
    AccountId string
    Account ID (UUID)
    Active bool
    Whether the global concurrency limit is active.
    ActiveSlots float64
    The number of active slots.
    Created string
    Timestamp of when the resource was created (RFC3339)
    Limit float64
    The maximum number of tasks that can run simultaneously.
    Name string
    The name of the global concurrency limit.
    SlotDecayPerSecond float64
    Slot Decay Per Second (number or null)
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    WorkspaceId string
    Workspace ID (UUID)
    accountId String
    Account ID (UUID)
    active Boolean
    Whether the global concurrency limit is active.
    activeSlots Double
    The number of active slots.
    created String
    Timestamp of when the resource was created (RFC3339)
    limit Double
    The maximum number of tasks that can run simultaneously.
    name String
    The name of the global concurrency limit.
    slotDecayPerSecond Double
    Slot Decay Per Second (number or null)
    updated String
    Timestamp of when the resource was updated (RFC3339)
    workspaceId String
    Workspace ID (UUID)
    accountId string
    Account ID (UUID)
    active boolean
    Whether the global concurrency limit is active.
    activeSlots number
    The number of active slots.
    created string
    Timestamp of when the resource was created (RFC3339)
    limit number
    The maximum number of tasks that can run simultaneously.
    name string
    The name of the global concurrency limit.
    slotDecayPerSecond number
    Slot Decay Per Second (number or null)
    updated string
    Timestamp of when the resource was updated (RFC3339)
    workspaceId string
    Workspace ID (UUID)
    account_id str
    Account ID (UUID)
    active bool
    Whether the global concurrency limit is active.
    active_slots float
    The number of active slots.
    created str
    Timestamp of when the resource was created (RFC3339)
    limit float
    The maximum number of tasks that can run simultaneously.
    name str
    The name of the global concurrency limit.
    slot_decay_per_second float
    Slot Decay Per Second (number or null)
    updated str
    Timestamp of when the resource was updated (RFC3339)
    workspace_id str
    Workspace ID (UUID)
    accountId String
    Account ID (UUID)
    active Boolean
    Whether the global concurrency limit is active.
    activeSlots Number
    The number of active slots.
    created String
    Timestamp of when the resource was created (RFC3339)
    limit Number
    The maximum number of tasks that can run simultaneously.
    name String
    The name of the global concurrency limit.
    slotDecayPerSecond Number
    Slot Decay Per Second (number or null)
    updated String
    Timestamp of when the resource was updated (RFC3339)
    workspaceId String
    Workspace ID (UUID)

    Import

    Prefect global concurrency limits can be imported via global_concurrency_limit_id

    $ pulumi import prefect:index/globalConcurrencyLimit:GlobalConcurrencyLimit example 00000000-0000-0000-0000-000000000000

    or from a different workspace via global_concurrency_limit_id,workspace_id

    $ pulumi import prefect:index/globalConcurrencyLimit:GlobalConcurrencyLimit example 00000000-0000-0000-0000-000000000000,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.3 published on Thursday, Mar 20, 2025 by prefecthq
    prefecthq/terraform-provider-prefect