serverless-nextjs/serverless-next.js

Add CloudFront Standard Logging Support

Open

#1576 opened on Aug 23, 2021

View on GitHub
 (2 comments) (3 reactions) (0 assignees)TypeScript (3,998 stars) (447 forks)batch import
enhancementgood first issue

Description

Is your feature request related to a problem? Please describe. To aid with troubleshooting and auditing I'd like the ability to be able to enable and configure CloudFront Standard Logging from within the serverless.yml configuration file.

Describe the solution you'd like The following attributes to be supported under the CloudFront

logging:
  bucket: 'myawslogbucket.s3.amazonaws.com.'
  includeCookies: false
  prefix: 'myfolder/'

For example

WebApp:
  component: '@sls-next/serverless-component@latest'
  inputs:
    cloudfront:
      logging:
        bucket: 'myawslogbucket.s3.amazonaws.com.'
        includeCookies: false
        prefix: 'myfolder/'

These attributes should as per the CloudFormation documentation here: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html

Describe alternatives you've considered None

Contributor guide

Tech stack
typescriptnextjsaws
Domain
infrastructurecloudbackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with serverless.ymlUnderstanding of CloudFront loggingBasic TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Locate the CloudFront distribution configuration in the component's source code, likely in src/component.ts or src/resources/cloudfront.ts. Examine how existing properties like 'defaultRootObject' or 'priceClass' are defined and integrated into the CloudFormation template. Add a new 'logging' property that maps to the AWS::CloudFront::Distribution Logging property. Ensure the property accepts 'bucket', 'includeCookies', and 'prefix' fields. Validate the configuration against the CloudFormation documentation. No linked PRs or comments to reference; the implementation should follow existing patterns.