software.amazon.awscdk.services.stepfunctions

Class Pass.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.Pass.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Pass>

Enclosing class:

Pass

@Stability(value=Experimental)
public static final class Pass.Builder
extends Object
implements software.amazon.jsii.Builder<Pass>

(experimental) A fluent builder for Pass.

Method Summary

Modifier and Type	Method and Description
Pass	build()
Pass.Builder	comment(String comment) (experimental) An optional description for this state.
static Pass.Builder	create(software.constructs.Construct scope, String id)
Pass.Builder	inputPath(String inputPath) (experimental) JSONPath expression to select part of the state to be the input to this state.
Pass.Builder	outputPath(String outputPath) (experimental) JSONPath expression to select part of the state to be the output to this state.
Pass.Builder	parameters(Map<String,? extends Object> parameters) (experimental) Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
Pass.Builder	result(Result result) (experimental) If given, treat as the result of this operation.
Pass.Builder	resultPath(String resultPath) (experimental) JSONPath expression to indicate where to inject the state's output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static Pass.Builder create(software.constructs.Construct scope,
                                                                 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Pass.Builder.

comment

@Stability(value=Experimental)
public Pass.Builder comment(String comment)

(experimental) An optional description for this state.

Default: No comment

Parameters:

comment - An optional description for this state. This parameter is required.

Returns:

this

inputPath

@Stability(value=Experimental)
public Pass.Builder inputPath(String inputPath)

(experimental) 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: $

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.

Returns:

this

outputPath

@Stability(value=Experimental)
public Pass.Builder outputPath(String outputPath)

(experimental) 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: $

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. This parameter is required.

Returns:

this

parameters

@Stability(value=Experimental)
public Pass.Builder parameters(Map<String,? extends Object> parameters)

(experimental) Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

Default: No parameters

Parameters:

parameters - Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input. This parameter is required.

Returns:

this

See Also:

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

result

@Stability(value=Experimental)
public Pass.Builder result(Result result)

(experimental) If given, treat as the result of this operation.

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

Default: No injected result

Parameters:

result - If given, treat as the result of this operation. This parameter is required.

Returns:

this

resultPath

@Stability(value=Experimental)
public Pass.Builder resultPath(String resultPath)

(experimental) 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: $

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Pass build()

Specified by:

build in interface software.amazon.jsii.Builder<Pass>