interface FailProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.FailProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#FailProps |
Java | software.amazon.awscdk.services.stepfunctions.FailProps |
Python | aws_cdk.aws_stepfunctions.FailProps |
TypeScript (source) | aws-cdk-lib » aws_stepfunctions » FailProps |
Properties for defining a Fail state.
Example
const fail = new sfn.Fail(this, 'Fail', {
errorPath: sfn.JsonPath.stringAt('$.someError'),
causePath: sfn.JsonPath.stringAt('$.someCause'),
});
Properties
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 | An optional description for 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. |
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.
comment?
Type:
string
(optional, default: No comment)
An optional description for 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.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.