Header menu logo FsCDK

StepFunctionConfig Type

High-level AWS Step Functions (State Machine) builder following AWS best practices. **Default Settings:** - StateMachineType = STANDARD (for long-running workflows) - Logging = ALL events logged to CloudWatch (requires logDestination for Stack deployment) - TracingEnabled = true (X-Ray integration) - Timeout = 1 hour (configurable) **Rationale:** These defaults follow Yan Cui's production serverless best practices: - Standard type for reliable, exactly-once execution - Full logging for debugging and audit trails (requires logDestination when deploying) - X-Ray tracing for distributed system visibility - Reasonable timeout prevents runaway workflows **Use Cases:** - Order processing workflows - ETL data pipelines - Human approval workflows - Saga orchestration patterns - Microservice orchestration **Escape Hatch:** Access the underlying CDK StateMachine via the `StateMachine` property for advanced scenarios not covered by this builder.

Record fields

Record Field Description

Comment

Full Usage: Comment

Field type: string option
Field type: string option

ConstructId

Full Usage: ConstructId

Field type: string option
Field type: string option

Definition

Full Usage: Definition

Field type: IChainable option
Field type: IChainable option

LogDestination

Full Usage: LogDestination

Field type: ILogGroup option
Field type: ILogGroup option

LoggingLevel

Full Usage: LoggingLevel

Field type: LogLevel voption
Field type: LogLevel voption

Role

Full Usage: Role

Field type: IRole option
Field type: IRole option

StateMachineName

Full Usage: StateMachineName

Field type: string
Field type: string

StateMachineType

Full Usage: StateMachineType

Field type: StateMachineType voption
Field type: StateMachineType voption

Timeout

Full Usage: Timeout

Field type: Duration option
Field type: Duration option

TracingEnabled

Full Usage: TracingEnabled

Field type: bool voption
Field type: bool voption

Type something to start searching.