Package software.amazon.awscdk.services.stepfunctions

Interface ChoiceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ChoiceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-06T23:25:17.528Z") @Stability(Stable) public interface ChoiceProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a Choice state.

Example: 

 Choice choice = Choice.Builder.create(this, "What color is it?")
         .comment("color comment")
         .build();
 Pass handleBlueItem = new Pass(this, "HandleBlueItem");
 Pass handleOtherItemColor = new Pass(this, "HanldeOtherItemColor");
 choice.when(Condition.stringEquals("$.color", "BLUE"), handleBlueItem, ChoiceTransitionOptions.builder()
         .comment("blue item comment")
         .build());
 choice.otherwise(handleOtherItemColor);

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static ChoiceProps.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 String
    getStateName()
    Optional name for 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: $

    • getStateName

      @Stability(Stable) @Nullable default String getStateName()
      Optional name for this state.

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

    • builder

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