class Succeed (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Succeed |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#Succeed |
![]() | software.amazon.awscdk.services.stepfunctions.Succeed |
![]() | aws_cdk.aws_stepfunctions.Succeed |
![]() | aws-cdk-lib » aws_stepfunctions » Succeed |
Implements
IConstruct
, IDependable
, IChainable
Define a Succeed state in the state machine.
Reaching a Succeed state terminates the state execution in success.
Example
const success = new sfn.Succeed(this, 'We did it!');
Initializer
new Succeed(scope: Construct, id: string, props?: SucceedProps)
Parameters
- scope
Construct
- id
string
— Descriptive identifier for this chainable. - props
Succeed
Props
Construct Props
Name | Type | Description |
---|---|---|
comment? | string | A comment describing this state. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
output | string | JSONPath expression to select part of the state to be the output to this state. |
outputs? | any | Used to specify and transform output from the state. |
query | Query | The name of the query language used by the state. |
state | string | Optional name for this state. |
comment?
Type:
string
(optional, default: No comment)
A comment describing this state.
inputPath?
Type:
string
(optional, default: $)
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 {}.
outputPath?
Type:
string
(optional, default: $)
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 {}.
outputs?
Type:
any
(optional, default: $states.result or $states.errorOutput)
Used to specify and transform output from the state.
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.
queryLanguage?
Type:
Query
(optional, default: 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.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.
Properties
Name | Type | Description |
---|---|---|
end | INextable [] | Continuable states of this Chainable. |
id | string | Descriptive identifier for this chainable. |
node | Node | The tree node. |
start | State | First state of this Chainable. |
state | string | Tokenized string that evaluates to the state's ID. |
endStates
Type:
INextable
[]
Continuable states of this Chainable.
id
Type:
string
Descriptive identifier for this chainable.
node
Type:
Node
The tree node.
startState
Type:
State
First state of this Chainable.
stateId
Type:
string
Tokenized string that evaluates to the state's ID.
Methods
Name | Description |
---|---|
add | Add a prefix to the stateId of this state. |
bind | Register this state as part of the given graph. |
to | Return the Amazon States Language object for this state. |
to | Returns a string representation of this construct. |
static json | Define a Succeed state in the state machine. |
static jsonata(scope, id, props?) | Define a Succeed state in the state machine. |
addPrefix(x)
public addPrefix(x: string): void
Parameters
- x
string
Add a prefix to the stateId of this state.
bindToGraph(graph)
public bindToGraph(graph: StateGraph): void
Parameters
- graph
State
Graph
Register this state as part of the given graph.
Don't call this. It will be called automatically when you work with states normally.
toStateJson(queryLanguage?)
public toStateJson(queryLanguage?: QueryLanguage): json
Parameters
- queryLanguage
Query
Language
Returns
json
Return the Amazon States Language object for this state.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static jsonPath(scope, id, props?)
public static jsonPath(scope: Construct, id: string, props?: SucceedJsonPathProps): Succeed
Parameters
- scope
Construct
- id
string
- props
Succeed
Json Path Props
Returns
Define a Succeed state in the state machine.
Reaching a Succeed state terminates the state execution in success.
static jsonata(scope, id, props?)
public static jsonata(scope: Construct, id: string, props?: SucceedJsonataProps): Succeed
Parameters
- scope
Construct
- id
string
- props
Succeed
Jsonata Props
Returns
Define a Succeed state in the state machine.
Reaching a Succeed state terminates the state execution in success.