Package software.amazon.awscdk.services.stepfunctions

Class Succeed

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.Succeed

All Implemented Interfaces:

IChainable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:18.614Z")
@Stability(Stable)
public class Succeed
extends State

Define a Succeed state in the state machine.

Reaching a Succeed state terminates the state execution in success.

Example:

 Succeed success = new Succeed(this, "We did it!");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Succeed.Builder	A fluent builder for Succeed.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Succeed(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Succeed(software.amazon.jsii.JsiiObjectRef objRef)
	Succeed(software.constructs.Construct scope, String id)
	Succeed(software.constructs.Construct scope, String id, SucceedProps props)

Method Summary

Modifier and Type	Method	Description
List<INextable>	getEndStates()	Continuable states of this Chainable.
static Succeed	jsonata(software.constructs.Construct scope, String id)	Define a Succeed state in the state machine.
static Succeed	jsonata(software.constructs.Construct scope, String id, SucceedJsonataProps props)	Define a Succeed state in the state machine.
static Succeed	jsonPath(software.constructs.Construct scope, String id)	Define a Succeed state in the state machine.
static Succeed	jsonPath(software.constructs.Construct scope, String id, SucceedJsonPathProps props)	Define a Succeed state in the state machine.
com.fasterxml.jackson.databind.node.ObjectNode	toStateJson()	Return the Amazon States Language object for this state.
com.fasterxml.jackson.databind.node.ObjectNode	toStateJson(QueryLanguage queryLanguage)	Return the Amazon States Language object for this state.

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addChoice, addItemProcessor, addItemProcessor, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getArguments, getAssign, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getOutputs, getParameters, getProcessor, getProcessorConfig, getProcessorMode, getQueryLanguage, getResultPath, getResultSelector, getStartState, getStateId, getStateName, makeDefault, makeNext, prefixStates, renderAssign, renderAssign, renderBranches, renderChoices, renderChoices, renderInputOutput, renderItemProcessor, renderIterator, renderNextEnd, renderQueryLanguage, renderQueryLanguage, renderResultSelector, renderRetryCatch, renderRetryCatch, setDefaultChoice, setIteration, setProcessor, setProcessorConfig, setProcessorMode, validateState, whenBoundToGraph

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Succeed

protected Succeed(software.amazon.jsii.JsiiObjectRef objRef)

Succeed

protected Succeed(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Succeed

@Stability(Stable)
public Succeed(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 SucceedProps props)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

props -

Succeed

@Stability(Stable)
public Succeed(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

Method Details

jsonata

@Stability(Stable)
@NotNull
public static Succeed jsonata(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 SucceedJsonataProps props)

Define a Succeed state in the state machine.

Reaching a Succeed state terminates the state execution in success.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

jsonata

@Stability(Stable)
@NotNull
public static Succeed jsonata(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Define a Succeed state in the state machine.

Reaching a Succeed state terminates the state execution in success.

Parameters:

scope - This parameter is required.

id - This parameter is required.

jsonPath

@Stability(Stable)
@NotNull
public static Succeed jsonPath(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 SucceedJsonPathProps props)

Define a Succeed state in the state machine.

Reaching a Succeed state terminates the state execution in success.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

jsonPath

@Stability(Stable)
@NotNull
public static Succeed jsonPath(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Define a Succeed state in the state machine.

Reaching a Succeed state terminates the state execution in success.

Parameters:

scope - This parameter is required.

id - This parameter is required.

toStateJson

@Stability(Stable)
@NotNull
public com.fasterxml.jackson.databind.node.ObjectNode toStateJson(@Nullable
 QueryLanguage queryLanguage)

Return the Amazon States Language object for this state.

Specified by:

toStateJson in class State

Parameters:

queryLanguage -

toStateJson

@Stability(Stable)
@NotNull
public com.fasterxml.jackson.databind.node.ObjectNode toStateJson()

Return the Amazon States Language object for this state.

Specified by:

toStateJson in class State

getEndStates

@Stability(Stable)
@NotNull
public List<INextable> getEndStates()

Continuable states of this Chainable.

Specified by:

getEndStates in interface IChainable

Specified by:

getEndStates in class State