prefect 2.22.3, Mar 20 25

prefect 2.22.3 published on Thursday, Mar 20, 2025 by prefecthq

prefect.getDeployment

Explore with Pulumi AI

prefect 2.22.3 published on Thursday, Mar 20, 2025 by prefecthq

Using getDeployment

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 getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>

def get_deployment(account_id: Optional[str] = None,
                   flow_name: Optional[str] = None,
                   id: Optional[str] = None,
                   name: Optional[str] = None,
                   workspace_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(account_id: Optional[pulumi.Input[str]] = None,
                   flow_name: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   workspace_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]

func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput

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

public static class GetDeployment 
{
    public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)

fn::invoke:
  function: prefect:index/getDeployment:getDeployment
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountId string: Account ID (UUID), defaults to the account set in the provider
FlowName string: Flow name associated with the deployment
Id string: Deployment ID (UUID)
Name string: Name of the deployment
WorkspaceId string: Workspace ID (UUID) to associate deployment to

AccountId string: Account ID (UUID), defaults to the account set in the provider
FlowName string: Flow name associated with the deployment
Id string: Deployment ID (UUID)
Name string: Name of the deployment
WorkspaceId string: Workspace ID (UUID) to associate deployment to

accountId String: Account ID (UUID), defaults to the account set in the provider
flowName String: Flow name associated with the deployment
id String: Deployment ID (UUID)
name String: Name of the deployment
workspaceId String: Workspace ID (UUID) to associate deployment to

accountId string: Account ID (UUID), defaults to the account set in the provider
flowName string: Flow name associated with the deployment
id string: Deployment ID (UUID)
name string: Name of the deployment
workspaceId string: Workspace ID (UUID) to associate deployment to

account_id str: Account ID (UUID), defaults to the account set in the provider
flow_name str: Flow name associated with the deployment
id str: Deployment ID (UUID)
name str: Name of the deployment
workspace_id str: Workspace ID (UUID) to associate deployment to

accountId String: Account ID (UUID), defaults to the account set in the provider
flowName String: Flow name associated with the deployment
id String: Deployment ID (UUID)
name String: Name of the deployment
workspaceId String: Workspace ID (UUID) to associate deployment to

getDeployment Result

The following output properties are available:

AccountId string: Account ID (UUID), defaults to the account set in the provider
ConcurrencyLimit double: The deployment's concurrency limit.
ConcurrencyOptions GetDeploymentConcurrencyOptions: 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
FlowName string: Flow name associated with the deployment
Id string: Deployment ID (UUID)
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 deployment
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<GetDeploymentPullStep>: 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 GetDeploymentConcurrencyOptions: 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
FlowName string: Flow name associated with the deployment
Id string: Deployment ID (UUID)
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 deployment
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 []GetDeploymentPullStep: 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 GetDeploymentConcurrencyOptions: 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
flowName String: Flow name associated with the deployment
id String: Deployment ID (UUID)
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 deployment
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<GetDeploymentPullStep>: 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 GetDeploymentConcurrencyOptions: 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
flowName string: Flow name associated with the deployment
id string: Deployment ID (UUID)
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 deployment
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 GetDeploymentPullStep[]: 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 GetDeploymentConcurrencyOptions: 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
flow_name str: Flow name associated with the deployment
id str: Deployment ID (UUID)
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 deployment
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[GetDeploymentPullStep]: 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
flowName String: Flow name associated with the deployment
id String: Deployment ID (UUID)
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 deployment
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

GetDeploymentConcurrencyOptions

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.

GetDeploymentPullStep

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 string: 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 str: 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

Package Details

Repository: prefect prefecthq/terraform-provider-prefect
License
Notes: This Pulumi package is based on the prefect Terraform Provider.

prefect 2.22.3 published on Thursday, Mar 20, 2025 by prefecthq

prefecthq/terraform-provider-prefect

prefect.getDeployment

On this page

On this page

Using getDeployment

getDeployment Result

Supporting Types

GetDeploymentConcurrencyOptions

GetDeploymentPullStep

Package Details

On this page

On this page