Package software.amazon.awscdk.services.stepfunctions

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.113.0 (build fc68b25)",
           date="2025-09-02T11:25:41.138Z")
@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();
 map.itemProcessor(new Pass(this, "Pass State"), ProcessorConfig.builder()
         .mode(ProcessorMode.DISTRIBUTED)
         .executionType(ProcessorType.STANDARD)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	MapProps.Builder	A builder for MapProps
static final class	MapProps.Jsii$Proxy	An implementation for MapProps

Method Summary

Modifier and Type	Method	Description
static MapProps.Builder	builder()
default Map<String,Object>	getAssign()	Workflow variables to store in this step.
default Map<String,Object>	getItemSelector()	The JSON that you want to override your default iteration input (mutually exclusive with parameters and jsonataItemSelector).
default String	getJsonataItemSelector()	Jsonata expression that evaluates to a JSON array to override your default iteration input (mutually exclusive with parameters and itemSelector).
default Number	getMaxConcurrency()	MaxConcurrency.
default Map<String,Object>	getParameters()	Deprecated. Step Functions has deprecated the parameters field in favor of the new itemSelector field

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

@Stability(Deprecated)
@Deprecated
@Nullable
default Map<String,Object> getParameters()

Deprecated.

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

(deprecated) The JSON that you want to override your default iteration input (mutually exclusive with itemSelector).

Default: $

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-itemselector.html

getItemSelector

@Stability(Stable)
@Nullable
default Map<String,Object> getItemSelector()

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

Default: $

Specified by:

getItemSelector in interface MapBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-itemselector.html

getJsonataItemSelector

@Stability(Stable)
@Nullable
default String getJsonataItemSelector()

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

Default: $

Specified by:

getJsonataItemSelector in interface MapBaseOptions

getMaxConcurrency

@Stability(Stable)
@Nullable
default Number getMaxConcurrency()

MaxConcurrency.

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

Default: - full concurrency

Specified by:

getMaxConcurrency in interface MapBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-asl-use-map-state-inline.html#map-state-inline-additional-fields

getAssign

@Stability(Stable)
@Nullable
default Map<String,Object> 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 interface AssignableStateOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

builder

@Stability(Stable)
static MapProps.Builder builder()

Returns:

a MapProps.Builder of MapProps