AWS CDK Reference

Appearance

v2.274.0

Succeed ​

Define a Succeed state in the state machine.

Reaching a Succeed state terminates the state execution in success.

Source
aws-stepfunctions/lib/states/succeed.ts
Type last changed
v2.178.0 · 6 Feb 2025

Example ​

ts
const success = new sfn.Succeed(this, 'We did it!');
python
success = sfn.Succeed(self, "We did it!")
java
Succeed success = new Succeed(this, "We did it!");
csharp
// Install: dotnet add package Amazon.CDK.Lib
var success = new Succeed(this, "We did it!");
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
success := sfn.NewSucceed(this, jsii.String("We did it!"))

Initializer ​

ts
new Succeed(scope: Construct, id: string, props?: SucceedProps)
python
Succeed(scope: Construct, id: str, props: typing.Optional[SucceedProps] = None)
java
new Succeed(Construct scope, String id, SucceedProps props)
csharp
new Succeed(Construct scope, string id, SucceedProps? props = null)
go
NewSucceed(Scope Construct, Id *string, Props SucceedProps)

Construct Props ​

commentstringcommentstrcommentStringCommentstringComment*string= No comment#
A comment describing this state.
inputPathstringinput_pathstrinputPathStringInputPathstringInputPath*string= $#
JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

outputPathstringoutput_pathstroutputPathStringOutputPathstringOutputPath*string= $#
JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

outputsanyoutputsAnyoutputsObjectOutputsobjectOutputsinterface{}= $states.result or $states.errorO…#
Used to specify and transform output from the state.
notes · default

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: $states.result or $states.errorOutput

queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= JSONPath#
The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

stateNamestringstate_namestrstateNameStringStateNamestringStateName*string= The construct ID will be used as…#
Optional name for this state.
default

Default: The construct ID will be used as state name

Properties ​

endStatesINextable[]end_statestyping.List[INextable]endStatesList<INextable>EndStatesINextable[]EndStates*[]INextablerequired#
Continuable states of this Chainable.
idstringidstridStringIdstringId*stringrequired#
Descriptive identifier for this chainable.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
startStateStatestart_stateStatestartStateStateStartStateStateStartStateStaterequired#
First state of this Chainable.
stateIdstringstate_idstrstateIdStringStateIdstringStateId*stringrequired#
Tokenized string that evaluates to the state's ID.

Methods ​

addPrefix(x: string): voiddef add_prefix(self, x: str) -> Nonepublic void addPrefix(String x)public void AddPrefix(string x)func AddPrefix(X *string)#
Add a prefix to the stateId of this state.
bindToGraph(graph: StateGraph): voiddef bind_to_graph(self, graph: StateGraph) -> Nonepublic void bindToGraph(StateGraph graph)public void BindToGraph(StateGraph graph)func BindToGraph(Graph StateGraph)#
Register this state as part of the given graph.

Don't call this. It will be called automatically when you work with states normally.

filterNextables(states: State[]): INextable[]@staticmethod def filter_nextables(states: typing.List[State]) -> typing.List[INextable]public static List<INextable> filterNextables(List<State> states)public static INextable[] FilterNextables(State[] states)func FilterNextables(States *[]State) *[]INextablestatic#
Return only the states that allow chaining from an array of states.
findReachableEndStates(start: State, options?: FindStateOptions): State[]@staticmethod def find_reachable_end_states(start: State, options: typing.Optional[FindStateOptions] = None) -> typing.List[State]public static List<State> findReachableEndStates(State start, FindStateOptions options)public static State[] FindReachableEndStates(State start, FindStateOptions? options = null)func FindReachableEndStates(Start State, Options FindStateOptions) *[]Statestatic#
Find the set of end states states reachable through transitions from the given start state.
findReachableStates(start: State, options?: FindStateOptions): State[]@staticmethod def find_reachable_states(start: State, options: typing.Optional[FindStateOptions] = None) -> typing.List[State]public static List<State> findReachableStates(State start, FindStateOptions options)public static State[] FindReachableStates(State start, FindStateOptions? options = null)func FindReachableStates(Start State, Options FindStateOptions) *[]Statestatic#
Find the set of states reachable through transitions from the given start state.

This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

jsonata(scope: Construct, id: string, props?: SucceedJsonataProps): Succeed // chainable@staticmethod def jsonata(scope: Construct, id: str, props: typing.Optional[SucceedJsonataProps] = None) -> Succeedpublic static Succeed jsonata(Construct scope, String id, SucceedJsonataProps props)public static Succeed Jsonata(Construct scope, string id, SucceedJsonataProps? props = null)func Jsonata(Scope Construct, Id *string, Props SucceedJsonataProps) Succeedstatic#
Define a Succeed state in the state machine.

Reaching a Succeed state terminates the state execution in success.

jsonPath(scope: Construct, id: string, props?: SucceedJsonPathProps): Succeed // chainable@staticmethod def json_path(scope: Construct, id: str, props: typing.Optional[SucceedJsonPathProps] = None) -> Succeedpublic static Succeed jsonPath(Construct scope, String id, SucceedJsonPathProps props)public static Succeed JsonPath(Construct scope, string id, SucceedJsonPathProps? props = null)func JsonPath(Scope Construct, Id *string, Props SucceedJsonPathProps) Succeedstatic#
Define a Succeed state in the state machine.

Reaching a Succeed state terminates the state execution in success.

prefixStates(root: IConstruct, prefix: string): void@staticmethod def prefix_states(root: IConstruct, prefix: str) -> Nonepublic static void prefixStates(IConstruct root, String prefix)public static void PrefixStates(IConstruct root, string prefix)func PrefixStates(Root IConstruct, Prefix *string)static#
Add a prefix to the stateId of all States found in a construct tree.
toStateJson(queryLanguage?: QueryLanguage): jsondef to_state_json(self, query_language: typing.Optional[QueryLanguage] = None) -> Anypublic Object toStateJson(QueryLanguage queryLanguage)public object ToStateJson(QueryLanguage? queryLanguage = null)func ToStateJson(QueryLanguage QueryLanguage) interface{}#
Return the Amazon States Language object for this state.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining