(aws-apigatewayv2): CfnStage logging level ERROR not working

[FarrOut]

Describe the bug

Setting ApiGWv2.CfnStage.loggingLevel is not deploying correct value.

Expected Behavior

When setting logging level to ERROR, the resulting setting in the physical resource should be set to "Errors Only"

Current Behavior

Setting logging level to ERROR, results in the physical resource being set to "Full Request and Response Logs".

Reproduction Steps

LoggingLevel parameter VS physical resource
OFF: "OFF"
INFO: "Full Request and Response Logs"
ERROR: "Full Request and Response Logs" (WRONG!)

import * as cdk from 'aws-cdk-lib';
import {CfnOutput, CfnParameter} from 'aws-cdk-lib';
import {Construct} from 'constructs';

import {CfnApi, CfnStage} from "aws-cdk-lib/aws-apigatewayv2";

export class ApiGatewayV2Stack extends cdk.Stack {


    constructor(scope: Construct, id: string, props?: cdk.StackProps) {
        super(scope, id, props);

        const api = new CfnApi(this, `${id}-api`, {
            name: "MockApi",
            protocolType: "WEBSOCKET",
            routeSelectionExpression: "$request.body.action",
        });

        new CfnOutput(this, 'ApiId',
            {
                description: "The API identifier.",
                value: api.attrApiId
            })
        new CfnOutput(this, 'ApiEndpoint',
            {
                description: "The default endpoint for an API.",
                value: api.attrApiEndpoint
            })
        new CfnOutput(this, 'ApiBasePath',
            {
                description: "Specifies how to interpret the base path of the API during import.",
                value: String(api.basePath)
            })
        new CfnOutput(this, 'ApiBodyS3Location',
            {
                description: "The S3 location of an OpenAPI definition.",
                value: String(api.bodyS3Location)
            })
        new CfnOutput(this, 'ApiDescription',
            {
                description: "The description of the API.",
                value: String(api.description)
            })
        new CfnOutput(this, 'ApiName',
            {
                description: "The name of the API.",
                value: String(api.name)
            })
        new CfnOutput(this, 'ApiProtocolType',
            {
                description: "The API protocol.",
                value: String(api.protocolType)
            })
        new CfnOutput(this, 'ApiVersion',
            {
                description: "A version identifier for the API.",
                value: String(api.version)
            })

        const loggingLevel = new CfnParameter(this, "LoggingLevel", {
            type: "String",
            description: "Specifies the logging level for this route.",
            default: 'INFO',
            allowedValues: ['INFO', 'ERROR', 'OFF'],
        });
        new CfnOutput(this, 'LoggingLevelParameter',
            {
                description: "A map that defines the stage variables for a Stage.",
                value: loggingLevel.valueAsString
            })

        const stage = new CfnStage(this, `${id}-stage`, {
            apiId: api.ref,
            stageName: `${id}-stage-${loggingLevel.valueAsString}`,
            autoDeploy: true,
            defaultRouteSettings: {
                dataTraceEnabled: true, // depends on logging role
                detailedMetricsEnabled: true,
                loggingLevel: loggingLevel.valueAsString,
            }
        });
        new CfnOutput(this, 'StageApiId',
            {
                description: "The API identifier.",
                value: String(stage.apiId)
            })
        new CfnOutput(this, 'StageName',
            {
                description: "Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.",
                value: String(stage.stageName)
            })
        new CfnOutput(this, 'IsStageAutoDeploy',
            {
                description: "Specifies whether updates to an API automatically trigger a new deployment.",
                value: String(stage.autoDeploy)
            })
        new CfnOutput(this, 'StageClientCertId',
            {
                description: "The identifier of a client certificate for a Stage.",
                value: String(stage.clientCertificateId)
            })
        new CfnOutput(this, 'StageDeploymentIde',
            {
                description: "The deployment identifier for the API stage.",
                value: String(stage.deploymentId)
            })
        new CfnOutput(this, 'StageDescription',
            {
                description: "The description for the API stage.",
                value: String(stage.description)
            })
        new CfnOutput(this, 'StageVariables',
            {
                description: "A map that defines the stage variables for a Stage.",
                value: String(stage.stageVariables)
            })
        new CfnOutput(this, 'StageRouteSettings',
            {
                description: "Route settings for the stage.",
                value: String(stage.routeSettings)
            })

    }
}

Possible Solution

When setting logging level to "ERROR", set physical resource to "Errors Only" mode.

Additional Information/Context

No response

CDK CLI Version

2.83.1 (build 006b542)

Framework Version

No response

Node.js Version

v16.20.0

OS

Windows 10

Language

Typescript

Language Version

No response

Other information

No response

[pahud]

Can you check the synthesized output and see if the value of loggingLevel is ERROR ? If yes but the value from the console is actuallyFull Request and Response Logs then I believe this might be a bug from cloudformation and we'll need to report this in cloudformation roadmap coverage.

[FarrOut]

Oooh good point!

Just check again and confirmed, synthesized template sets value to ERROR, but the resource is still set to incorrect mode.

Opened ticket in Cloudformation Roadmap

[ashishdhingra]

@FarrOut Please refer aws-cloudformation/cloudformation-coverage-roadmap#1712 (comment). Setting dataTraceEnabled: true will always set the CloudWatch Logs setting on the UI to Full Request and Response Logs. It's only if dataTraceEnabled is not set not true, then the logging level will be applied.

Closing this ticket. Feel free to reopen if it's still an issue.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.