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-27T16:51:05.910Z")
@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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forChoiceProps
static final class
An implementation forChoiceProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic ChoiceProps.Builder
builder()
default String
An optional description for this state.default String
JSONPath expression to select part of the state to be the input to this state.default String
JSONPath expression to select part of the state to be the output to this state.default String
Optional name for this state.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComment
An optional description for this state.Default: No comment
-
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
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
Optional name for this state.Default: - The construct ID will be used as state name
-
builder
- Returns:
- a
ChoiceProps.Builder
ofChoiceProps
-