software.amazon.awscdk.services.stepfunctions

Interface MapProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MapProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-02-19T00:19:34.318Z")
 @Stability(value=Stable)
public interface MapProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a Map state.

Example:

 Map map = Map.Builder.create(this, "Map State")
         .maxConcurrency(1)
         .itemsPath(JsonPath.stringAt("$.inputForMap"))
         .build();
 map.iterator(new Pass(this, "Pass State"));
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static MapProps.Builder	builder()
default String	getComment() An optional description for this state.
default String	getInputPath() JSONPath expression to select part of the state to be the input to this state.
default String	getItemsPath() JSONPath expression to select the array to iterate over.
default Number	getMaxConcurrency() MaxConcurrency.
default String	getOutputPath() JSONPath expression to select part of the state to be the output to this state.
default Map<String,Object>	getParameters() The JSON that you want to override your default iteration input.
default String	getResultPath() JSONPath expression to indicate where to inject the state's output.
default Map<String,Object>	getResultSelector() The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getComment

@Stability(value=Stable)
 @Nullable
default String getComment()

An optional description for this state.

Default: No comment

getInputPath

@Stability(value=Stable)
 @Nullable
default String getInputPath()

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

Default: $

getItemsPath

@Stability(value=Stable)
 @Nullable
default String getItemsPath()

JSONPath expression to select the array to iterate over.

Default: $

getMaxConcurrency

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

MaxConcurrency.

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

Default: - full concurrency

getOutputPath

@Stability(value=Stable)
 @Nullable
default String getOutputPath()

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

Default: $

getParameters

@Stability(value=Stable)
 @Nullable
default Map<String,Object> getParameters()

The JSON that you want to override your default iteration input.

Default: $

getResultPath

@Stability(value=Stable)
 @Nullable
default String getResultPath()

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.

Default: $

getResultSelector

@Stability(value=Stable)
 @Nullable
default Map<String,Object> getResultSelector()

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.

Default: - None

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

builder

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

Returns:

a MapProps.Builder of MapProps