From a19219c8e848c2a35d05f6f0170ecaaa4383af73 Mon Sep 17 00:00:00 2001 From: cm-engineer-taro Date: Tue, 2 Apr 2024 11:00:16 +0900 Subject: [PATCH 1/3] docs(aws-apigateway): add warning about split stack technique --- packages/aws-cdk-lib/aws-apigateway/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/aws-cdk-lib/aws-apigateway/README.md b/packages/aws-cdk-lib/aws-apigateway/README.md index 2a6be5ad2b12a..21eb9c3211140 100644 --- a/packages/aws-cdk-lib/aws-apigateway/README.md +++ b/packages/aws-cdk-lib/aws-apigateway/README.md @@ -267,6 +267,10 @@ 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:** With the above code, no Deployment is created even if there are changes to the resources, and the latest resources are not reflected. +To create a Deployment, you need to use [`Deployment.addToLogicalId()`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.Deployment.html#addwbrtowbrlogicalwbriddata). +Currently, it is possible to work around this issue with a workaround implementation. Please refer to the [related issue](https://github.com/aws/aws-cdk/issues/13526). + ## Integration Targets Methods are associated with backend integrations, which are invoked when this From d4dfaa8758d09667ff350ca71d582e0e5a215e07 Mon Sep 17 00:00:00 2001 From: cm-engineer-taro Date: Sun, 14 Apr 2024 19:55:49 +0900 Subject: [PATCH 2/3] docs(aws-apigateway): Warn about manual API Gateway deployment after CDK stack split --- packages/aws-cdk-lib/aws-apigateway/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/aws-cdk-lib/aws-apigateway/README.md b/packages/aws-cdk-lib/aws-apigateway/README.md index 21eb9c3211140..35009aab9c3a6 100644 --- a/packages/aws-cdk-lib/aws-apigateway/README.md +++ b/packages/aws-cdk-lib/aws-apigateway/README.md @@ -267,9 +267,9 @@ 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:** With the above code, no Deployment is created even if there are changes to the resources, and the latest resources are not reflected. -To create a Deployment, you need to use [`Deployment.addToLogicalId()`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.Deployment.html#addwbrtowbrlogicalwbriddata). -Currently, it is possible to work around this issue with a workaround implementation. Please refer to the [related issue](https://github.com/aws/aws-cdk/issues/13526). +> **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 From 874c6d6147e0ca3512b4a763d60be10a8d829b68 Mon Sep 17 00:00:00 2001 From: cm-engineer-taro Date: Mon, 15 Apr 2024 19:06:34 +0900 Subject: [PATCH 3/3] docs(aws-apigateway): Add line breaks for better visual readability --- packages/aws-cdk-lib/aws-apigateway/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/packages/aws-cdk-lib/aws-apigateway/README.md b/packages/aws-cdk-lib/aws-apigateway/README.md index 35009aab9c3a6..136e9a59bc388 100644 --- a/packages/aws-cdk-lib/aws-apigateway/README.md +++ b/packages/aws-cdk-lib/aws-apigateway/README.md @@ -268,8 +268,9 @@ 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. +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