Package 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.89.0 (build 2f74b3e)", date="2023-11-02T10:21:24.297Z") @Stability(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"))
         .parameters(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.iterator(definition);

  • Method Details

    • getComment

      @Stability(Stable) @Nullable default String getComment()
      An optional description for this state.

      Default: No comment

    • getInputPath

      @Stability(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(Stable) @Nullable default String getItemsPath()
      JSONPath expression to select the array to iterate over.

      Default: $

    • getMaxConcurrency

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

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

      Default: - full concurrency

    • getOutputPath

      @Stability(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(Stable) @Nullable default Map<String,Object> getParameters()
      The JSON that you want to override your default iteration input.

      Default: $

    • getResultPath

      @Stability(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(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:

    • getStateName

      @Stability(Stable) @Nullable default String getStateName()
      Optional name for this state.

      Default: - The construct ID will be used as state name

    • builder

      @Stability(Stable) static MapProps.Builder builder()
      Returns:
      a MapProps.Builder of MapProps