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',
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions
# assign: Any
# item_batcher: stepfunctions.ItemBatcher
# item_reader: stepfunctions.IItemReader
# item_selector: Any
# result_selector: Any
# result_writer: stepfunctions.ResultWriter
# result_writer_v2: stepfunctions.ResultWriterV2
distributed_map_json_path_props = stepfunctions.DistributedMapJsonPathProps(
assign={
"assign_key": assign
},
comment="comment",
input_path="inputPath",
item_batcher=item_batcher,
item_reader=item_reader,
item_selector={
"item_selector_key": item_selector
},
items_path="itemsPath",
jsonata_item_selector="jsonataItemSelector",
jsonata_max_concurrency="jsonataMaxConcurrency",
label="label",
map_execution_type=stepfunctions.StateMachineType.EXPRESS,
max_concurrency=123,
max_concurrency_path="maxConcurrencyPath",
output_path="outputPath",
query_language=stepfunctions.QueryLanguage.JSON_PATH,
result_path="resultPath",
result_selector={
"result_selector_key": result_selector
},
result_writer=result_writer,
result_writer_v2=result_writer_v2,
state_name="stateName",
tolerated_failure_count=123,
tolerated_failure_count_path="toleratedFailureCountPath",
tolerated_failure_percentage=123,
tolerated_failure_percentage_path="toleratedFailurePercentagePath"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.stepfunctions.*;
Object assign;
ItemBatcher itemBatcher;
IItemReader itemReader;
Object itemSelector;
Object resultSelector;
ResultWriter resultWriter;
ResultWriterV2 resultWriterV2;
DistributedMapJsonPathProps distributedMapJsonPathProps = DistributedMapJsonPathProps.builder()
.assign(Map.of(
"assignKey", assign))
.comment("comment")
.inputPath("inputPath")
.itemBatcher(itemBatcher)
.itemReader(itemReader)
.itemSelector(Map.of(
"itemSelectorKey", itemSelector))
.itemsPath("itemsPath")
.jsonataItemSelector("jsonataItemSelector")
.jsonataMaxConcurrency("jsonataMaxConcurrency")
.label("label")
.mapExecutionType(StateMachineType.EXPRESS)
.maxConcurrency(123)
.maxConcurrencyPath("maxConcurrencyPath")
.outputPath("outputPath")
.queryLanguage(QueryLanguage.JSON_PATH)
.resultPath("resultPath")
.resultSelector(Map.of(
"resultSelectorKey", resultSelector))
.resultWriter(resultWriter)
.resultWriterV2(resultWriterV2)
.stateName("stateName")
.toleratedFailureCount(123)
.toleratedFailureCountPath("toleratedFailureCountPath")
.toleratedFailurePercentage(123)
.toleratedFailurePercentagePath("toleratedFailurePercentagePath")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.StepFunctions;
var assign;
ItemBatcher itemBatcher;
IItemReader itemReader;
var itemSelector;
var resultSelector;
ResultWriter resultWriter;
ResultWriterV2 resultWriterV2;
var distributedMapJsonPathProps = new DistributedMapJsonPathProps {
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
Comment = "comment",
InputPath = "inputPath",
ItemBatcher = itemBatcher,
ItemReader = itemReader,
ItemSelector = new Dictionary<string, object> {
{ "itemSelectorKey", itemSelector }
},
ItemsPath = "itemsPath",
JsonataItemSelector = "jsonataItemSelector",
JsonataMaxConcurrency = "jsonataMaxConcurrency",
Label = "label",
MapExecutionType = StateMachineType.EXPRESS,
MaxConcurrency = 123,
MaxConcurrencyPath = "maxConcurrencyPath",
OutputPath = "outputPath",
QueryLanguage = QueryLanguage.JSON_PATH,
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
ResultWriter = resultWriter,
ResultWriterV2 = resultWriterV2,
StateName = "stateName",
ToleratedFailureCount = 123,
ToleratedFailureCountPath = "toleratedFailureCountPath",
ToleratedFailurePercentage = 123,
ToleratedFailurePercentagePath = "toleratedFailurePercentagePath"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var assign interface{}
var itemBatcher ItemBatcher
var itemReader IItemReader
var itemSelector interface{}
var resultSelector interface{}
var resultWriter ResultWriter
var resultWriterV2 ResultWriterV2
distributedMapJsonPathProps := &DistributedMapJsonPathProps{
Assign: map[string]interface{}{
"assignKey": assign,
},
Comment: jsii.String("comment"),
InputPath: jsii.String("inputPath"),
ItemBatcher: itemBatcher,
ItemReader: itemReader,
ItemSelector: map[string]interface{}{
"itemSelectorKey": itemSelector,
},
ItemsPath: jsii.String("itemsPath"),
JsonataItemSelector: jsii.String("jsonataItemSelector"),
JsonataMaxConcurrency: jsii.String("jsonataMaxConcurrency"),
Label: jsii.String("label"),
MapExecutionType: awscdk.Aws_stepfunctions.StateMachineType_EXPRESS,
MaxConcurrency: jsii.Number(123),
MaxConcurrencyPath: jsii.String("maxConcurrencyPath"),
OutputPath: jsii.String("outputPath"),
QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
ResultPath: jsii.String("resultPath"),
ResultSelector: map[string]interface{}{
"resultSelectorKey": resultSelector,
},
ResultWriter: resultWriter,
ResultWriterV2: resultWriterV2,
StateName: jsii.String("stateName"),
ToleratedFailureCount: jsii.Number(123),
ToleratedFailureCountPath: jsii.String("toleratedFailureCountPath"),
ToleratedFailurePercentage: jsii.Number(123),
ToleratedFailurePercentagePath: jsii.String("toleratedFailurePercentagePath"),
}
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
inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string= $#May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
itemBatcheroptionalItemBatcheritem_batcheroptionalItemBatcheritemBatcheroptionalItemBatcherItemBatcheroptionalItemBatcherItemBatcheroptionalItemBatcher#Default: No itemBatcher
itemReaderoptionalIItemReaderitem_readeroptionalIItemReaderitemReaderoptionalIItemReaderItemReaderoptionalIItemReaderItemReaderoptionalIItemReader#Default: No itemReader
Configuration for where to read items dataset in S3 to iterate
itemSelectoroptional{ [key: string]: any }item_selectoroptionaltyping.Mapping[str, Any]itemSelectoroptionalMap<String, Object>ItemSelectoroptionalIDictionary<string, object>ItemSelectoroptional*map[string]interface{}= $#itemsPathoptionalstringitems_pathoptionalstritemsPathoptionalStringItemsPathoptionalstringItemsPathoptional*string= $#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.
maxConcurrencyPathoptionalstringmax_concurrency_pathoptionalstrmaxConcurrencyPathoptionalStringMaxConcurrencyPathoptionalstringMaxConcurrencyPathoptional*string#Default: full concurrency
A JsonPath that specifies the maximum concurrency dynamically from the state input.
outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string= $#May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
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.
resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string= $#May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*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.
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
toleratedFailureCountPathoptionalstringtolerated_failure_count_pathoptionalstrtoleratedFailureCountPathoptionalStringToleratedFailureCountPathoptionalstringToleratedFailureCountPathoptional*string#Default: No toleratedFailureCountPath
Number of failed items to tolerate in a Map Run, as JsonPath
toleratedFailurePercentageoptionalnumbertolerated_failure_percentageoptionalint | floattoleratedFailurePercentageoptionalNumberToleratedFailurePercentageoptionaldoubleToleratedFailurePercentageoptional*float64#Default: No toleratedFailurePercentage
Percentage of failed items to tolerate in a Map Run, as static number
toleratedFailurePercentagePathoptionalstringtolerated_failure_percentage_pathoptionalstrtoleratedFailurePercentagePathoptionalStringToleratedFailurePercentagePathoptionalstringToleratedFailurePercentagePathoptional*string#Default: No toleratedFailurePercentagePath
Percentage of failed items to tolerate in a Map Run, as JsonPath