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.

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

docs(apigateway): add warning about split stack technique #29691

Merged
merged 5 commits into from
Apr 18, 2024
Merged

docs(apigateway): add warning about split stack technique #29691

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a19219c
docs(aws-apigateway): add warning about split stack technique
engineer-taro Apr 2, 2024
83563fd
Merge branch 'main' into feat/add-warning-split-stack-api-gateway
engineer-taro Apr 2, 2024
d4dfaa8
docs(aws-apigateway): Warn about manual API Gateway deployment after …
engineer-taro Apr 14, 2024
874c6d6
docs(aws-apigateway): Add line breaks for better visual readability
engineer-taro Apr 15, 2024
a34c249
Merge branch 'main' into feat/add-warning-split-stack-api-gateway
aaythapa Apr 18, 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
5 changes: 5 additions & 0 deletions packages/aws-cdk-lib/aws-apigateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,11 @@ The following example uses sets up two Resources '/pets' and '/books' in separat

[Resources grouped into nested stacks](test/integ.restapi-import.lit.ts)

> **Warning:** In the code above, an API Gateway deployment is created during the initial CDK deployment.
However, if there are changes to the resources in subsequent CDK deployments, a new API Gateway deployment is not
automatically created. As a result, the latest state of the resources is not reflected. To ensure the latest state
of the resources is reflected, a manual deployment of the API Gateway is required after the CDK deployment.

## Integration Targets

Methods are associated with backend integrations, which are invoked when this
Expand Down