Package software.amazon.awscdk.services.stepfunctions

Class MapProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • parameters

      @Stability(Deprecated) @Deprecated public MapProps.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 MapProps.getParameters()
      Parameters:
      parameters - The JSON that you want to override your default iteration input (mutually exclusive with itemSelector).
      Returns:
      this

    • comment

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

    • queryLanguage

      @Stability(Stable) public MapProps.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 MapProps.Builder stateName(String stateName)
      Sets the value of StateBaseProps.getStateName()
      Parameters:
      stateName - Optional name for this state.
      Returns:
      this

    • itemSelector

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

    • maxConcurrency

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

    • assign

      @Stability(Stable) public MapProps.Builder assign(Map<String,? extends Object> assign)
      Sets the value of MapProps.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 MapProps.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 MapProps.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 MapProps.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 MapProps.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 MapProps.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 MapProps.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

    • items

      @Stability(Stable) public MapProps.Builder items(ProvideItems items)
      Sets the value of MapBaseJsonataOptions.getItems()
      Parameters:
      items - The array that the Map state will iterate over.
      Returns:
      this

    • outputs

      @Stability(Stable) public MapProps.Builder outputs(Object outputs)
      Sets the value of JsonataCommonOptions.getOutputs()
      Parameters:
      outputs - Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.
      Returns:
      this

    • build

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