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.110.0 (build 336b265)",
date="2025-04-22T23:08:21.341Z")
@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.Builderbuilder()Workflow variables to store in this step.The JSON that you want to override your default iteration input (mutually exclusive withparameters).default NumberMaxConcurrency.Deprecated.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataCommonOptions
getOutputsMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions
getInputPath, getOutputPathMethods inherited from interface software.amazon.awscdk.services.stepfunctions.MapBaseJsonataOptions
getItemsMethods inherited from interface software.amazon.awscdk.services.stepfunctions.MapBaseJsonPathOptions
getItemsPath, getMaxConcurrencyPath, getResultPath, getResultSelectorMethods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateName
-
Method Details
-
getParameters
Deprecated.Step Functions has deprecated theparametersfield in favor of the newitemSelectorfield(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:
getItemSelectorin interfaceMapBaseOptions- See Also:
-
getMaxConcurrency
MaxConcurrency.An upper bound on the number of iterations you want running at once.
Default: - full concurrency
- Specified by:
getMaxConcurrencyin 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:
getAssignin interfaceAssignableStateOptions- See Also:
-
builder
- Returns:
- a
MapProps.BuilderofMapProps
-
parametersfield in favor of the newitemSelectorfield