Interface StateProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
StateProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-27T16:51:05.957Z")
@Stability(Stable)
public interface StateProps
extends software.amazon.jsii.JsiiSerializable
Properties shared by all states.
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.*; Object parameters; Object resultSelector; StateProps stateProps = StateProps.builder() .comment("comment") .inputPath("inputPath") .outputPath("outputPath") .parameters(Map.of( "parametersKey", parameters)) .resultPath("resultPath") .resultSelector(Map.of( "resultSelectorKey", resultSelector)) .stateName("stateName") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forStateProps
static final class
An implementation forStateProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic StateProps.Builder
builder()
default String
A comment describing 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.Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.default String
JSONPath expression to indicate where to inject the state's output.The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.default String
Optional name for this state.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComment
A comment describing 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: $
-
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:
-
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: $
-
getResultSelector
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
- See Also:
-
getStateName
Optional name for this state.Default: - The construct ID will be used as state name
-
builder
- Returns:
- a
StateProps.Builder
ofStateProps
-