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

prefect.Deployment

Explore with Pulumi AI

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

    Import

    Prefect Deployments can be imported via deployment_id

    $ pulumi import prefect:index/deployment:Deployment example 00000000-0000-0000-0000-000000000000

    or from a different workspace via deployment_id,workspace_id

    $ pulumi import prefect:index/deployment:Deployment example 00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000

    Create Deployment Resource

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

    Constructor syntax

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

@overload
def Deployment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               flow_id: Optional[str] = None,
               parameter_openapi_schema: Optional[str] = None,
               work_pool_name: Optional[str] = None,
               description: Optional[str] = None,
               enforce_parameter_schema: Optional[bool] = None,
               entrypoint: Optional[str] = None,
               concurrency_limit: Optional[float] = None,
               job_variables: Optional[str] = None,
               parameters: Optional[str] = None,
               workspace_id: Optional[str] = None,
               concurrency_options: Optional[DeploymentConcurrencyOptionsArgs] = None,
               manifest_path: Optional[str] = None,
               path: Optional[str] = None,
               paused: Optional[bool] = None,
               pull_steps: Optional[Sequence[DeploymentPullStepArgs]] = None,
               storage_document_id: Optional[str] = None,
               tags: Optional[Sequence[str]] = None,
               version: Optional[str] = None,
               account_id: Optional[str] = None,
               work_queue_name: Optional[str] = None,
               name: Optional[str] = None)
    func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
    public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
    public Deployment(String name, DeploymentArgs args)
public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)

    type: prefect:Deployment
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 DeploymentArgs
    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 DeploymentArgs
    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 DeploymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeploymentArgs
    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 deploymentResource = new Prefect.Deployment("deploymentResource", new()
{
    FlowId = "string",
    ParameterOpenapiSchema = "string",
    WorkPoolName = "string",
    Description = "string",
    EnforceParameterSchema = false,
    Entrypoint = "string",
    ConcurrencyLimit = 0,
    JobVariables = "string",
    Parameters = "string",
    WorkspaceId = "string",
    ConcurrencyOptions = new Prefect.Inputs.DeploymentConcurrencyOptionsArgs
    {
        CollisionStrategy = "string",
    },
    ManifestPath = "string",
    Path = "string",
    Paused = false,
    PullSteps = new[]
    {
        new Prefect.Inputs.DeploymentPullStepArgs
        {
            Type = "string",
            AccessToken = "string",
            Branch = "string",
            Bucket = "string",
            Credentials = "string",
            Directory = "string",
            Folder = "string",
            IncludeSubmodules = false,
            Repository = "string",
            Requires = "string",
        },
    },
    StorageDocumentId = "string",
    Tags = new[]
    {
        "string",
    },
    Version = "string",
    AccountId = "string",
    WorkQueueName = "string",
    Name = "string",
});

    example, err := prefect.NewDeployment(ctx, "deploymentResource", &prefect.DeploymentArgs{
FlowId: pulumi.String("string"),
ParameterOpenapiSchema: pulumi.String("string"),
WorkPoolName: pulumi.String("string"),
Description: pulumi.String("string"),
EnforceParameterSchema: pulumi.Bool(false),
Entrypoint: pulumi.String("string"),
ConcurrencyLimit: pulumi.Float64(0),
JobVariables: pulumi.String("string"),
Parameters: pulumi.String("string"),
WorkspaceId: pulumi.String("string"),
ConcurrencyOptions: &.DeploymentConcurrencyOptionsArgs{
CollisionStrategy: pulumi.String("string"),
},
ManifestPath: pulumi.String("string"),
Path: pulumi.String("string"),
Paused: pulumi.Bool(false),
PullSteps: .DeploymentPullStepArray{
&.DeploymentPullStepArgs{
Type: pulumi.String("string"),
AccessToken: pulumi.String("string"),
Branch: pulumi.String("string"),
Bucket: pulumi.String("string"),
Credentials: pulumi.String("string"),
Directory: pulumi.String("string"),
Folder: pulumi.String("string"),
IncludeSubmodules: pulumi.Bool(false),
Repository: pulumi.String("string"),
Requires: pulumi.String("string"),
},
},
StorageDocumentId: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Version: pulumi.String("string"),
AccountId: pulumi.String("string"),
WorkQueueName: pulumi.String("string"),
Name: pulumi.String("string"),
})

    var deploymentResource = new Deployment("deploymentResource", DeploymentArgs.builder()
    .flowId("string")
    .parameterOpenapiSchema("string")
    .workPoolName("string")
    .description("string")
    .enforceParameterSchema(false)
    .entrypoint("string")
    .concurrencyLimit(0)
    .jobVariables("string")
    .parameters("string")
    .workspaceId("string")
    .concurrencyOptions(DeploymentConcurrencyOptionsArgs.builder()
        .collisionStrategy("string")
        .build())
    .manifestPath("string")
    .path("string")
    .paused(false)
    .pullSteps(DeploymentPullStepArgs.builder()
        .type("string")
        .accessToken("string")
        .branch("string")
        .bucket("string")
        .credentials("string")
        .directory("string")
        .folder("string")
        .includeSubmodules(false)
        .repository("string")
        .requires("string")
        .build())
    .storageDocumentId("string")
    .tags("string")
    .version("string")
    .accountId("string")
    .workQueueName("string")
    .name("string")
    .build());

    deployment_resource = prefect.Deployment("deploymentResource",
    flow_id="string",
    parameter_openapi_schema="string",
    work_pool_name="string",
    description="string",
    enforce_parameter_schema=False,
    entrypoint="string",
    concurrency_limit=0,
    job_variables="string",
    parameters="string",
    workspace_id="string",
    concurrency_options={
        "collision_strategy": "string",
    },
    manifest_path="string",
    path="string",
    paused=False,
    pull_steps=[{
        "type": "string",
        "access_token": "string",
        "branch": "string",
        "bucket": "string",
        "credentials": "string",
        "directory": "string",
        "folder": "string",
        "include_submodules": False,
        "repository": "string",
        "requires": "string",
    }],
    storage_document_id="string",
    tags=["string"],
    version="string",
    account_id="string",
    work_queue_name="string",
    name="string")

    const deploymentResource = new prefect.Deployment("deploymentResource", {
    flowId: "string",
    parameterOpenapiSchema: "string",
    workPoolName: "string",
    description: "string",
    enforceParameterSchema: false,
    entrypoint: "string",
    concurrencyLimit: 0,
    jobVariables: "string",
    parameters: "string",
    workspaceId: "string",
    concurrencyOptions: {
        collisionStrategy: "string",
    },
    manifestPath: "string",
    path: "string",
    paused: false,
    pullSteps: [{
        type: "string",
        accessToken: "string",
        branch: "string",
        bucket: "string",
        credentials: "string",
        directory: "string",
        folder: "string",
        includeSubmodules: false,
        repository: "string",
        requires: "string",
    }],
    storageDocumentId: "string",
    tags: ["string"],
    version: "string",
    accountId: "string",
    workQueueName: "string",
    name: "string",
});

    type: prefect:Deployment
