software.amazon.awscdk.services.stepfunctions

Interface PassProps

All Known Implementing Classes:

PassProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:22.673Z")
public interface PassProps

Properties for defining a Pass state.

Example:

 // Makes the current JSON state { ..., "subObject": { "hello": "world" } }
 Pass pass = Pass.Builder.create(this, "Add Hello World")
         .result(Result.fromObject(Map.of("hello", "world")))
         .resultPath("$.subObject")
         .build();
 // Set the next state
 Pass nextState = new Pass(this, "NextState");
 pass.next(nextState);
 

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 java.lang.String	getComment() An optional description for 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 Result	getResult() If given, treat as the result of this operation.
default java.lang.String	getResultPath() JSONPath expression to indicate where to inject the state's output.

Method Detail

getComment

default java.lang.String getComment()

An optional description for 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

getResult

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

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: $

builder

static PassProps.Builder builder()

Returns:

a PassProps.Builder of PassProps