Step Functions Logging Disabled
stepfunctions-logging-disabled
What this rule checks
Detects Step Functions state machines without logging.
How to fix it
- 1Enable CloudWatch Logs for state machine execution
- 2Set appropriate log level (ALL, ERROR, FATAL, OFF)
import * as sfn from 'aws-cdk-lib/aws-stepfunctions';
// inside your Stack
new sfn.StateMachine(this, 'SM', {
definitionBody: sfn.DefinitionBody.fromChainable(
new sfn.Pass(this, 'Start'),
),
});import * as sfn from 'aws-cdk-lib/aws-stepfunctions';
import * as logs from 'aws-cdk-lib/aws-logs';
// inside your Stack
const logGroup = new logs.LogGroup(this, 'SmLogs');
new sfn.StateMachine(this, 'SM', {
definitionBody: sfn.DefinitionBody.fromChainable(
new sfn.Pass(this, 'Start'),
),
logs: { destination: logGroup, level: sfn.LogLevel.ALL },
});CDK Insights pinpoints the exact file and line in your CDK source for every finding, so you can jump straight to the fix.
Affected resource types
AWS::StepFunctions::StateMachineIntentional? Suppress this finding
Sometimes a flag is deliberate โ a genuinely public endpoint, say. You can dismiss stepfunctions-logging-disabled and the reason is kept in the report, not silently hidden.
In .cdk-insights.json:
{
"ignoreRules": [
{ "id": "stepfunctions-logging-disabled", "reason": "Why this is intentional" }
]
}Or inline in your CDK code:
Validations.of(scope).acknowledge({
id: 'cdk-insights::stepfunctions-logging-disabled',
reason: 'Why this is intentional',
});Use the rule ID stepfunctions-logging-disabled shown above โ not the CDK-* ID from SARIF / GitHub code scanning. To dismiss every finding on one construct instead, use ignorePaths. Suppression docs โ
Catch this in your stack
$ npx cdk-insights scanCDK Insights runs this and 118+ other rules locally against your synthesised CDK app โ free, no account, your code never leaves your machine.