How to enable Cloudwatch Logs for API Gateway using Cloudformation?

Question

Hi I'm trying to enable Cloudwatch logs in API Gateway using Cloudformation. However, I do not find the the documentation to do so. All I can find is Logginglevel in the official documentation which doesn't seem to be the solution.

For context I'm looking to achieve this using Cloudformation but don't know how to. Please help.

Marcin · Accepted Answer · 2022-02-07T22:39:37.830

2

These log settings are set using MethodSetting:

DataTraceEnabled - is for "Log full requests..."
LoggingLevel is for "Log level"
MetricsEnabled is for "Enable detailed CloudWatch metrics"

edited Feb 07 '22 at 22:39

answered Oct 14 '20 at 06:41

Marcin

215,873
14
235
294

1

I tried this and get this error `StageDescription cannot be specified when stage referenced by StageName already exists` Any Idea why? – Red Bottle Oct 14 '20 at 06:48
@RedBottle Can you update your question with relevant template parts? – Marcin Oct 14 '20 at 07:01
1

Nvm this is a seperate issue. My initial question is answered. Thank you. – Red Bottle Oct 14 '20 at 07:39
This is for v1. Is there anything for ApiGatewayV2? I've created a similar question https://stackoverflow.com/q/67670073/2948212 – diegosasw May 24 '21 at 10:02

score 0 · Answer 2 · answered Jun 30 '22 at 13:10

Yaml template snippet for ApiGateway V1:

SomeApiStage:
    Type: AWS::ApiGateway::Stage
    Properties:
      RestApiId:
        Ref: SomeApi
      DeploymentId:
        Ref: SomeApiDeployment
      StageName: some-api
      Description: Some Api stage
      MethodSettings:
        - ResourcePath: "/*"
          HttpMethod: "*"
          MetricsEnabled: true
          DataTraceEnabled: true
          LoggingLevel: "INFO"

How to enable Cloudwatch Logs for API Gateway using Cloudformation?

2 Answers2

Linked