Package software.amazon.awscdk.services.stepfunctions

Interface PassProps

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

Example: 

 // Makes the current JSON state { ..., "subObject": { "hello": "world" } }
 Pass pass = Pass.Builder.create(this, "Add Hello World")
         .result(Result.fromObject(Map.of("hello", "world")))
         .resultPath("$.subObject")
         .build();
 // Set the next state
 Pass nextState = new Pass(this, "NextState");
 pass.next(nextState);

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static PassProps.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.
    default Map<String,Object>
    getParameters()
    Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
    default Result
    getResult()
    If given, treat as the result of this operation.
    default String
    getResultPath()
    JSONPath expression to indicate where to inject the state's output.

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

    • getParameters

      @Stability(Stable) @Nullable default Map<String,Object> getParameters()
      Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

      Default: No parameters

      See Also:

    • getResult

      @Stability(Stable) @Nullable default Result getResult()
      If given, treat as the result of this operation.

      Can be used to inject or replace the current execution state.

      Default: No injected result

    • getResultPath

      @Stability(Stable) @Nullable default String getResultPath()
      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.

      Default: $

    • builder

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