# DistributedMapJsonPathProps

Properties for configuring a Distribute Map state that using JSONPath.

Extends: DistributedMapJsonPathProps
Extends: StateBaseProps, MapBaseOptions, MapBaseJsonPathOptions

- Source: [`aws-stepfunctions/lib/states/distributed-map.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-stepfunctions/lib/states/distributed-map.ts#L114)
- 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 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 } = 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.

- `comment`: string = No comment — A comment describing this state.

- `inputPath`: 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 {}.

- `itemBatcher`: [ItemBatcher](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.ItemBatcher.html) = No itemBatcher — Specifies to process a group of items in a single child workflow execution.

- `itemReader`: [IItemReader](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.IItemReader.html) = No itemReader — ItemReader.

  Configuration for where to read items dataset in S3 to iterate

- `itemSelector`: { [key: string]: any } = $ — The JSON that you want to override your default iteration input (mutually exclusive with `parameters` and `jsonataItemSelector`).

- `itemsPath`: string = $ — JSONPath expression to select the array to iterate over.

- `jsonataItemSelector`: 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} %}`

- `jsonataMaxConcurrency`: 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 %}`

- `label`: string = No label — Label.

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

- `mapExecutionType`: [StateMachineType](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachineType.html) = StateMachineType.STANDARD — MapExecutionType.

  The execution type of the distributed map state

  This property overwrites ProcessorConfig.executionType

- `maxConcurrency`: number = full concurrency — MaxConcurrency.

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

- `maxConcurrencyPath`: string = full concurrency — MaxConcurrencyPath.

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

- `outputPath`: 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 {}.

- `queryLanguage`: [QueryLanguage](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.QueryLanguage.html) = 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.

- `resultPath`: 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.

- `resultSelector`: { [key: string]: any } = 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.

- `resultWriter`: [ResultWriter](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.ResultWriter.html) = No resultWriter — Use {@link resultWriterV2 }

- `resultWriterV2`: [ResultWriterV2](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.ResultWriterV2.html) = 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);

- `stateName`: string = The construct ID will be used as state name — Optional name for this state.

  **Default:** The construct ID will be used as state name

- `toleratedFailureCount`: number = No toleratedFailureCount — ToleratedFailureCount.

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

- `toleratedFailureCountPath`: string = No toleratedFailureCountPath — ToleratedFailureCountPath.

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

- `toleratedFailurePercentage`: number = No toleratedFailurePercentage — ToleratedFailurePercentage.

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

- `toleratedFailurePercentagePath`: string = No toleratedFailurePercentagePath — ToleratedFailurePercentagePath.

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

  **Default:** No toleratedFailurePercentagePath