Package software.amazon.awscdk.services.stepfunctions

Class MapJsonPathProps.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.MapJsonPathProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<MapJsonPathProps>
Enclosing interface:
MapJsonPathProps
@Stability(Stable) public static final class MapJsonPathProps.Builder extends Object implements software.amazon.jsii.Builder<MapJsonPathProps>
A builder for MapJsonPathProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • parameters

      @Stability(Deprecated) @Deprecated public MapJsonPathProps.Builder parameters(Map<String,? extends Object> parameters)
      Deprecated.
      Step Functions has deprecated the `parameters` field in favor of the new `itemSelector` field
      Sets the value of MapJsonPathProps.getParameters()
      Parameters:
      parameters - The JSON that you want to override your default iteration input (mutually exclusive with itemSelector).
      Returns:
      this

    • comment

      @Stability(Stable) public MapJsonPathProps.Builder comment(String comment)
      Sets the value of StateBaseProps.getComment()
      Parameters:
      comment - A comment describing this state.
      Returns:
      this

    • queryLanguage

      @Stability(Stable) public MapJsonPathProps.Builder queryLanguage(QueryLanguage queryLanguage)
      Sets the value of StateBaseProps.getQueryLanguage()
      Parameters:
      queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
      Returns:
      this

    • stateName

      @Stability(Stable) public MapJsonPathProps.Builder stateName(String stateName)
      Sets the value of StateBaseProps.getStateName()
      Parameters:
      stateName - Optional name for this state.
      Returns:
      this

    • itemSelector

      @Stability(Stable) public MapJsonPathProps.Builder itemSelector(Map<String,? extends Object> itemSelector)
      Sets the value of MapBaseOptions.getItemSelector()
      Parameters:
      itemSelector - The JSON that you want to override your default iteration input (mutually exclusive with parameters and jsonataItemSelector).
      Returns:
      this

    • jsonataItemSelector

      @Stability(Stable) public MapJsonPathProps.Builder jsonataItemSelector(String jsonataItemSelector)
      Sets the value of MapBaseOptions.getJsonataItemSelector()
      Parameters:
      jsonataItemSelector - 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} %}
      Returns:
      this

    • jsonataMaxConcurrency

      @Stability(Stable) public MapJsonPathProps.Builder jsonataMaxConcurrency(String jsonataMaxConcurrency)
      Sets the value of MapBaseOptions.getJsonataMaxConcurrency()
      Parameters:
      jsonataMaxConcurrency - JSONata expression for MaxConcurrency. A JSONata expression that evaluates to an integer, specifying the maximum concurrency dynamically. Mutually exclusive with maxConcurrency and maxConcurrencyPath.

      Example value: {% $states.input.maxConcurrency %}

      Returns:
      this

    • maxConcurrency

      @Stability(Stable) public MapJsonPathProps.Builder maxConcurrency(Number maxConcurrency)
      Sets the value of MapBaseOptions.getMaxConcurrency()
      Parameters:
      maxConcurrency - MaxConcurrency. An upper bound on the number of iterations you want running at once.
      Returns:
      this

    • assign

      @Stability(Stable) public MapJsonPathProps.Builder assign(Map<String,? extends Object> assign)
      Sets the value of AssignableStateOptions.getAssign()
      Parameters:
      assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.
      Returns:
      this

    • itemsPath

      @Stability(Stable) public MapJsonPathProps.Builder itemsPath(String itemsPath)
      Sets the value of MapBaseJsonPathOptions.getItemsPath()
      Parameters:
      itemsPath - JSONPath expression to select the array to iterate over.
      Returns:
      this

    • maxConcurrencyPath

      @Stability(Stable) public MapJsonPathProps.Builder maxConcurrencyPath(String maxConcurrencyPath)
      Sets the value of MapBaseJsonPathOptions.getMaxConcurrencyPath()
      Parameters:
      maxConcurrencyPath - MaxConcurrencyPath. A JsonPath that specifies the maximum concurrency dynamically from the state input.
      Returns:
      this

    • resultPath

      @Stability(Stable) public MapJsonPathProps.Builder resultPath(String resultPath)
      Sets the value of MapBaseJsonPathOptions.getResultPath()
      Parameters:
      resultPath - 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.
      Returns:
      this

    • resultSelector

      @Stability(Stable) public MapJsonPathProps.Builder resultSelector(Map<String,? extends Object> resultSelector)
      Sets the value of MapBaseJsonPathOptions.getResultSelector()
      Parameters:
      resultSelector - 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.
      Returns:
      this

    • inputPath

      @Stability(Stable) public MapJsonPathProps.Builder inputPath(String inputPath)
      Sets the value of JsonPathCommonOptions.getInputPath()
      Parameters:
      inputPath - 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 {}.
      Returns:
      this

    • outputPath

      @Stability(Stable) public MapJsonPathProps.Builder outputPath(String outputPath)
      Sets the value of JsonPathCommonOptions.getOutputPath()
      Parameters:
      outputPath - 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 {}.
      Returns:
      this

    • build

      @Stability(Stable) public MapJsonPathProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<MapJsonPathProps>
      Returns:
      a new instance of MapJsonPathProps
      Throws:
      NullPointerException - if any required attribute was not provided