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

Make region limitation more clear #50

Merged
merged 2 commits into from
Jan 20, 2022
Merged

Make region limitation more clear #50

merged 2 commits into from
Jan 20, 2022

Conversation

ConnorKirk
Copy link
Contributor

@ConnorKirk ConnorKirk commented Jan 19, 2022

Issue #, if available:

Description of changes:
This template can only be deployed in the us-east-1 region.
See #19 for discussion about this limitation and possible alternatives.

This PR adds two features intended to improve the user experience

  1. Add a clear warning in the readme that the template must be deployed in us-east-1
  2. Add a Rule to the CloudFormation template asserting the deployment region is us-east-1. If the user tries to deploy the template outside of us-east-1, this rule will cause the deployment to fail. This has two advantages over letting the deployment fail later due to the ACM/CloudFront limitation
  • Gives feedback faster. The template will fail before attempting to create resources
  • We can give a specific, useful feedback message.

I'd appreciate suggestions on how to make the AssertDescription as helpful as possible. This is the message shown in the CloudFormation logs when the region rule causes the template to fail.

Here's an example of what it looks like in the logs.

image

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

By using a CloudFormation rule, the user can receive feedback more
quickly.
The error message is also more helpful.
@ConnorKirk ConnorKirk changed the title Add region warning Make region limitation more clear Jan 19, 2022
@ConnorKirk ConnorKirk merged commit 77d1971 into master Jan 20, 2022
@ConnorKirk ConnorKirk deleted the add-region-warning branch January 20, 2022 10:43
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.

2 participants