properties:
    accountId: string
    concurrencyLimit: 0
    concurrencyOptions:
        collisionStrategy: string
    description: string
    enforceParameterSchema: false
    entrypoint: string
    flowId: string
    jobVariables: string
    manifestPath: string
    name: string
    parameterOpenapiSchema: string
    parameters: string
    path: string
    paused: false
    pullSteps:
        - accessToken: string
          branch: string
          bucket: string
          credentials: string
          directory: string
          folder: string
          includeSubmodules: false
          repository: string
          requires: string
          type: string
    storageDocumentId: string
    tags:
        - string
    version: string
    workPoolName: string
    workQueueName: string
    workspaceId: string

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

    FlowId string
    Flow ID (UUID) to associate deployment to
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    ConcurrencyLimit double
    The deployment's concurrency limit.
    ConcurrencyOptions DeploymentConcurrencyOptions
    Concurrency options for the deployment.
    Description string
    A description for the deployment.
    EnforceParameterSchema bool
    Whether or not the deployment should enforce the parameter schema.
    Entrypoint string
    The path to the entrypoint for the workflow, relative to the path.
    JobVariables string
    Overrides for the flow's infrastructure configuration.
    ManifestPath string
    The path to the flow's manifest file, relative to the chosen storage.
    Name string
    Name of the workspace
    ParameterOpenapiSchema string
    The parameter schema of the flow, including defaults.
    Parameters string
    Parameters for flow runs scheduled by the deployment.
    Path string
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    Paused bool
    Whether or not the deployment is paused.
    PullSteps List<DeploymentPullStep>
    Pull steps to prepare flows for a deployment run.
    StorageDocumentId string
    ID of the associated storage document (UUID)
    Tags List<string>
    Tags associated with the deployment
    Version string
    An optional version for the deployment.
    WorkPoolName string
    The name of the deployment's work pool.
    WorkQueueName string
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    WorkspaceId string
    Workspace ID (UUID) to associate deployment to
    FlowId string
    Flow ID (UUID) to associate deployment to
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    ConcurrencyLimit float64
    The deployment's concurrency limit.
    ConcurrencyOptions DeploymentConcurrencyOptionsArgs
    Concurrency options for the deployment.
    Description string
    A description for the deployment.
    EnforceParameterSchema bool
    Whether or not the deployment should enforce the parameter schema.
    Entrypoint string
    The path to the entrypoint for the workflow, relative to the path.
    JobVariables string
    Overrides for the flow's infrastructure configuration.
    ManifestPath string
    The path to the flow's manifest file, relative to the chosen storage.
    Name string
    Name of the workspace
    ParameterOpenapiSchema string
    The parameter schema of the flow, including defaults.
    Parameters string
    Parameters for flow runs scheduled by the deployment.
    Path string
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    Paused bool
    Whether or not the deployment is paused.
    PullSteps []DeploymentPullStepArgs
    Pull steps to prepare flows for a deployment run.
    StorageDocumentId string
    ID of the associated storage document (UUID)
    Tags []string
    Tags associated with the deployment
    Version string
    An optional version for the deployment.
    WorkPoolName string
    The name of the deployment's work pool.
    WorkQueueName string
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    WorkspaceId string
    Workspace ID (UUID) to associate deployment to
    flowId String
    Flow ID (UUID) to associate deployment to
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit Double
    The deployment's concurrency limit.
    concurrencyOptions DeploymentConcurrencyOptions
    Concurrency options for the deployment.
    description String
    A description for the deployment.
    enforceParameterSchema Boolean
    Whether or not the deployment should enforce the parameter schema.
    entrypoint String
    The path to the entrypoint for the workflow, relative to the path.
    jobVariables String
    Overrides for the flow's infrastructure configuration.
    manifestPath String
    The path to the flow's manifest file, relative to the chosen storage.
    name String
    Name of the workspace
    parameterOpenapiSchema String
    The parameter schema of the flow, including defaults.
    parameters String
    Parameters for flow runs scheduled by the deployment.
    path String
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    paused Boolean
    Whether or not the deployment is paused.
    pullSteps List<DeploymentPullStep>
    Pull steps to prepare flows for a deployment run.
    storageDocumentId String
    ID of the associated storage document (UUID)
    tags List<String>
    Tags associated with the deployment
    version String
    An optional version for the deployment.
    workPoolName String
    The name of the deployment's work pool.
    workQueueName String
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    workspaceId String
    Workspace ID (UUID) to associate deployment to
    flowId string
    Flow ID (UUID) to associate deployment to
    accountId string
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit number
    The deployment's concurrency limit.
    concurrencyOptions DeploymentConcurrencyOptions
    Concurrency options for the deployment.
    description string
    A description for the deployment.
    enforceParameterSchema boolean
    Whether or not the deployment should enforce the parameter schema.
    entrypoint string
    The path to the entrypoint for the workflow, relative to the path.
    jobVariables string
    Overrides for the flow's infrastructure configuration.
    manifestPath string
    The path to the flow's manifest file, relative to the chosen storage.
    name string
    Name of the workspace
    parameterOpenapiSchema string
    The parameter schema of the flow, including defaults.
    parameters string
    Parameters for flow runs scheduled by the deployment.
    path string
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    paused boolean
    Whether or not the deployment is paused.
    pullSteps DeploymentPullStep[]
    Pull steps to prepare flows for a deployment run.
    storageDocumentId string
    ID of the associated storage document (UUID)
    tags string[]
    Tags associated with the deployment
    version string
    An optional version for the deployment.
    workPoolName string
    The name of the deployment's work pool.
    workQueueName string
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    workspaceId string
    Workspace ID (UUID) to associate deployment to
    flow_id str
    Flow ID (UUID) to associate deployment to
    account_id str
    Account ID (UUID), defaults to the account set in the provider
    concurrency_limit float
    The deployment's concurrency limit.
    concurrency_options DeploymentConcurrencyOptionsArgs
    Concurrency options for the deployment.
    description str
    A description for the deployment.
    enforce_parameter_schema bool
    Whether or not the deployment should enforce the parameter schema.
    entrypoint str
    The path to the entrypoint for the workflow, relative to the path.
    job_variables str
    Overrides for the flow's infrastructure configuration.
    manifest_path str
    The path to the flow's manifest file, relative to the chosen storage.
    name str
    Name of the workspace
    parameter_openapi_schema str
    The parameter schema of the flow, including defaults.
    parameters str
    Parameters for flow runs scheduled by the deployment.
    path str
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    paused bool
    Whether or not the deployment is paused.
    pull_steps Sequence[DeploymentPullStepArgs]
    Pull steps to prepare flows for a deployment run.
    storage_document_id str
    ID of the associated storage document (UUID)
    tags Sequence[str]
    Tags associated with the deployment
    version str
    An optional version for the deployment.
    work_pool_name str
    The name of the deployment's work pool.
    work_queue_name str
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    workspace_id str
    Workspace ID (UUID) to associate deployment to
    flowId String
    Flow ID (UUID) to associate deployment to
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit Number
    The deployment's concurrency limit.
    concurrencyOptions Property Map
    Concurrency options for the deployment.
    description String
    A description for the deployment.
    enforceParameterSchema Boolean
    Whether or not the deployment should enforce the parameter schema.
    entrypoint String
    The path to the entrypoint for the workflow, relative to the path.
    jobVariables String
    Overrides for the flow's infrastructure configuration.
    manifestPath String
    The path to the flow's manifest file, relative to the chosen storage.
    name String
    Name of the workspace
    parameterOpenapiSchema String
    The parameter schema of the flow, including defaults.
    parameters String
    Parameters for flow runs scheduled by the deployment.
    path String
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    paused Boolean
    Whether or not the deployment is paused.
    pullSteps List<Property Map>
    Pull steps to prepare flows for a deployment run.
    storageDocumentId String
    ID of the associated storage document (UUID)
    tags List<String>
    Tags associated with the deployment
    version String
    An optional version for the deployment.
    workPoolName String
    The name of the deployment's work pool.
    workQueueName String
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    workspaceId String
    Workspace ID (UUID) to associate deployment to

    Outputs

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

    Get an existing Deployment 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?: DeploymentState, opts?: CustomResourceOptions): Deployment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        concurrency_limit: Optional[float] = None,
        concurrency_options: Optional[DeploymentConcurrencyOptionsArgs] = None,
        created: Optional[str] = None,
        description: Optional[str] = None,
        enforce_parameter_schema: Optional[bool] = None,
        entrypoint: Optional[str] = None,
        flow_id: Optional[str] = None,
        job_variables: Optional[str] = None,
        manifest_path: Optional[str] = None,
        name: Optional[str] = None,
        parameter_openapi_schema: Optional[str] = None,
        parameters: Optional[str] = None,
        path: Optional[str] = None,
        paused: Optional[bool] = None,
        pull_steps: Optional[Sequence[DeploymentPullStepArgs]] = None,
        storage_document_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        updated: Optional[str] = None,
        version: Optional[str] = None,
        work_pool_name: Optional[str] = None,
        work_queue_name: Optional[str] = None,
        workspace_id: Optional[str] = None) -> Deployment
    func GetDeployment(ctx *Context, name string, id IDInput, state *DeploymentState, opts ...ResourceOption) (*Deployment, error)
    public static Deployment Get(string name, Input<string> id, DeploymentState? state, CustomResourceOptions? opts = null)
    public static Deployment get(String name, Output<String> id, DeploymentState state, CustomResourceOptions options)
    resources:  _:    type: prefect:Deployment    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 deployment's concurrency limit.
    ConcurrencyOptions DeploymentConcurrencyOptions
    Concurrency options for the deployment.
    Created string
    Timestamp of when the resource was created (RFC3339)
    Description string
    A description for the deployment.
    EnforceParameterSchema bool
    Whether or not the deployment should enforce the parameter schema.
    Entrypoint string
    The path to the entrypoint for the workflow, relative to the path.
    FlowId string
    Flow ID (UUID) to associate deployment to
    JobVariables string
    Overrides for the flow's infrastructure configuration.
    ManifestPath string
    The path to the flow's manifest file, relative to the chosen storage.
    Name string
    Name of the workspace
    ParameterOpenapiSchema string
    The parameter schema of the flow, including defaults.
    Parameters string
    Parameters for flow runs scheduled by the deployment.
    Path string
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    Paused bool
    Whether or not the deployment is paused.
    PullSteps List<DeploymentPullStep>
    Pull steps to prepare flows for a deployment run.
    StorageDocumentId string
    ID of the associated storage document (UUID)
    Tags List<string>
    Tags associated with the deployment
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    Version string
    An optional version for the deployment.
    WorkPoolName string
    The name of the deployment's work pool.
    WorkQueueName string
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    WorkspaceId string
    Workspace ID (UUID) to associate deployment to
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    ConcurrencyLimit float64
    The deployment's concurrency limit.
    ConcurrencyOptions DeploymentConcurrencyOptionsArgs
    Concurrency options for the deployment.
    Created string
    Timestamp of when the resource was created (RFC3339)
    Description string
    A description for the deployment.
    EnforceParameterSchema bool
    Whether or not the deployment should enforce the parameter schema.
    Entrypoint string
    The path to the entrypoint for the workflow, relative to the path.
    FlowId string
    Flow ID (UUID) to associate deployment to
    JobVariables string
    Overrides for the flow's infrastructure configuration.
    ManifestPath string
    The path to the flow's manifest file, relative to the chosen storage.
    Name string
    Name of the workspace
    ParameterOpenapiSchema string
    The parameter schema of the flow, including defaults.
    Parameters string
    Parameters for flow runs scheduled by the deployment.
    Path string
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    Paused bool
    Whether or not the deployment is paused.
    PullSteps []DeploymentPullStepArgs
    Pull steps to prepare flows for a deployment run.
    StorageDocumentId string
    ID of the associated storage document (UUID)
    Tags []string
    Tags associated with the deployment
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    Version string
    An optional version for the deployment.
    WorkPoolName string
    The name of the deployment's work pool.
    WorkQueueName string
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    WorkspaceId string
    Workspace ID (UUID) to associate deployment to
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit Double
    The deployment's concurrency limit.
    concurrencyOptions DeploymentConcurrencyOptions
    Concurrency options for the deployment.
    created String
    Timestamp of when the resource was created (RFC3339)
    description String
    A description for the deployment.
    enforceParameterSchema Boolean
    Whether or not the deployment should enforce the parameter schema.
    entrypoint String
    The path to the entrypoint for the workflow, relative to the path.
    flowId String
    Flow ID (UUID) to associate deployment to
    jobVariables String
    Overrides for the flow's infrastructure configuration.
    manifestPath String
    The path to the flow's manifest file, relative to the chosen storage.
    name String
    Name of the workspace
    parameterOpenapiSchema String
    The parameter schema of the flow, including defaults.
    parameters String
    Parameters for flow runs scheduled by the deployment.
    path String
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    paused Boolean
    Whether or not the deployment is paused.
    pullSteps List<DeploymentPullStep>
    Pull steps to prepare flows for a deployment run.
    storageDocumentId String
    ID of the associated storage document (UUID)
    tags List<String>
    Tags associated with the deployment
    updated String
    Timestamp of when the resource was updated (RFC3339)
    version String
    An optional version for the deployment.
    workPoolName String
    The name of the deployment's work pool.
    workQueueName String
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    workspaceId String
    Workspace ID (UUID) to associate deployment to
    accountId string
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit number
    The deployment's concurrency limit.
    concurrencyOptions DeploymentConcurrencyOptions
    Concurrency options for the deployment.
    created string
    Timestamp of when the resource was created (RFC3339)
    description string
    A description for the deployment.
    enforceParameterSchema boolean
    Whether or not the deployment should enforce the parameter schema.
    entrypoint string
    The path to the entrypoint for the workflow, relative to the path.
    flowId string
    Flow ID (UUID) to associate deployment to
    jobVariables string
    Overrides for the flow's infrastructure configuration.
    manifestPath string
    The path to the flow's manifest file, relative to the chosen storage.
    name string
    Name of the workspace
    parameterOpenapiSchema string
    The parameter schema of the flow, including defaults.
    parameters string
    Parameters for flow runs scheduled by the deployment.
    path string
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    paused boolean
    Whether or not the deployment is paused.
    pullSteps DeploymentPullStep[]
    Pull steps to prepare flows for a deployment run.
    storageDocumentId string
    ID of the associated storage document (UUID)
    tags string[]
    Tags associated with the deployment
    updated string
    Timestamp of when the resource was updated (RFC3339)
    version string
    An optional version for the deployment.
    workPoolName string
    The name of the deployment's work pool.
    workQueueName string
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    workspaceId string
    Workspace ID (UUID) to associate deployment to
    account_id str
    Account ID (UUID), defaults to the account set in the provider
    concurrency_limit float
    The deployment's concurrency limit.
    concurrency_options DeploymentConcurrencyOptionsArgs
    Concurrency options for the deployment.
    created str
    Timestamp of when the resource was created (RFC3339)
    description str
    A description for the deployment.
    enforce_parameter_schema bool
    Whether or not the deployment should enforce the parameter schema.
    entrypoint str
    The path to the entrypoint for the workflow, relative to the path.
    flow_id str
    Flow ID (UUID) to associate deployment to
    job_variables str
    Overrides for the flow's infrastructure configuration.
    manifest_path str
    The path to the flow's manifest file, relative to the chosen storage.
    name str
    Name of the workspace
    parameter_openapi_schema str
    The parameter schema of the flow, including defaults.
    parameters str
    Parameters for flow runs scheduled by the deployment.
    path str
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    paused bool
    Whether or not the deployment is paused.
    pull_steps Sequence[DeploymentPullStepArgs]
    Pull steps to prepare flows for a deployment run.
    storage_document_id str
    ID of the associated storage document (UUID)
    tags Sequence[str]
    Tags associated with the deployment
    updated str
    Timestamp of when the resource was updated (RFC3339)
    version str
    An optional version for the deployment.
    work_pool_name str
    The name of the deployment's work pool.
    work_queue_name str
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    workspace_id str
    Workspace ID (UUID) to associate deployment to
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    concurrencyLimit Number
    The deployment's concurrency limit.
    concurrencyOptions Property Map
    Concurrency options for the deployment.
    created String
    Timestamp of when the resource was created (RFC3339)
    description String
    A description for the deployment.
    enforceParameterSchema Boolean
    Whether or not the deployment should enforce the parameter schema.
    entrypoint String
    The path to the entrypoint for the workflow, relative to the path.
    flowId String
    Flow ID (UUID) to associate deployment to
    jobVariables String
    Overrides for the flow's infrastructure configuration.
    manifestPath String
    The path to the flow's manifest file, relative to the chosen storage.
    name String
    Name of the workspace
    parameterOpenapiSchema String
    The parameter schema of the flow, including defaults.
    parameters String
    Parameters for flow runs scheduled by the deployment.
    path String
    The path to the working directory for the workflow, relative to remote storage or an absolute path.
    paused Boolean
    Whether or not the deployment is paused.
    pullSteps List<Property Map>
    Pull steps to prepare flows for a deployment run.
    storageDocumentId String
    ID of the associated storage document (UUID)
    tags List<String>
    Tags associated with the deployment
    updated String
    Timestamp of when the resource was updated (RFC3339)
    version String
    An optional version for the deployment.
    workPoolName String
    The name of the deployment's work pool.
    workQueueName String
    The work queue for the deployment. If no work queue is set, work will not be scheduled.
    workspaceId String
    Workspace ID (UUID) to associate deployment to

    Supporting Types

    DeploymentConcurrencyOptions, DeploymentConcurrencyOptionsArgs

    CollisionStrategy string
    Enumeration of concurrency collision strategies.
    CollisionStrategy string
    Enumeration of concurrency collision strategies.
    collisionStrategy String
    Enumeration of concurrency collision strategies.
    collisionStrategy string
    Enumeration of concurrency collision strategies.
    collision_strategy str
    Enumeration of concurrency collision strategies.
    collisionStrategy String
    Enumeration of concurrency collision strategies.

    DeploymentPullStep, DeploymentPullStepArgs

    Type string
    The type of pull step
    AccessToken string
    (For type 'git_clone') Access token for the repository. Refer to a credentials block for security purposes. Used in leiu of 'credentials'.
    Branch string
    (For type 'git_clone') The branch to clone. If not provided, the default branch is used.
    Bucket string
    (For type 'pull*from**') The name of the bucket where files are stored.
    Credentials string
    Credentials to use for the pull step. Refer to a {GitHub,GitLab,BitBucket} credentials block.
    Directory string
    (For type 'setworkingdirectory') The directory to set as the working directory.
    Folder string
    (For type 'pull*from**') The folder in the bucket where files are stored.
    IncludeSubmodules bool
    (For type 'git_clone') Whether to include submodules when cloning the repository.
    Repository string
    (For type 'git_clone') The URL of the repository to clone.
    Requires string
    A list of Python package dependencies.
    Type string
    The type of pull step
    AccessToken string
    (For type 'git_clone') Access token for the repository. Refer to a credentials block for security purposes. Used in leiu of 'credentials'.
    Branch string
    (For type 'git_clone') The branch to clone. If not provided, the default branch is used.
    Bucket string
    (For type 'pull*from**') The name of the bucket where files are stored.
    Credentials string
    Credentials to use for the pull step. Refer to a {GitHub,GitLab,BitBucket} credentials block.
    Directory string
    (For type 'setworkingdirectory') The directory to set as the working directory.
    Folder string
    (For type 'pull*from**') The folder in the bucket where files are stored.
    IncludeSubmodules bool
    (For type 'git_clone') Whether to include submodules when cloning the repository.
    Repository string
    (For type 'git_clone') The URL of the repository to clone.
    Requires string
    A list of Python package dependencies.
    type String
    The type of pull step
    accessToken String
    (For type 'git_clone') Access token for the repository. Refer to a credentials block for security purposes. Used in leiu of 'credentials'.
    branch String
    (For type 'git_clone') The branch to clone. If not provided, the default branch is used.
    bucket String
    (For type 'pull*from**') The name of the bucket where files are stored.
    credentials String
    Credentials to use for the pull step. Refer to a {GitHub,GitLab,BitBucket} credentials block.
    directory String
    (For type 'setworkingdirectory') The directory to set as the working directory.
    folder String
    (For type 'pull*from**') The folder in the bucket where files are stored.
    includeSubmodules Boolean
    (For type 'git_clone') Whether to include submodules when cloning the repository.
    repository String
    (For type 'git_clone') The URL of the repository to clone.
    requires String
    A list of Python package dependencies.
    type string
    The type of pull step
    accessToken string
    (For type 'git_clone') Access token for the repository. Refer to a credentials block for security purposes. Used in leiu of 'credentials'.
    branch string
    (For type 'git_clone') The branch to clone. If not provided, the default branch is used.
    bucket string
    (For type 'pull*from**') The name of the bucket where files are stored.
    credentials string
    Credentials to use for the pull step. Refer to a {GitHub,GitLab,BitBucket} credentials block.
    directory string
    (For type 'setworkingdirectory') The directory to set as the working directory.
    folder string
    (For type 'pull*from**') The folder in the bucket where files are stored.
    includeSubmodules boolean
    (For type 'git_clone') Whether to include submodules when cloning the repository.
    repository string
    (For type 'git_clone') The URL of the repository to clone.
    requires string
    A list of Python package dependencies.
    type str
    The type of pull step
    access_token str
    (For type 'git_clone') Access token for the repository. Refer to a credentials block for security purposes. Used in leiu of 'credentials'.
    branch str
    (For type 'git_clone') The branch to clone. If not provided, the default branch is used.
    bucket str
    (For type 'pull*from**') The name of the bucket where files are stored.
    credentials str
    Credentials to use for the pull step. Refer to a {GitHub,GitLab,BitBucket} credentials block.
    directory str
    (For type 'setworkingdirectory') The directory to set as the working directory.
    folder str
    (For type 'pull*from**') The folder in the bucket where files are stored.
    include_submodules bool
    (For type 'git_clone') Whether to include submodules when cloning the repository.
    repository str
    (For type 'git_clone') The URL of the repository to clone.
    requires str
    A list of Python package dependencies.
    type String
    The type of pull step
    accessToken String
    (For type 'git_clone') Access token for the repository. Refer to a credentials block for security purposes. Used in leiu of 'credentials'.
    branch String
    (For type 'git_clone') The branch to clone. If not provided, the default branch is used.
    bucket String
    (For type 'pull*from**') The name of the bucket where files are stored.
    credentials String
    Credentials to use for the pull step. Refer to a {GitHub,GitLab,BitBucket} credentials block.
    directory String
    (For type 'setworkingdirectory') The directory to set as the working directory.
    folder String
    (For type 'pull*from**') The folder in the bucket where files are stored.
    includeSubmodules Boolean
    (For type 'git_clone') Whether to include submodules when cloning the repository.
    repository String
    (For type 'git_clone') The URL of the repository to clone.
    requires String
    A list of Python package dependencies.

    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