interface MapJsonataProps

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

Properties for defining a Map 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 assign: any;
declare const itemSelector: any;
declare const outputs: any;
declare const parameters: any;
declare const provideItems: stepfunctions.ProvideItems;
const mapJsonataProps: stepfunctions.MapJsonataProps = {
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  items: provideItems,
  itemSelector: {
    itemSelectorKey: itemSelector,
  },
  maxConcurrency: 123,
  outputs: outputs,
  parameters: {
    parametersKey: parameters,
  },
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  stateName: 'stateName',
};

Properties

Name	Type	Description
assign?	{ [string]: any }	Workflow variables to store in this step.
comment?	string	A comment describing this state.
itemSelector?	{ [string]: any }	The JSON that you want to override your default iteration input (mutually exclusive with parameters).
items?	ProvideItems	The array that the Map state will iterate over.
maxConcurrency?	number	MaxConcurrency.
outputs?	any	Used to specify and transform output from the state.
parameters?⚠️	{ [string]: any }	The JSON that you want to override your default iteration input (mutually exclusive with itemSelector).
queryLanguage?	QueryLanguage	The name of the query language used by the state.
stateName?	string	Optional name for this state.

---

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.

---

itemSelector?

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

The JSON that you want to override your default iteration input (mutually exclusive with parameters).

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

---

items?

Type: ProvideItems (optional, default: The state input as is.)

The array that the Map state will iterate over.

---

maxConcurrency?

Type: number (optional, default: full concurrency)

MaxConcurrency.

An upper bound on the number of iterations you want running at once.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-asl-use-map-state-inline.html#map-state-inline-additional-fields

---

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

---

parameters?⚠️

⚠️ Deprecated: Step Functions has deprecated the parameters field in favor of the new itemSelector field

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

The JSON that you want to override your default iteration input (mutually exclusive with itemSelector).

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-itemselector.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.