Class FailProps
Properties for defining a Fail state.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class FailProps : Object, IFailProps
Syntax (vb)
Public Class FailProps
Inherits Object
Implements IFailProps
Remarks
ExampleMetadata: infused
Examples
var fail = new Fail(this, "Fail", new FailProps {
ErrorPath = JsonPath.StringAt("$.someError"),
CausePath = JsonPath.StringAt("$.someCause")
});
Synopsis
Constructors
FailProps() |
Properties
Cause | A description for the cause of the failure. |
CausePath | JsonPath expression to select part of the state to be the cause to this state. |
Comment | An optional description for this state. |
Error | Error code used to represent this failure. |
ErrorPath | JsonPath expression to select part of the state to be the error to this state. |
StateName | Optional name for this state. |
Constructors
FailProps()
public FailProps()
Properties
Cause
A description for the cause of the failure.
public string Cause { get; set; }
Property Value
System.String
Remarks
Default: - No description
CausePath
JsonPath expression to select part of the state to be the cause to this state.
public string CausePath { get; set; }
Property Value
System.String
Remarks
Default: - No cause path
Comment
An optional description for this state.
public string Comment { get; set; }
Property Value
System.String
Remarks
Default: - No comment
Error
Error code used to represent this failure.
public string Error { get; set; }
Property Value
System.String
Remarks
Default: - No error code
ErrorPath
JsonPath expression to select part of the state to be the error to this state.
public string ErrorPath { get; set; }
Property Value
System.String
Remarks
Default: - No error path
StateName
Optional name for this state.
public string StateName { get; set; }
Property Value
System.String
Remarks
Default: - The construct ID will be used as state name