Skip to content

chore: document reason and mitigation for cross region reference failure from response objects being too large #30115

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.

Sign up for GitHub

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

Merged
mergify merged 7 commits into from
May 9, 2024
Merged

chore: document reason and mitigation for cross region reference failure from response objects being too large #30115

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
de81ff0
documentation
May 8, 2024
89c6816
documentation
May 8, 2024
ee4a87e
verbiage
May 8, 2024
d6ae42f
wording
May 8, 2024
4375a34
fix adr link
May 9, 2024
4d4ca0e
Update packages/aws-cdk-lib/README.md
scanlonp May 9, 2024
cc7295c
Merge branch 'main' into colifran/export-length
mergify[bot] May 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion packages/aws-cdk-lib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,15 @@ In order to mimic strong references, a Custom Resource is also created in the co
stack which marks the SSM parameters as being "imported". When a parameter has been successfully
imported, the producing stack cannot update the value.

See the [adr](https://github.com/aws/aws-cdk/blob/main/packages/@aws-cdk/core/adr/cross-region-stack-references)
> [!NOTE]
> As a consequence of this feature being built on a Custom Resource, we are restricted to a
> CloudFormation response body size limitation of [4096 bytes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html).
> To prevent deployment errors related to the Custom Resource Provider response body being too
> large, we recommend limiting the use of nested stacks and minimizing the length of stack names.
> Doing this will prevent SSM parameter names from becoming too long which will reduce the size of the
> response body.

See the [adr](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/core/adr/cross-region-stack-references.md)
for more details on this feature.

### Removing automatic cross-stack references
Expand Down