port.Workflow

Create Workflow Resource

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

Constructor syntax

new Workflow(name: string, args: WorkflowArgs, opts?: CustomResourceOptions);

@overload
def Workflow(resource_name: str,
             args: WorkflowArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Workflow(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             identifier: Optional[str] = None,
             allow_anyone_to_view_runs: Optional[bool] = None,
             category: Optional[str] = None,
             connections: Optional[Sequence[WorkflowConnectionArgs]] = None,
             description: Optional[str] = None,
             icon: Optional[str] = None,
             nodes: Optional[Sequence[WorkflowNodeArgs]] = None,
             title: Optional[str] = None)

func NewWorkflow(ctx *Context, name string, args WorkflowArgs, opts ...ResourceOption) (*Workflow, error)

public Workflow(string name, WorkflowArgs args, CustomResourceOptions? opts = null)

public Workflow(String name, WorkflowArgs args)
public Workflow(String name, WorkflowArgs args, CustomResourceOptions options)

type: port:Workflow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "port_workflow" "name" {
    # resource properties
}

Parameters

Workflow Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Workflow resource accepts the following input properties:

Outputs

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

Look up Existing Workflow Resource

Get an existing Workflow 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?: WorkflowState, opts?: CustomResourceOptions): Workflow

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_anyone_to_view_runs: Optional[bool] = None,
        category: Optional[str] = None,
        connections: Optional[Sequence[WorkflowConnectionArgs]] = None,
        description: Optional[str] = None,
        icon: Optional[str] = None,
        identifier: Optional[str] = None,
        nodes: Optional[Sequence[WorkflowNodeArgs]] = None,
        title: Optional[str] = None) -> Workflow

func GetWorkflow(ctx *Context, name string, id IDInput, state *WorkflowState, opts ...ResourceOption) (*Workflow, error)

public static Workflow Get(string name, Input<string> id, WorkflowState? state, CustomResourceOptions? opts = null)

public static Workflow get(String name, Output<String> id, WorkflowState state, CustomResourceOptions options)

resources:  _:    type: port:Workflow    get:      id: ${id}

import {
  to = port_workflow.example
  id = "${id}"
}

Supporting Types

WorkflowConnection, WorkflowConnectionArgs

WorkflowNode, WorkflowNodeArgs

WorkflowNodeAi, WorkflowNodeAiArgs

WorkflowNodeAiAgent, WorkflowNodeAiAgentArgs

WorkflowNodeAiMcpServer, WorkflowNodeAiMcpServerArgs

WorkflowNodeCondition, WorkflowNodeConditionArgs

WorkflowNodeConditionOutlet, WorkflowNodeConditionOutletArgs

WorkflowNodeConditionOutletStatusLabel, WorkflowNodeConditionOutletStatusLabelArgs

WorkflowNodeConditionOutletWorkflowStatusLabel, WorkflowNodeConditionOutletWorkflowStatusLabelArgs

WorkflowNodeEventTrigger, WorkflowNodeEventTriggerArgs

WorkflowNodeEventTriggerCondition, WorkflowNodeEventTriggerConditionArgs

WorkflowNodeInput, WorkflowNodeInputArgs

WorkflowNodeInputNotification, WorkflowNodeInputNotificationArgs

WorkflowNodeInputNotificationField, WorkflowNodeInputNotificationFieldArgs

WorkflowNodeInputOutlet, WorkflowNodeInputOutletArgs

WorkflowNodeInputOutletStatusLabel, WorkflowNodeInputOutletStatusLabelArgs

WorkflowNodeInputOutletWorkflowStatusLabel, WorkflowNodeInputOutletWorkflowStatusLabelArgs

WorkflowNodeInputResponders, WorkflowNodeInputRespondersArgs

WorkflowNodeInputUserInputs, WorkflowNodeInputUserInputsArgs

WorkflowNodeInputUserInputsButton, WorkflowNodeInputUserInputsButtonArgs

WorkflowNodeInputUserInputsStep, WorkflowNodeInputUserInputsStepArgs

WorkflowNodeInputUserInputsStepValidation, WorkflowNodeInputUserInputsStepValidationArgs

WorkflowNodeInputUserInputsTitles, WorkflowNodeInputUserInputsTitlesArgs