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

Add and document expected structure and logic when lambda is involved #94

Closed
2 tasks
flochaz opened this issue Oct 23, 2020 · 2 comments
Closed
2 tasks
Labels
feature-request A feature should be added or improved needs-triage The issue or PR still needs to be triaged

Comments

@flochaz
Copy link

flochaz commented Oct 23, 2020

For new comers in CDK willing to test solutions construct, it would be great to have more info and what needs to be setup in addition to the construct instantiation code.

Use Case

When starting to use any construct involving lambda such as https://docs.aws.amazon.com/solutions/latest/constructs/aws-lambda-sqs.html we need, in addition to adding the documented code,

  1. create a lambda folder,
  2. create an index.js file in it,
  3. figure out how to write to a queue (https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/sqs-examples-send-receive-messages.html)
  4. dig into to the construct code to figure out what environment variable will be set for the SQS queue ...

Proposed Solution

Add documentation in addition to code snippet on:

  1. folder structure
  2. Env variables names set for the lambda
  3. Snippet of lambda code
  • 👋 I may be able to implement this feature request
  • ⚠️ This feature might incur a breaking change

This is a 🚀 Feature Request

@flochaz flochaz added feature-request A feature should be added or improved needs-triage The issue or PR still needs to be triaged labels Oct 23, 2020
@biffgaut
Copy link
Contributor

We will add a comment explaining the assumption of file structure in the minimal code.

Sample implementations are on our backlog, but not on the roadmap at this point.

@biffgaut
Copy link
Contributor

biffgaut commented Apr 2, 2021

Released in 1.94.0

@biffgaut biffgaut closed this as completed Apr 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved needs-triage The issue or PR still needs to be triaged
Projects
None yet
Development

No branches or pull requests

2 participants