MDAA TS Docs
    Preparing search index...

    Configuration for a Step Functions state machine including execution role, logging, and EventBridge integration.

    Use cases: Workflow orchestration, state machine configuration, DataOps automation, process coordination

    AWS: AWS Step Functions state machine configuration for workflow orchestration

    Validation: stateMachineName, stateMachineType, stateMachineExecutionRole, logExecutionData, and rawStepFunctionDef are required

    interface StepFunctionProps {
        eventBridge?: EventBridgeProps;
        logExecutionData: boolean;
        logGroupRetentionDays?: number;
        rawStepFunctionDef: { [key: string]: unknown };
        stateMachineExecutionRole: string;
        stateMachineName: string;
        stateMachineType: string;
        suppressions?: SuppressionProps[];
    }
    Index

    Properties

    eventBridge?: EventBridgeProps

    EventBridge configuration for event-driven state machine triggering.

    Use cases: Event-driven workflows, external integration, automated triggering

    AWS: Amazon EventBridge integration for Step Functions triggers

    Validation: Must be valid EventBridgeProps if provided

    logExecutionData: boolean

    Whether to log parameter values and execution data during state machine execution.

    Use cases: Execution monitoring, debugging, operational visibility

    AWS: Step Functions execution data logging

    Validation: Must be boolean; required

    logGroupRetentionDays?: number

    CloudWatch log group retention in days (0 for infinite, defaults to 731).

    Use cases: Log retention management, compliance requirements, storage cost optimization

    AWS: CloudWatch log group retention for Step Functions execution logs

    Validation: Must be 1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1827,3653, or 0 if provided

    rawStepFunctionDef: { [key: string]: unknown }

    State machine definition as a JSON object (as exported from Step Functions console).

    Use cases: Workflow definition, state transitions, business logic specification

    AWS: Step Functions state machine definition

    Validation: Must be a valid JSON object with state machine definition; required

    stateMachineExecutionRole: string

    IAM role ARN the state machine assumes for executing workflow steps.

    Use cases: Workflow permissions, service integration, secure execution

    AWS: IAM role ARN for Step Functions execution

    Validation: Must be a valid IAM role ARN; required

    stateMachineName: string

    Name for the Step Functions state machine.

    Use cases: State machine identification, workflow naming

    AWS: Step Functions state machine name

    Validation: Must be a valid state machine name; required

    stateMachineType: string

    State machine type: STANDARD for long-running or EXPRESS for high-volume short-duration workflows.

    Use cases: Execution model selection, performance optimization, cost management

    AWS: Step Functions state machine type

    Validation: Must be STANDARD or EXPRESS; required

    suppressions?: SuppressionProps[]

    CDK Nag suppressions for controlled security rule exceptions with justification.

    Use cases: Compliance management, security rule exceptions, audit documentation

    AWS: CDK Nag suppressions for Step Functions compliance

    Validation: Must be array of valid SuppressionProps if provided