software.amazon.awscdk.services.stepfunctions

Interface StateProps

All Known Implementing Classes:

StateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.506Z")
public interface StateProps

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))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StateProps.Builder A builder for StateProps
static class	StateProps.Jsii$Proxy An implementation for StateProps

Method Summary

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.

Method Detail

getComment

default java.lang.String getComment()

A comment describing this state.

Default: No comment

getInputPath

default java.lang.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

default java.lang.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

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: No parameters

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters

getResultPath

default java.lang.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: $

getResultSelector

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.

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:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

builder

static StateProps.Builder builder()

Returns:

a StateProps.Builder of StateProps