@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:43.506Z")
public interface StateProps
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)) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
StateProps.Builder
A builder for
StateProps |
static class |
StateProps.Jsii$Proxy
An implementation for
StateProps |
Modifier and Type | Method and Description |
---|---|
static StateProps.Builder |
builder() |
default java.lang.String |
getComment()
A comment describing this state.
|
default java.lang.String |
getInputPath()
JSONPath expression to select part of the state to be the input to this state.
|
default java.lang.String |
getOutputPath()
JSONPath expression to select part of the state to be the output to this state.
|
default java.util.Map<java.lang.String,java.lang.Object> |
getParameters()
Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
|
default java.lang.String |
getResultPath()
JSONPath expression to indicate where to inject the state's output.
|
default java.util.Map<java.lang.String,java.lang.Object> |
getResultSelector()
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
|
default java.lang.String getComment()
Default: No comment
default java.lang.String getInputPath()
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: $
default java.lang.String getOutputPath()
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: $
default java.util.Map<java.lang.String,java.lang.Object> getParameters()
Default: No parameters
default java.lang.String getResultPath()
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: $
default java.util.Map<java.lang.String,java.lang.Object> getResultSelector()
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
static StateProps.Builder builder()
StateProps.Builder
of StateProps