Interface MapProps
- All Superinterfaces:
AssignableStateOptions
,software.amazon.jsii.JsiiSerializable
,JsonataCommonOptions
,JsonPathCommonOptions
,MapBaseJsonataOptions
,MapBaseJsonPathOptions
,MapBaseOptions
,MapBaseProps
,StateBaseProps
- All Known Implementing Classes:
MapProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
date="2025-03-19T18:01:43.168Z")
@Stability(Stable)
public interface MapProps
extends software.amazon.jsii.JsiiSerializable, MapBaseProps, MapBaseOptions
Properties for defining a Map state.
Example:
Map map = Map.Builder.create(this, "Map State") .maxConcurrency(1) .itemsPath(JsonPath.stringAt("$.inputForMap")) .itemSelector(Map.of( "item", JsonPath.stringAt("$.Map.Item.Value"))) .resultPath("$.mapOutput") .build(); // The Map iterator can contain a IChainable, which can be an individual or multiple steps chained together. // Below example is with a Choice and Pass step Choice choice = new Choice(this, "Choice"); Condition condition1 = Condition.stringEquals("$.item.status", "SUCCESS"); Pass step1 = new Pass(this, "Step1"); Pass step2 = new Pass(this, "Step2"); Pass finish = new Pass(this, "Finish"); Chain definition = choice.when(condition1, step1).otherwise(step2).afterwards().next(finish); map.itemProcessor(definition);
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic MapProps.Builder
builder()
Workflow variables to store in this step.The JSON that you want to override your default iteration input (mutually exclusive withparameters
).default Number
MaxConcurrency.Deprecated.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataCommonOptions
getOutputs
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions
getInputPath, getOutputPath
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.MapBaseJsonataOptions
getItems
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.MapBaseJsonPathOptions
getItemsPath, getMaxConcurrencyPath, getResultPath, getResultSelector
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateName
-
Method Details
-
getParameters
Deprecated.Step Functions has deprecated theparameters
field in favor of the newitemSelector
field(deprecated) The JSON that you want to override your default iteration input (mutually exclusive withitemSelector
).Default: $
- See Also:
-
getItemSelector
The JSON that you want to override your default iteration input (mutually exclusive withparameters
).Default: $
- Specified by:
getItemSelector
in interfaceMapBaseOptions
- See Also:
-
getMaxConcurrency
MaxConcurrency.An upper bound on the number of iterations you want running at once.
Default: - full concurrency
- Specified by:
getMaxConcurrency
in interfaceMapBaseOptions
- See Also:
-
getAssign
Workflow variables to store in this step.Using workflow variables, you can store data in a step and retrieve that data in future steps.
Default: - Not assign variables
- Specified by:
getAssign
in interfaceAssignableStateOptions
- See Also:
-
builder
- Returns:
- a
MapProps.Builder
ofMapProps
-
parameters
field in favor of the newitemSelector
field