Pass

The Pass state is internally used by the StepFunctions component to add a Pass workflow state to a state machine.

You’ll find this component returned by the pass method of the StepFunctions component.

Constructor

new Pass(args)

Type Record<string, any>

Store variables that can be accessed by any state later in the workflow, instead of passing it through each state.

This takes a set of key/value pairs. Where the key is the name of the variable that can be accessed by any subsequent state.

The value can be any JSON value; object, array, string, number, boolean, null.

{
  assign: {
    productName: "product1",
    count: 42,
    available: true
  }
}

Or, you can pass in a JSONata expression.

{
  assign: {
    product: "{% $states.input.order.product %}",
    currentPrice: "{% $states.result.Payload.current_price %}"
  }
}

Type string

The name of the state. This needs to be unique within the state machine.

Type Input<Record<string, any> | “{% ${string} %}”>

Transform the output of the state. When specified, the value overrides the default output from the state.

This takes any JSON value; object, array, string, number, boolean, null.

{
  output: {
    charged: true
  }
}

Or, you can pass in a JSONata expression.

{
  output: {
    product: "{% $states.input.product %}"
  }
}

next(state)

Returns State

Add a next state to the Pass state. After this state completes, it’ll transition to the given state.

sst.aws.StepFunctions.pass({
  // ...
})
.next(state);