Class StateProps.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.StateProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<StateProps>
Enclosing interface:
StateProps

@Stability(Stable) public static final class StateProps.Builder extends Object implements software.amazon.jsii.Builder<StateProps>
A builder for StateProps
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • comment

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

      @Stability(Stable) public StateProps.Builder inputPath(String inputPath)
      Sets the value of StateProps.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 StateProps.Builder outputPath(String outputPath)
      Sets the value of StateProps.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
    • parameters

      @Stability(Stable) public StateProps.Builder parameters(Map<String,? extends Object> parameters)
      Sets the value of StateProps.getParameters()
      Parameters:
      parameters - Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
      Returns:
      this
    • resultPath

      @Stability(Stable) public StateProps.Builder resultPath(String resultPath)
      Sets the value of StateProps.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 StateProps.Builder resultSelector(Map<String,? extends Object> resultSelector)
      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
    • stateName

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

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