Skip to content

fix(aws-lambda): fail fast if a reserved environment variable is specified#22039

Merged
mergify[bot] merged 2 commits intoaws:mainfrom
joelcox22:main
Sep 15, 2022
Merged

fix(aws-lambda): fail fast if a reserved environment variable is specified#22039
mergify[bot] merged 2 commits intoaws:mainfrom
joelcox22:main

Conversation

@joelcox22
Copy link
Copy Markdown
Contributor

@joelcox22 joelcox22 commented Sep 14, 2022

I've found myself several times without thinking specifying AWS_REGION as an environment variable explicitly when writing a lambda function that needed to know the region, and only found it was problemattic and unnecessary at cloudformation deployment time.

This change adds a simple error to enable faster failures during development when a developer specifies a reserved environment variable name - it's purely a convenience change to help avoiding wasting time waiting for a deployment and rollback in an edge case where the developer is making a clear error.

This does not reference any existing issue.

All Submissions:

Adding new Unconventional Dependencies:

  • This PR adds new unconventional dependencies following the process described here

New Features

  • Have you added the new feature to an integration test?
    • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

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

@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Sep 14, 2022

@github-actions github-actions bot added the p2 label Sep 14, 2022
@aws-cdk-automation aws-cdk-automation requested a review from a team September 14, 2022 15:10
Copy link
Copy Markdown
Contributor

@corymhall corymhall left a comment

Choose a reason for hiding this comment

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

Please make sure that your PR body describes the problem the PR is solving, and the design approach and alternatives considered. Explain why the PR solves the problem. A link to an issue is helpful, but does not replace an explanation of your thought process (See Contributing Guide, Pull Requests (https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md#step-4-pull-request))

@joelcox22
Copy link
Copy Markdown
Contributor Author

Thanks for the feedback. PR description is now updated with more details and explaining my thought process 👍🏻

This is definitely a low priority PR - it's just a minor developer experience improvement for an edge case most developers probably won't even run into 😅

@joelcox22 joelcox22 requested a review from corymhall September 15, 2022 08:24
Copy link
Copy Markdown
Contributor

@corymhall corymhall left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution! Looks great!

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Sep 15, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: b922438
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 950ccd5 into aws:main Sep 15, 2022
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Sep 15, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants