Package software.amazon.awscdk.services.stepfunctions

Class Choice.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.Choice.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Choice>

Enclosing class:

Choice

@Stability(Stable)
public static final class Choice.Builder
extends Object
implements software.amazon.jsii.Builder<Choice>

A fluent builder for Choice.

Method Summary

Modifier and Type	Method	Description
Choice	build()
Choice.Builder	comment(String comment)	An optional description for this state.
static Choice.Builder	create(software.constructs.Construct scope, String id)
Choice.Builder	inputPath(String inputPath)	JSONPath expression to select part of the state to be the input to this state.
Choice.Builder	outputPath(String outputPath)	JSONPath expression to select part of the state to be the output to this state.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static Choice.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Choice.Builder.

comment

@Stability(Stable)
public Choice.Builder comment(String comment)

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(Stable)
public Choice.Builder inputPath(String inputPath)

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

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(Stable)
public Choice.Builder outputPath(String outputPath)

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

Parameters:

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

Returns:

this

build

@Stability(Stable)
public Choice build()

Specified by:

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

Returns:

a newly built instance of Choice.