interface ParallelJsonataProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.ParallelJsonataProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#ParallelJsonataProps
Java	software.amazon.awscdk.services.stepfunctions.ParallelJsonataProps
Python	aws_cdk.aws_stepfunctions.ParallelJsonataProps
TypeScript (source)	aws-cdk-lib » aws_stepfunctions » ParallelJsonataProps

Properties for defining a Parallel state that using JSONata.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';

declare const arguments_: any;
declare const assign: any;
declare const outputs: any;
const parallelJsonataProps: stepfunctions.ParallelJsonataProps = {
  arguments: {
    argumentsKey: arguments_,
  },
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  outputs: outputs,
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  stateName: 'stateName',
};

Properties

Name	Type	Description
arguments?	{ [string]: any }	Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.
assign?	{ [string]: any }	Workflow variables to store in this step.
comment?	string	A comment describing this state.
outputs?	any	Used to specify and transform output from the state.
queryLanguage?	QueryLanguage	The name of the query language used by the state.
stateName?	string	Optional name for this state.

---

arguments?

Type: { [string]: any } (optional, default: No arguments)

Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/transforming-data.html

---

assign?

Type: { [string]: any } (optional, default: Not assign variables)

Workflow variables to store in this step.

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

See also: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

---

comment?

Type: string (optional, default: No comment)

A comment describing this state.

---

outputs?

Type: any (optional, default: $states.result or $states.errorOutput)

Used to specify and transform output from the state.

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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

---

queryLanguage?

Type: QueryLanguage (optional, default: 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?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.