aws-cdk-lib.aws_stepfunctions.MapJsonataProps

MapJsonataProps Struct

Properties for defining a Map state that using JSONata.

MapJsonataProps

extends

• StateBaseProps,
• MapBaseOptions,
• MapBaseJsonataOptions

Source

aws-stepfunctions/lib/states/map.ts

Type last changed

v2.178.0 · 6 Feb 2025

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,
  },
  jsonataItemSelector: 'jsonataItemSelector',
  jsonataMaxConcurrency: 'jsonataMaxConcurrency',
  maxConcurrency: 123,
  outputs: outputs,
  parameters: {
    parametersKey: parameters,
  },
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  stateName: 'stateName',
};

Properties

assign{ [key: string]: any }assigntyping.Mapping[str, Any]assignMap<String, Object>AssignIDictionary<string, object>Assign*map[string]interface{}= 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.

commentstringcommentstrcommentStringCommentstringComment*string= No comment#

A comment describing this state.

itemsProvideItemsitemsProvideItemsitemsProvideItemsItemsProvideItemsItemsProvideItems= The state input as is.#

The array that the Map state will iterate over.

itemSelector{ [key: string]: any }item_selectortyping.Mapping[str, Any]itemSelectorMap<String, Object>ItemSelectorIDictionary<string, object>ItemSelector*map[string]interface{}= $#

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

jsonataItemSelectorstringjsonata_item_selectorstrjsonataItemSelectorStringJsonataItemSelectorstringJsonataItemSelector*string= $#

Jsonata expression that evaluates to a JSON array to override your default iteration input (mutually exclusive with `parameters` and `itemSelector`).

Example value: {% {\"foo\": \"foo\", \"input\": $states.input} %}

jsonataMaxConcurrencystringjsonata_max_concurrencystrjsonataMaxConcurrencyStringJsonataMaxConcurrencystringJsonataMaxConcurrency*string= full concurrency#

JSONata expression for MaxConcurrency.

A JSONata expression that evaluates to an integer, specifying the maximum concurrency dynamically. Mutually exclusive with maxConcurrency and maxConcurrencyPath.

Example value: {% $states.input.maxConcurrency %}

maxConcurrencynumbermax_concurrencyint | floatmaxConcurrencyNumberMaxConcurrencydoubleMaxConcurrency*float64= full concurrency#

MaxConcurrency.

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

outputsanyoutputsAnyoutputsObjectOutputsobjectOutputsinterface{}= $states.result or $states.errorO…#

Used to specify and transform output from the state.

notes · default

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.

Default: $states.result or $states.errorOutput

parameters{ [key: string]: any }parameterstyping.Mapping[str, Any]parametersMap<String, Object>ParametersIDictionary<string, object>Parameters*map[string]interface{}= $deprecated#

Step Functions has deprecated the `parameters` field in favor of the new `itemSelector` field

queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= 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.

stateNamestringstate_namestrstateNameStringStateNamestringStateName*string= The construct ID will be used as…#

Optional name for this state.

default

Default: The construct ID will be used as state name