MapJsonPathProps Struct

Properties for defining a Map state that using JSONPath.

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 parameters: any;
declare const resultSelector: any;
const mapJsonPathProps: stepfunctions.MapJsonPathProps = {
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  inputPath: 'inputPath',
  itemSelector: {
    itemSelectorKey: itemSelector,
  },
  itemsPath: 'itemsPath',
  jsonataItemSelector: 'jsonataItemSelector',
  jsonataMaxConcurrency: 'jsonataMaxConcurrency',
  maxConcurrency: 123,
  maxConcurrencyPath: 'maxConcurrencyPath',
  outputPath: 'outputPath',
  parameters: {
    parametersKey: parameters,
  },
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  stateName: 'stateName',
};

Properties

assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#

Workflow variables to store in this step.

Default: Not assign variables

Using workflow variables, you can store data in a step and retrieve that data in future steps.

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#

A comment describing this state.

Default: No comment

inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string= $#

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

itemSelectoroptional{ [key: string]: any }item_selectoroptionaltyping.Mapping[str, Any]itemSelectoroptionalMap<String, Object>ItemSelectoroptionalIDictionary<string, object>ItemSelectoroptional*map[string]interface{}= $#

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

itemsPathoptionalstringitems_pathoptionalstritemsPathoptionalStringItemsPathoptionalstringItemsPathoptional*string= $#

JSONPath expression to select the array to iterate over.

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

jsonataMaxConcurrencyoptionalstringjsonata_max_concurrencyoptionalstrjsonataMaxConcurrencyoptionalStringJsonataMaxConcurrencyoptionalstringJsonataMaxConcurrencyoptional*string#

JSONata expression for MaxConcurrency.

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

maxConcurrencyoptionalnumbermax_concurrencyoptionalint | floatmaxConcurrencyoptionalNumberMaxConcurrencyoptionaldoubleMaxConcurrencyoptional*float64#

MaxConcurrency.

Default: full concurrency

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

maxConcurrencyPathoptionalstringmax_concurrency_pathoptionalstrmaxConcurrencyPathoptionalStringMaxConcurrencyPathoptionalstringMaxConcurrencyPathoptional*string#

MaxConcurrencyPath.

Default: full concurrency

A JsonPath that specifies the maximum concurrency dynamically from the state input.

outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string= $#

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

parametersoptional{ [key: string]: any }parametersoptionaltyping.Mapping[str, Any]parametersoptionalMap<String, Object>ParametersoptionalIDictionary<string, object>Parametersoptional*map[string]interface{}= $deprecated#

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

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

resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string= $#

JSONPath expression to indicate where to inject the state's output.

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#

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#

Optional name for this state.

Default: The construct ID will be used as state name

MapJsonPathProps Struct ​

Example ​

Properties ​

MapJsonPathProps Struct

Example

Properties