software.amazon.awscdk.services.stepfunctions

Interface PassProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PassProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.5.0 (build 46538f8)",
           date="2020-05-15T23:35:58.915Z")
 @Stability(value=Experimental)
public interface PassProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a Pass state.

EXPERIMENTAL

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static PassProps.Builder	builder()
default String	getComment() An optional description for 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 Result	getResult() If given, treat as the result of this operation.
default String	getResultPath() JSONPath expression to indicate where to inject the state's output.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getComment

@Stability(value=Experimental)
 @Nullable
default String getComment()

An optional description for this state.

Default: No comment

EXPERIMENTAL

getInputPath

@Stability(value=Experimental)
 @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 DISCARD, which will cause the effective input to be the empty object {}.

Default: $

EXPERIMENTAL

getOutputPath

@Stability(value=Experimental)
 @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 DISCARD, which will cause the effective output to be the empty object {}.

Default: $

EXPERIMENTAL

getParameters

@Stability(value=Experimental)
 @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

EXPERIMENTAL

See Also:

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

getResult

@Stability(value=Experimental)
 @Nullable
default Result getResult()

If given, treat as the result of this operation.

Can be used to inject or replace the current execution state.

Default: No injected result

EXPERIMENTAL

getResultPath

@Stability(value=Experimental)
 @Nullable
default String getResultPath()

JSONPath expression to indicate where to inject the state's output.

May also be the special value DISCARD, which will cause the state's input to become its output.

Default: $

EXPERIMENTAL

builder

@Stability(value=Experimental)
static PassProps.Builder builder()

Returns:

a PassProps.Builder of PassProps