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
Add a clear warning in the readme that the template must be deployed in us-east-1
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.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Issue #, if available:
Description of changes: This template can only be deployed in the
us-east-1region. See #19 for discussion about this limitation and possible alternatives.This PR adds two features intended to improve the user experience
us-east-1us-east-1. If the user tries to deploy the template outside ofus-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 limitationI'd appreciate suggestions on how to make the
AssertDescriptionas 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.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.