Package software.amazon.awscdk.services.stepfunctions

Interface StateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.404Z")
@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

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StateProps.Builder	builder()
default String	getComment()	A comment describing 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 Map<String,Object>	getParameters()	Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
default String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
default Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
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()

A comment describing 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: $

getParameters

@Stability(Stable)
@Nullable
default Map<String,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

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
@Nullable
default Map<String,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

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 StateProps.Builder builder()

Returns:

a StateProps.Builder of StateProps