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.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.908Z") @Stability(Stable) public interface FailProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a Fail state.

Example: 

 import software.amazon.awscdk.services.lambda.*;
 Function submitLambda;
 Function getStatusLambda;
 LambdaInvoke submitJob = LambdaInvoke.Builder.create(this, "Submit Job")
         .lambdaFunction(submitLambda)
         // Lambda's result is in the attribute `Payload`
         .outputPath("$.Payload")
         .build();
 Wait waitX = Wait.Builder.create(this, "Wait X Seconds")
         .time(WaitTime.secondsPath("$.waitSeconds"))
         .build();
 LambdaInvoke getStatus = LambdaInvoke.Builder.create(this, "Get Job Status")
         .lambdaFunction(getStatusLambda)
         // Pass just the field named "guid" into the Lambda, put the
         // Lambda's result in a field called "status" in the response
         .inputPath("$.guid")
         .outputPath("$.Payload")
         .build();
 Fail jobFailed = Fail.Builder.create(this, "Job Failed")
         .cause("AWS Batch Job Failed")
         .error("DescribeJob returned FAILED")
         .build();
 LambdaInvoke finalStatus = LambdaInvoke.Builder.create(this, "Get Final Job Status")
         .lambdaFunction(getStatusLambda)
         // Use "guid" field as input
         .inputPath("$.guid")
         .outputPath("$.Payload")
         .build();
 Chain definition = submitJob.next(waitX).next(getStatus).next(new Choice(this, "Job Complete?").when(Condition.stringEquals("$.status", "FAILED"), jobFailed).when(Condition.stringEquals("$.status", "SUCCEEDED"), finalStatus).otherwise(waitX));
 StateMachine.Builder.create(this, "StateMachine")
         .definition(definition)
         .timeout(Duration.minutes(5))
         .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
    getComment()
    An optional description for this state.
    default String
    getError()
    Error code used to represent this failure.

    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

    • 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

    • builder

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