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

fix: update handler to use correct environment variable format #7771

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jhorvat7
Copy link

@jhorvat7 jhorvat7 commented Jun 22, 2024

Description of changes:

Update documentation to clarify the usage of environment variable names in Amplify Gen 2. Specifically, update the environment variable references to use all caps with underscores. Creating a Next.JS Amplify Gen 2 application I noticed the automatically generated environment variable in the documentation env.myReports_BUCKET_NAME is not what is actually generated. What is actually generated is env.MY_REPORTS_BUCKET_NAME . Here is a failed Amplify Gen 2 branch deployment that shows this exact issue (with a different bucket name, but same concept).
2024-06-19T02:00:06.866Z [INFO]: amplify/functions/dynamodb-perform-search/handler.ts(20,17): error TS2551: Property 'mySearchResults_BUCKET_NAME' does not exist on type 'LambdaProvidedEnvVars & AmplifyBackendEnvVars'. Did you mean 'MY_SEARCH_RESULTS_BUCKET_NAME'?

Related GitHub issue #, if available:

Instructions

If this PR should not be merged upon approval for any reason, please submit as a DRAFT

Which product(s) are affected by this PR (if applicable)?

  • amplify-cli
  • amplify-ui
  • amplify-studio
  • amplify-hosting
  • amplify-libraries

Which platform(s) are affected by this PR (if applicable)?

  • JS
  • Swift
  • Android
  • Flutter
  • React Native

Please add the product(s)/platform(s) affected to the PR title

Checks

  • Does this PR conform to the styleguide?

  • Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.

  • Are any files being deleted with this PR? If so, have the needed redirects been created?

  • Are all links in MDX files using the MDX link syntax rather than HTML link syntax?

    ref: MDX: [link](https://docs.amplify.aws/)
    HTML: <a href="https://docs.amplify.aws/">link</a>

When this PR is ready to merge, please check the box below

  • Ready to merge

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@jhorvat7 jhorvat7 requested a review from a team as a code owner June 22, 2024 15:26
Copy link
Contributor

@josefaidt josefaidt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @jhorvat7 👋 thanks for filing this! Change looks good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants