Package software.amazon.awscdk.services.stepfunctions

Class Succeed.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static Succeed.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - Descriptive identifier for this chainable. This parameter is required.
      Returns:
      a new instance of Succeed.Builder.

    • comment

      @Stability(Stable) public Succeed.Builder comment(String comment)
      An optional description for this state.

      Default: No comment

      Parameters:
      comment - An optional description for this state. This parameter is required.
      Returns:
      this

    • inputPath

      @Stability(Stable) public Succeed.Builder inputPath(String 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 {}.

      Default: $

      Parameters:
      inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
      Returns:
      this

    • outputPath

      @Stability(Stable) public Succeed.Builder outputPath(String 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 {}.

      Default: $

      Parameters:
      outputPath - JSONPath expression to select part of the state to be the output to this state. This parameter is required.
      Returns:
      this

    • stateName

      @Stability(Stable) public Succeed.Builder stateName(String stateName)
      Optional name for this state.

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

      Parameters:
      stateName - Optional name for this state. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public Succeed build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Succeed>
      Returns:
      a newly built instance of Succeed.