DistributedMapJsonPathProps Struct
Properties for configuring a Distribute Map state that using JSONPath.
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 resultSelector: any;
declare const resultWriter: stepfunctions.ResultWriter;
declare const resultWriterV2: stepfunctions.ResultWriterV2;
const distributedMapJsonPathProps: stepfunctions.DistributedMapJsonPathProps = {
assign: {
assignKey: assign,
},
comment: 'comment',
inputPath: 'inputPath',
itemBatcher: itemBatcher,
itemReader: itemReader,
itemSelector: {
itemSelectorKey: itemSelector,
},
itemsPath: 'itemsPath',
jsonataItemSelector: 'jsonataItemSelector',
jsonataMaxConcurrency: 'jsonataMaxConcurrency',
label: 'label',
mapExecutionType: stepfunctions.StateMachineType.EXPRESS,
maxConcurrency: 123,
maxConcurrencyPath: 'maxConcurrencyPath',
outputPath: 'outputPath',
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
resultPath: 'resultPath',
resultSelector: {
resultSelectorKey: resultSelector,
},
resultWriter: resultWriter,
resultWriterV2: resultWriterV2,
stateName: 'stateName',
toleratedFailureCount: 123,
toleratedFailureCountPath: 'toleratedFailureCountPath',
toleratedFailurePercentage: 123,
toleratedFailurePercentagePath: 'toleratedFailurePercentagePath',
};
Properties
assign{ [key: string]: any }assigntyping.Mapping[str, Any]assignMap<String, Object>AssignIDictionary<string, object>Assign*map[string]interface{}= Not assign variables#Using workflow variables, you can store data in a step and retrieve that data in future steps.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
itemBatcherItemBatcheritem_batcherItemBatcheritemBatcherItemBatcherItemBatcherItemBatcherItemBatcherItemBatcher= No itemBatcher#itemReaderIItemReaderitem_readerIItemReaderitemReaderIItemReaderItemReaderIItemReaderItemReaderIItemReader= No itemReader#Configuration for where to read items dataset in S3 to iterate
itemSelector{ [key: string]: any }item_selectortyping.Mapping[str, Any]itemSelectorMap<String, Object>ItemSelectorIDictionary<string, object>ItemSelector*map[string]interface{}= $#jsonataItemSelectorstringjsonata_item_selectorstrjsonataItemSelectorStringJsonataItemSelectorstringJsonataItemSelector*string= $#Example value: {% {\"foo\": \"foo\", \"input\": $states.input} %}
jsonataMaxConcurrencystringjsonata_max_concurrencystrjsonataMaxConcurrencyStringJsonataMaxConcurrencystringJsonataMaxConcurrency*string= 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 %}
Unique name for the Distributed Map state added to each Map Run
mapExecutionTypeStateMachineTypemap_execution_typeStateMachineTypemapExecutionTypeStateMachineTypeMapExecutionTypeStateMachineTypeMapExecutionTypeStateMachineType= StateMachineType.STANDARD#The execution type of the distributed map state
This property overwrites ProcessorConfig.executionType
maxConcurrencynumbermax_concurrencyint | floatmaxConcurrencyNumberMaxConcurrencydoubleMaxConcurrency*float64= full concurrency#An upper bound on the number of iterations you want running at once.
maxConcurrencyPathstringmax_concurrency_pathstrmaxConcurrencyPathStringMaxConcurrencyPathstringMaxConcurrencyPath*string= full concurrency#A JsonPath that specifies the maximum concurrency dynamically from the state input.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= JSONPath#If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelector{ [key: string]: any }result_selectortyping.Mapping[str, Any]resultSelectorMap<String, Object>ResultSelectorIDictionary<string, object>ResultSelector*map[string]interface{}= None#You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
resultWriterResultWriterresult_writerResultWriterresultWriterResultWriterResultWriterResultWriterResultWriterResultWriter= No resultWriterdeprecated#resultWriterV2ResultWriterV2result_writer_v2ResultWriterV2resultWriterV2ResultWriterV2ResultWriterV2ResultWriterV2ResultWriterV2ResultWriterV2= No resultWriterV2#stateNamestringstate_namestrstateNameStringStateNamestringStateName*string= The construct ID will be used as…#default
Default: The construct ID will be used as state name
toleratedFailureCountnumbertolerated_failure_countint | floattoleratedFailureCountNumberToleratedFailureCountdoubleToleratedFailureCount*float64= No toleratedFailureCount#Number of failed items to tolerate in a Map Run, as static number
toleratedFailureCountPathstringtolerated_failure_count_pathstrtoleratedFailureCountPathStringToleratedFailureCountPathstringToleratedFailureCountPath*string= No toleratedFailureCountPath#Number of failed items to tolerate in a Map Run, as JsonPath
toleratedFailurePercentagenumbertolerated_failure_percentageint | floattoleratedFailurePercentageNumberToleratedFailurePercentagedoubleToleratedFailurePercentage*float64= No toleratedFailurePercentage#Percentage of failed items to tolerate in a Map Run, as static number
toleratedFailurePercentagePathstringtolerated_failure_percentage_pathstrtoleratedFailurePercentagePathStringToleratedFailurePercentagePathstringToleratedFailurePercentagePath*string= No toleratedFailurePercentagePat…#Percentage of failed items to tolerate in a Map Run, as JsonPath
default
Default: No toleratedFailurePercentagePath