Class Workflow

The Workflow construct sets up an AWS Step Functions workflow for a serverless project using projen. This construct extends the projen Component to generate a sample state machine definition file and corresponding TypeScript construct file.

Example

const workflow = new Workflow(app, {
workflowName: 'MyWorkflow',
definitionFile: 'statemachine/definition.json',
});

Hierarchy

  • Component
    • Workflow

Constructors

  • Creates an instance of Workflow.

    Parameters

    • app: AwsCdkTypeScriptApp

      The AWS CDK TypeScript app.

    • options: WorkflowOptions

      The options for configuring the Workflow.

    Returns Workflow

Properties

node: Node

The tree node.

The options for configuring the Workflow.

project: Project

Methods

  • Creates the construct file content for the generated Workflow.

    Parameters

    • file: FileBase

      The file object to create content for.

    Returns string

    The content of the construct file.

  • Called after synthesis. Order is not guaranteed.

    Returns void

  • Called before synthesis.

    Returns void

  • Renders the definition substitution for a given variable.

    Parameters

    • def: VariableDefinition

      The variable definition.

    Returns string

    The definition substitution string.

  • Renders the state configuration definition for a given variable.

    Parameters

    • def: VariableDefinition

      The variable definition.

    Returns string

    The state configuration definition string.

  • Synthesizes files to the project output directory.

    Returns void

  • Returns a string representation of this construct.

    Returns string

  • Test whether the given construct is a component.

    Parameters

    • x: any

    Returns x is Component

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

Generated using TypeDoc