aws-cdk-lib.aws_stepfunctions.PassJsonataProps

PassJsonataProps Struct

Properties for defining a Pass state that using JSONata.

PassJsonataProps

extends

• StateBaseProps,
• AssignableStateOptions,
• JsonataCommonOptions

Source

aws-stepfunctions/lib/states/pass.ts

Type last changed

v2.178.0 · 6 Feb 2025

Example

// JSONata Pattern
sfn.Pass.jsonata(this, 'JSONata Pattern', {
  outputs: { foo: 'bar' },
  // The outputPath does not exist in the props type
  // outputPath: '$.status',
});

// JSONPath Pattern
sfn.Pass.jsonPath(this, 'JSONPath Pattern', {
  // The outputs does not exist in the props type
  // outputs: { foo: 'bar' },
  outputPath: '$.status',
});

// Constructor (Legacy) Pattern
new sfn.Pass(this, 'Constructor Pattern', {
  queryLanguage: sfn.QueryLanguage.JSONATA, // or JSON_PATH
  // Both outputs and outputPath exist as prop types.
  outputs: { foo: 'bar' }, // For JSONata
  // or
  outputPath: '$.status', // For JSONPath
});

Properties

assign?optional{ [key: string]: any }assign?optionaltyping.Mapping[str, Any]assign?optionalMap<String, Object>Assign?optionalIDictionary<string, object>Assign?optional*map[string]interface{}#

Workflow variables to store in this step.

Default: Not assign variables

Using workflow variables, you can store data in a step and retrieve that data in future steps.

comment?optionalstringcomment?optionalstrcomment?optionalStringComment?optionalstringComment?optional*string#

A comment describing this state.

Default: No comment

outputs?optionalanyoutputs?optionalAnyoutputs?optionalObjectOutputs?optionalobjectOutputs?optionalinterface{}#

Used to specify and transform output from the state.

Default: $states.result or $states.errorOutput

notes

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

queryLanguage?optionalQueryLanguagequery_language?optionalQueryLanguagequeryLanguage?optionalQueryLanguageQueryLanguage?optionalQueryLanguageQueryLanguage?optionalQueryLanguage= JSONPath#

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

stateName?optionalstringstate_name?optionalstrstateName?optionalStringStateName?optionalstringStateName?optional*string#

Optional name for this state.

Default: The construct ID will be used as state name