CloudFormation best practices for LocalStack<>AWS compatibility#570
Merged
quetzalliwrites merged 2 commits intoMay 12, 2026
Conversation
HarshCasper
requested review from
pinzon,
quetzalliwrites and
simonrw
as code owners
Deploying localstack-docs with
|
| Latest commit: |
3b959da
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://77f57372.localstack-docs.pages.dev |
| Branch Preview URL: | https://doc-43-docs-promote-cloudfor.localstack-docs.pages.dev |
joe4dev
approved these changes
Apr 21, 2026
| ```yaml | ||
| Outputs: | ||
| ApiUrl: | ||
| Value: !Sub "https://${MyApi}.execute-api.${AWS::Region}.amazonaws.com/${StageName}" |
Member
There was a problem hiding this comment.
nit: Is it common that we provide a counter-example. The main concern is that people / AI reading it without context in a best practices section might get confused
Member
Author
There was a problem hiding this comment.
Not much, but I can add a 1-2 liner to explain a counter example.
Member
Author
There was a problem hiding this comment.
Addressed in 4f0485f — added a 1-2 liner before the snippet that explicitly labels it as the anti-pattern and notes it produces a non-resolvable URL on LocalStack, plus a short reason on the good example. Should make the section harder to misread out of context.
Collaborator
|
@simonrw we would love your expert review 😸 |
HarshCasper
force-pushed
the
doc-43-docs-promote-cloudformation-best-practices-for-localstackaws
branch
from
4f0485f to
3b959da
Compare
quetzalliwrites
approved these changes
May 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes DOC-43