Package software.amazon.awscdk.services.stepfunctions

Interface SucceedProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
SucceedProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.944Z") @Stability(Stable) public interface SucceedProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a Succeed state.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 SucceedProps succeedProps = SucceedProps.builder()
         .comment("comment")
         .inputPath("inputPath")
         .outputPath("outputPath")
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    SucceedProps.Builder
    A builder for SucceedProps
    static final class 
    SucceedProps.Jsii$Proxy
    An implementation for SucceedProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static SucceedProps.Builder
    builder()
     
    default String
    getComment()
    An optional description for this state.
    default String
    getInputPath()
    JSONPath expression to select part of the state to be the input to this state.
    default String
    getOutputPath()
    JSONPath expression to select part of the state to be the output to this state.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • 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: $

    • 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: $

    • builder

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