Class Fail.Builder
java.lang.Object
software.amazon.awscdk.services.stepfunctions.Fail.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<Fail>
- Enclosing class:
Fail
@Stability(Stable)
public static final class Fail.Builder
extends Object
implements software.amazon.jsii.Builder<Fail>
A fluent builder for
Fail
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
A description for the cause of the failure.JsonPath expression to select part of the state to be the cause to this state.An optional description for this state.static Fail.Builder
Error code used to represent this failure.JsonPath expression to select part of the state to be the error to this state.Optional name for this state.
-
Method Details
-
create
@Stability(Stable) public static Fail.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- Descriptive identifier for this chainable. This parameter is required.- Returns:
- a new instance of
Fail.Builder
.
-
cause
A description for the cause of the failure.Default: - No description
- Parameters:
cause
- A description for the cause of the failure. This parameter is required.- Returns:
this
-
causePath
JsonPath expression to select part of the state to be the cause to this state.You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.
Default: - No cause path
- Parameters:
causePath
- JsonPath expression to select part of the state to be the cause to this state. This parameter is required.- Returns:
this
-
comment
An optional description for this state.Default: - No comment
- Parameters:
comment
- An optional description for this state. This parameter is required.- Returns:
this
-
error
Error code used to represent this failure.Default: - No error code
- Parameters:
error
- Error code used to represent this failure. This parameter is required.- Returns:
this
-
errorPath
JsonPath expression to select part of the state to be the error to this state.You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.
Default: - No error path
- Parameters:
errorPath
- JsonPath expression to select part of the state to be the error to this state. This parameter is required.- Returns:
this
-
stateName
Optional name for this state.Default: - The construct ID will be used as state name
- Parameters:
stateName
- Optional name for this state. This parameter is required.- Returns:
this
-
build
-