software.amazon.awscdk.services.stepfunctions

Class Fail.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.Fail.Builder

Enclosing class:

Fail

@Stability(value=Experimental)
public static final class Fail.Builder
extends Object

A fluent builder for Fail.

Method Summary

Modifier and Type	Method and Description
Fail	build()
Fail.Builder	cause(String cause) A description for the cause of the failure.
Fail.Builder	comment(String comment) An optional description for this state.
static Fail.Builder	create(Construct scope, String id) EXPERIMENTAL
Fail.Builder	error(String error) Error code used to represent this failure.

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 Fail.Builder create(Construct scope,
                                                                 String id)

EXPERIMENTAL

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Fail.Builder.

cause

@Stability(value=Experimental)
public Fail.Builder cause(String cause)

A description for the cause of the failure.

Default: No description

EXPERIMENTAL

Parameters:

cause - A description for the cause of the failure. This parameter is required.

Returns:

this

comment

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

An optional description for this state.

Default: No comment

EXPERIMENTAL

Parameters:

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

Returns:

this

error

@Stability(value=Experimental)
public Fail.Builder error(String error)

Error code used to represent this failure.

Default: No error code

EXPERIMENTAL

Parameters:

error - Error code used to represent this failure. This parameter is required.

Returns:

this

build

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