Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Full documentation missing from CloudFront event type #6785

Open
trondhindenes opened this issue Oct 4, 2019 · 2 comments
Open

Full documentation missing from CloudFront event type #6785

trondhindenes opened this issue Oct 4, 2019 · 2 comments

Comments

@trondhindenes
Copy link

@trondhindenes trondhindenes commented Oct 4, 2019

Bug Report

Description

The documentation for cloudfront is very thin (https://serverless.com/framework/docs/providers/aws/events/cloudfront/). There's a few examples, but there's no complete documentation of all supported params. Since its likely that users have to use a Resources object to describe the Cloudfront distribution in detail, this event type is potentially quite complex to get right. It would be good of the documentation was a bit richer.

For example, there's no mention of the fact that CustomOriginConfig is a required field if using non-s3 origins.

As an example: I notice that in code, the QueryString attribute is hard-coded to false (

), which means that I probably have to "overwrite" the entire origin attribute. I'm suspecting this is quite common for uses-cases where cloudfront/lambda@edge is involved so it would be good if that was documented.
In short: Make it as easy as possible to get cloudfront/lambda@edge right using serverless - also for non-trivial/real-life apps.

@micheleangioni
Copy link

@micheleangioni micheleangioni commented Dec 6, 2019

I agree with @trondhindenes . More documentation would be very appreciated.

medikoo added a commit that referenced this issue Jan 9, 2020
Fixes #7151 
Addresses partially #6843 and #6785
richarddd added a commit to richarddd/serverless that referenced this issue Jan 22, 2020
@BenCoffeed
Copy link

@BenCoffeed BenCoffeed commented Mar 6, 2020

Very thin indeed. Also, is it currently possible to assign ACM certs for SSL support of distribution?

astuyve added a commit that referenced this issue Apr 15, 2020
Fixes #7151 
Addresses partially #6843 and #6785
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.