-
Notifications
You must be signed in to change notification settings - Fork 155
Docs Update for clarify. #2484
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
Docs Update for clarify. #2484
Conversation
…f you were also using a layer for it
Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need. |
|
No related issues found. Please ensure there is an open issue related to this change to avoid significant delays or closure. |
Hi, thank you for opening this PR. I have tried to reproduce the issue you described on my end but I was not able to. I have deployed a simple function that accesses a SSM parameter and calls STS. These two calls show that the function is able to use the AWS SDK even though it's being excluded from the bundle. This is because the SDK clients needed by Powertools are bundled in the layer, while those who aren't bundled should be present in the execution environment as long as you are using Node.js 18 or greater. I have created a minimal example in an attempt to observe the issue you described, which you can find here: https://github.com/dreamorosi/layertest-2484 The only combination that I can imagine giving issues with that exclusion is if you're using the Node.js 16 managed runtime and you are using another AWS SDK client that is not part of the one In that case I would be more inclined to update the section with a callout about that runtime specifically, especially since we will stop supporting it in 2 months (#2223). -- The layer ARN is however wrong, we'll investigate why it's not being updated and are happy to merge the change. |
We have merged a change to the automation that updates the layer ARN in the docs (#2487), this should ensure that future releases update the layer ARN correctly. |
Thank you for this clarification, I was intending to use node 18, so I thought this was still a bug, but looking back at the sample node 16 was being used which explains the discrepancy. |
Closing since both items were addressed. |
Either way, thank you so much for taking the time to open the PR and for using Powertools. If you find any other are for improvement please don't hesitate to open an issue to discuss it! |
Summary
When going through the documentation I noticed on inconsistency, and one item that would lead to a failed build.
Changes
@aws-sdk
from example since this requires adding the sdk layer or the function will fail.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.