You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore(apigateway): fix the readme sections order. (#32650)
### Description of changes
Fixes the readme sections order to match the original order when `Breaking up Methods and Resources across Stacks` section was originally added in this PR #8270. The current order does not make sense, this section does not related to the Step function backed rest API
### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
### Breaking up Methods and Resources across Stacks
80
+
81
+
It is fairly common for REST APIs with a large number of Resources and Methods to hit the [CloudFormation
82
+
limit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) of 500 resources per
83
+
stack.
84
+
85
+
To help with this, Resources and Methods for the same REST API can be re-organized across multiple stacks. A common
86
+
way to do this is to have a stack per Resource or groups of Resources, but this is not the only possible way.
87
+
The following example uses sets up two Resources '/pets' and '/books' in separate stacks using nested stacks:
88
+
89
+
[Resources grouped into nested stacks](test/integ.restapi-import.lit.ts)
90
+
91
+
> **Warning:** In the code above, an API Gateway deployment is created during the initial CDK deployment.
92
+
However, if there are changes to the resources in subsequent CDK deployments, a new API Gateway deployment is not
93
+
automatically created. As a result, the latest state of the resources is not reflected. To ensure the latest state
94
+
of the resources is reflected, a manual deployment of the API Gateway is required after the CDK deployment. See [Controlled triggering of deployments](#controlled-triggering-of-deployments) for more info.
95
+
79
96
## AWS Lambda-backed APIs
80
97
81
98
A very common practice is to use Amazon API Gateway with AWS Lambda as the
@@ -255,23 +272,6 @@ AWS Step Functions will receive the following execution input:
255
272
}
256
273
```
257
274
258
-
### Breaking up Methods and Resources across Stacks
259
-
260
-
It is fairly common for REST APIs with a large number of Resources and Methods to hit the [CloudFormation
261
-
limit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) of 500 resources per
262
-
stack.
263
-
264
-
To help with this, Resources and Methods for the same REST API can be re-organized across multiple stacks. A common
265
-
way to do this is to have a stack per Resource or groups of Resources, but this is not the only possible way.
266
-
The following example uses sets up two Resources '/pets' and '/books' in separate stacks using nested stacks:
267
-
268
-
[Resources grouped into nested stacks](test/integ.restapi-import.lit.ts)
269
-
270
-
> **Warning:** In the code above, an API Gateway deployment is created during the initial CDK deployment.
271
-
However, if there are changes to the resources in subsequent CDK deployments, a new API Gateway deployment is not
272
-
automatically created. As a result, the latest state of the resources is not reflected. To ensure the latest state
273
-
of the resources is reflected, a manual deployment of the API Gateway is required after the CDK deployment. See [Controlled triggering of deployments](#controlled-triggering-of-deployments) for more info.
274
-
275
275
## Integration Targets
276
276
277
277
Methods are associated with backend integrations, which are invoked when this
0 commit comments