Package software.amazon.awscdk.services.stepfunctions

Interface FailProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
FailProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-06T23:25:17.538Z") @Stability(Stable) public interface FailProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a Fail state.

Example: 

 Fail fail = Fail.Builder.create(this, "Fail")
         .errorPath(JsonPath.format("error: {}.", JsonPath.stringAt("$.someError")))
         .causePath("States.Format('cause: {}.', $.someCause)")
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    FailProps.Builder
    A builder for FailProps
    static final class 
    FailProps.Jsii$Proxy
    An implementation for FailProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static FailProps.Builder
    builder()
     
    default String
    getCause()
    A description for the cause of the failure.
    default String
    getCausePath()
    JsonPath expression to select part of the state to be the cause to this state.
    default String
    getComment()
    An optional description for this state.
    default String
    getError()
    Error code used to represent this failure.
    default String
    getErrorPath()
    JsonPath expression to select part of the state to be the error to this state.
    default String
    getStateName()
    Optional name for this state.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getCause

      @Stability(Stable) @Nullable default String getCause()
      A description for the cause of the failure.

      Default: - No description

    • getCausePath

      @Stability(Stable) @Nullable default String getCausePath()
      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

    • getComment

      @Stability(Stable) @Nullable default String getComment()
      An optional description for this state.

      Default: - No comment

    • getError

      @Stability(Stable) @Nullable default String getError()
      Error code used to represent this failure.

      Default: - No error code

    • getErrorPath

      @Stability(Stable) @Nullable default String getErrorPath()
      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

    • getStateName

      @Stability(Stable) @Nullable default String getStateName()
      Optional name for this state.

      Default: - The construct ID will be used as state name

    • builder

      @Stability(Stable) static FailProps.Builder builder()
      Returns:
      a FailProps.Builder of FailProps