class Fail (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Fail |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#Fail |
![]() | software.amazon.awscdk.services.stepfunctions.Fail |
![]() | aws_cdk.aws_stepfunctions.Fail |
![]() | aws-cdk-lib » aws_stepfunctions » Fail |
Implements
IConstruct
, IDependable
, IChainable
Define a Fail state in the state machine.
Reaching a Fail state terminates the state execution in failure.
Example
const fail = new sfn.Fail(this, 'Fail', {
errorPath: sfn.JsonPath.format('error: {}.', sfn.JsonPath.stringAt('$.someError')),
causePath: "States.Format('cause: {}.', $.someCause)",
});
Initializer
new Fail(scope: Construct, id: string, props?: FailProps)
Parameters
Construct Props
Name | Type | Description |
---|---|---|
cause? | string | A description for the cause of the failure. |
cause | string | JsonPath expression to select part of the state to be the cause to this state. |
comment? | string | A comment describing this state. |
error? | string | Error code used to represent this failure. |
error | string | JsonPath expression to select part of the state to be the error to this state. |
query | Query | The name of the query language used by the state. |
state | string | Optional name for this state. |
cause?
Type:
string
(optional, default: No description)
A description for the cause of the failure.
causePath?
Type:
string
(optional, default: No cause path)
JsonPath expression to select part of the state to be the cause to this state.
You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.
comment?
Type:
string
(optional, default: No comment)
A comment describing this state.
error?
Type:
string
(optional, default: No error code)
Error code used to represent this failure.
errorPath?
Type:
string
(optional, default: No error path)
JsonPath expression to select part of the state to be the error to this state.
You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.
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. |
protected validate | Validate this state. |
static json | Define a Fail state using JSONPath in the state machine. |
static jsonata(scope, id, props?) | Define a Fail state using JSONata 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.
protected validateState()
protected validateState(): string[]
Returns
string[]
Validate this state.
static jsonPath(scope, id, props?)
public static jsonPath(scope: Construct, id: string, props?: FailJsonPathProps): Fail
Parameters
- scope
Construct
- id
string
- props
Fail
Json Path Props
Returns
Define a Fail state using JSONPath in the state machine.
Reaching a Fail state terminates the state execution in failure.
static jsonata(scope, id, props?)
public static jsonata(scope: Construct, id: string, props?: FailJsonataProps): Fail
Parameters
- scope
Construct
- id
string
- props
Fail
Jsonata Props
Returns
Define a Fail state using JSONata in the state machine.
Reaching a Fail state terminates the state execution in failure.