software.amazon.awscdk.services.stepfunctions

Interface FailProps

All Known Implementing Classes:

FailProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:30.861Z")
public interface FailProps

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 and Description
static class	FailProps.Builder A builder for FailProps
static class	FailProps.Jsii$Proxy An implementation for FailProps

Method Summary

Modifier and Type	Method and Description
static FailProps.Builder	builder()
default java.lang.String	getCause() A description for the cause of the failure.
default java.lang.String	getComment() An optional description for this state.
default java.lang.String	getError() Error code used to represent this failure.

Method Detail

getCause

default java.lang.String getCause()

A description for the cause of the failure.

Default: No description

getComment

default java.lang.String getComment()

An optional description for this state.

Default: No comment

getError

default java.lang.String getError()

Error code used to represent this failure.

Default: No error code

builder

static FailProps.Builder builder()

Returns:

a FailProps.Builder of FailProps