AWS CDK Reference

Appearance

v2.274.0

DistributedMapJsonataProps Struct ​

Properties for configuring a Distribute Map state that using JSONata.

Source
aws-stepfunctions/lib/states/distributed-map.ts
Type last changed
v2.190.0 · 17 Apr 2025

Example ​

ts
// 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 itemBatcher: stepfunctions.ItemBatcher;
declare const itemReader: stepfunctions.IItemReader;
declare const itemSelector: any;
declare const outputs: any;
declare const provideItems: stepfunctions.ProvideItems;
declare const resultWriter: stepfunctions.ResultWriter;
declare const resultWriterV2: stepfunctions.ResultWriterV2;
const distributedMapJsonataProps: stepfunctions.DistributedMapJsonataProps = {
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  itemBatcher: itemBatcher,
  itemReader: itemReader,
  items: provideItems,
  itemSelector: {
    itemSelectorKey: itemSelector,
  },
  jsonataItemSelector: 'jsonataItemSelector',
  jsonataMaxConcurrency: 'jsonataMaxConcurrency',
  label: 'label',
  mapExecutionType: stepfunctions.StateMachineType.EXPRESS,
  maxConcurrency: 123,
  outputs: outputs,
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultWriter: resultWriter,
  resultWriterV2: resultWriterV2,
  stateName: 'stateName',
  toleratedFailureCount: 123,
  toleratedFailurePercentage: 123,
};

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.
itemBatcherItemBatcheritem_batcherItemBatcheritemBatcherItemBatcherItemBatcherItemBatcherItemBatcherItemBatcher= No itemBatcher#
Specifies to process a group of items in a single child workflow execution.
itemReaderIItemReaderitem_readerIItemReaderitemReaderIItemReaderItemReaderIItemReaderItemReaderIItemReader= No itemReader#
ItemReader.

Configuration for where to read items dataset in S3 to iterate

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 %}

labelstringlabelstrlabelStringLabelstringLabel*string= No label#
Label.

Unique name for the Distributed Map state added to each Map Run

mapExecutionTypeStateMachineTypemap_execution_typeStateMachineTypemapExecutionTypeStateMachineTypeMapExecutionTypeStateMachineTypeMapExecutionTypeStateMachineType= StateMachineType.STANDARD#
MapExecutionType.

The execution type of the distributed map state

This property overwrites ProcessorConfig.executionType

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

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.

resultWriterResultWriterresult_writerResultWriterresultWriterResultWriterResultWriterResultWriterResultWriterResultWriter= No resultWriterdeprecated#
Use {@link resultWriterV2 }
resultWriterV2ResultWriterV2result_writer_v2ResultWriterV2resultWriterV2ResultWriterV2ResultWriterV2ResultWriterV2ResultWriterV2ResultWriterV2= No resultWriterV2#
Configuration for S3 location in which to save Map Run results Enable "@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2" feature in the context to use resultWriterV2 Example: stack.node.setContext("@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2", true);
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

toleratedFailureCountnumbertolerated_failure_countint | floattoleratedFailureCountNumberToleratedFailureCountdoubleToleratedFailureCount*float64= No toleratedFailureCount#
ToleratedFailureCount.

Number of failed items to tolerate in a Map Run, as static number

toleratedFailurePercentagenumbertolerated_failure_percentageint | floattoleratedFailurePercentageNumberToleratedFailurePercentagedoubleToleratedFailurePercentage*float64= No toleratedFailurePercentage#
ToleratedFailurePercentage.

Percentage of failed items to tolerate in a Map Run, as static number