@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:43.465Z")
public class Fail
extends State
Reaching a Fail state terminates the state execution in failure.
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();
| Modifier and Type | Class and Description |
|---|---|
static class |
Fail.Builder
A fluent builder for
Fail. |
IChainable.Jsii$DefaultIConstruct.Jsii$Default| Modifier | Constructor and Description |
|---|---|
protected |
Fail(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
Fail(software.amazon.jsii.JsiiObjectRef objRef) |
|
Fail(software.constructs.Construct scope,
java.lang.String id) |
|
Fail(software.constructs.Construct scope,
java.lang.String id,
FailProps props) |
| Modifier and Type | Method and Description |
|---|---|
java.util.List<INextable> |
getEndStates()
Continuable states of this Chainable.
|
com.fasterxml.jackson.databind.node.ObjectNode |
toStateJson()
Return the Amazon States Language object for this state.
|
addBranch, addChoice, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getParameters, getResultPath, getResultSelector, getStartState, getStateId, makeDefault, makeNext, prefixStates, renderBranches, renderChoices, renderInputOutput, renderIterator, renderNextEnd, renderResultSelector, renderRetryCatch, setDefaultChoice, setIteration, whenBoundToGraphgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validateprotected Fail(software.amazon.jsii.JsiiObjectRef objRef)
protected Fail(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public Fail(software.constructs.Construct scope,
java.lang.String id,
FailProps props)
scope - This parameter is required.id - This parameter is required.props - public Fail(software.constructs.Construct scope,
java.lang.String id)
scope - This parameter is required.id - This parameter is required.public com.fasterxml.jackson.databind.node.ObjectNode toStateJson()
toStateJson in class Statepublic java.util.List<INextable> getEndStates()
getEndStates in interface IChainablegetEndStates in class State