Skip to content
v2.277.0

MapBaseJsonPathOptions Struct ​

Base properties for defining a Map state that using JSONPath.

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 resultSelector: any;
const mapBaseJsonPathOptions: stepfunctions.MapBaseJsonPathOptions = {
  inputPath: 'inputPath',
  itemsPath: 'itemsPath',
  maxConcurrencyPath: 'maxConcurrencyPath',
  outputPath: 'outputPath',
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
};
python
# 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

# result_selector: Any

map_base_json_path_options = stepfunctions.MapBaseJsonPathOptions(
    input_path="inputPath",
    items_path="itemsPath",
    max_concurrency_path="maxConcurrencyPath",
    output_path="outputPath",
    result_path="resultPath",
    result_selector={
        "result_selector_key": result_selector
    }
)
java
// 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 resultSelector;

MapBaseJsonPathOptions mapBaseJsonPathOptions = MapBaseJsonPathOptions.builder()
        .inputPath("inputPath")
        .itemsPath("itemsPath")
        .maxConcurrencyPath("maxConcurrencyPath")
        .outputPath("outputPath")
        .resultPath("resultPath")
        .resultSelector(Map.of(
                "resultSelectorKey", resultSelector))
        .build();
csharp
// 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 resultSelector;

var mapBaseJsonPathOptions = new MapBaseJsonPathOptions {
    InputPath = "inputPath",
    ItemsPath = "itemsPath",
    MaxConcurrencyPath = "maxConcurrencyPath",
    OutputPath = "outputPath",
    ResultPath = "resultPath",
    ResultSelector = new Dictionary<string, object> {
        { "resultSelectorKey", resultSelector }
    }
};
go
// 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 resultSelector interface{}

mapBaseJsonPathOptions := &MapBaseJsonPathOptions{
	InputPath: jsii.String("inputPath"),
	ItemsPath: jsii.String("itemsPath"),
	MaxConcurrencyPath: jsii.String("maxConcurrencyPath"),
	OutputPath: jsii.String("outputPath"),
	ResultPath: jsii.String("resultPath"),
	ResultSelector: map[string]interface{}{
		"resultSelectorKey": resultSelector,
	},
}

Properties ​

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 {}.

itemsPathoptionalstringitems_pathoptionalstritemsPathoptionalStringItemsPathoptionalstringItemsPathoptional*string= $#
JSONPath expression to select the array to iterate over.
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 {}.

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.