DistributedMapJsonataProps Struct
Properties for configuring a Distribute 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 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
assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#Default: No comment
itemBatcheroptionalItemBatcheritem_batcheroptionalItemBatcheritemBatcheroptionalItemBatcherItemBatcheroptionalItemBatcherItemBatcheroptionalItemBatcher#Default: No itemBatcher
itemReaderoptionalIItemReaderitem_readeroptionalIItemReaderitemReaderoptionalIItemReaderItemReaderoptionalIItemReaderItemReaderoptionalIItemReader#Default: No itemReader
Configuration for where to read items dataset in S3 to iterate
itemsoptionalProvideItemsitemsoptionalProvideItemsitemsoptionalProvideItemsItemsoptionalProvideItemsItemsoptionalProvideItems#Default: The state input as is.
itemSelectoroptional{ [key: string]: any }item_selectoroptionaltyping.Mapping[str, Any]itemSelectoroptionalMap<String, Object>ItemSelectoroptionalIDictionary<string, object>ItemSelectoroptional*map[string]interface{}= $#jsonataItemSelectoroptionalstringjsonata_item_selectoroptionalstrjsonataItemSelectoroptionalStringJsonataItemSelectoroptionalstringJsonataItemSelectoroptional*string= $#Example value: {% {\"foo\": \"foo\", \"input\": $states.input} %}
jsonataMaxConcurrencyoptionalstringjsonata_max_concurrencyoptionalstrjsonataMaxConcurrencyoptionalStringJsonataMaxConcurrencyoptionalstringJsonataMaxConcurrencyoptional*string#Default: full concurrency
A JSONata expression that evaluates to an integer, specifying the maximum concurrency dynamically. Mutually exclusive with maxConcurrency and maxConcurrencyPath.
Example value: {% $states.input.maxConcurrency %}
Default: No label
Unique name for the Distributed Map state added to each Map Run
mapExecutionTypeoptionalStateMachineTypemap_execution_typeoptionalStateMachineTypemapExecutionTypeoptionalStateMachineTypeMapExecutionTypeoptionalStateMachineTypeMapExecutionTypeoptionalStateMachineType= StateMachineType.STANDARD#The execution type of the distributed map state
This property overwrites ProcessorConfig.executionType
maxConcurrencyoptionalnumbermax_concurrencyoptionalint | floatmaxConcurrencyoptionalNumberMaxConcurrencyoptionaldoubleMaxConcurrencyoptional*float64#Default: full concurrency
An upper bound on the number of iterations you want running at once.
outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{}#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.
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= JSONPath#If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
resultWriteroptionalResultWriterresult_writeroptionalResultWriterresultWriteroptionalResultWriterResultWriteroptionalResultWriterResultWriteroptionalResultWriterdeprecated#Default: No resultWriter
resultWriterV2optionalResultWriterV2result_writer_v2optionalResultWriterV2resultWriterV2optionalResultWriterV2ResultWriterV2optionalResultWriterV2ResultWriterV2optionalResultWriterV2#Default: No resultWriterV2
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#Default: The construct ID will be used as state name
toleratedFailureCountoptionalnumbertolerated_failure_countoptionalint | floattoleratedFailureCountoptionalNumberToleratedFailureCountoptionaldoubleToleratedFailureCountoptional*float64#Default: No toleratedFailureCount
Number of failed items to tolerate in a Map Run, as static number
toleratedFailurePercentageoptionalnumbertolerated_failure_percentageoptionalint | floattoleratedFailurePercentageoptionalNumberToleratedFailurePercentageoptionaldoubleToleratedFailurePercentageoptional*float64#Default: No toleratedFailurePercentage
Percentage of failed items to tolerate in a Map Run, as static number