fix(apigatewayv2): cyclic dependency between HttpApi and the lambda function #9100
Conversation
This file contains 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
…unction
As part of Lambda proxy integration, a `AWS::Lambda::Permission`
resource is created to provide the HTTP service permission to invoke
the lambda function, creating the dependency, Permission → API.
The API, on the other hand, needs to refer to the Function's ARN and
hence creates the dependency, API → Function.
However, when the lambda function and the HTTP API are placed in
different stacks, this creates a cyclic dependency between these two
stacks.
A picture is worth a thousand words:
```
+--------------------------------------------------------------+
| Lambda stack |
| |
| +-------------------+ +-----------------+ |
| | | via ARN | | |
| | Lambda Permission +----------->| Lambda Function | |
| | | | | |
| +-------+-----------+ +-----------------+ |
| | ^ |
+------------|--------------------------------|----------------+
|via ARN |via ARN
| |
+------------|--------------------------------|-----------------+
| v | |
| +-----------+ +----------+---------+ |
| | | via ID | | |
| | Http API |<--------------+ API Integration | |
| | | | | |
| +-----------+ +--------------------+ |
| |
| API Gateway stack |
+---------------------------------------------------------------+
```
The fix here is to move the Lambda Permission resource into the same
stack as where the API integration is defined.
fixes #9075
BREAKING CHANGE: The parameter for the method `bind()` on
`IHttpRouteIntegration` has changed to accept one of type
`HttpRouteIntegrationBindOptions`. The previous parameter
`IHttpRoute` is now a property inside the new parameter under
the key `route`.
nija-at
force-pushed
the
nija-at/apigwv2-cyclic-deps
branch
from
62b8e21 to
a238c8d
Compare
njlynch
approved these changes
Jul 24, 2020
Co-authored-by: Nick Lynch <[email protected]>
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
eladb
pushed a commit
that referenced
this pull request
Aug 10, 2020
…unction (#9100) As part of Lambda proxy integration, a `AWS::Lambda::Permission` resource is created to provide the HTTP service permission to invoke the lambda function, creating the dependency, Permission → API. The API, on the other hand, needs to refer to the Function's ARN and hence creates the dependency, API → Function. However, when the lambda function and the HTTP API are placed in different stacks, this creates a cyclic dependency between these two stacks. A picture is worth a thousand words: ``` +--------------------------------------------------------------+ | Lambda stack | | | | +-------------------+ +-----------------+ | | | | via ARN | | | | | Lambda Permission +----------->| Lambda Function | | | | | | | | | +-------+-----------+ +-----------------+ | | | ^ | +------------|--------------------------------|----------------+ |via ARN |via ARN | | +------------|--------------------------------|-----------------+ | v | | | +-----------+ +----------+---------+ | | | | via ID | | | | | Http API |<--------------+ API Integration | | | | | | | | | +-----------+ +--------------------+ | | | | API Gateway stack | +---------------------------------------------------------------+ ``` The fix here is to move the Lambda Permission resource into the same stack as where the API integration is defined, thereby breaking the dependency cycle. Now the 'API Gateway stack' will depend one way on the 'Lambda stack'. fixes #9075 BREAKING CHANGE: The parameter for the method `bind()` on `IHttpRouteIntegration` has changed to accept one of type `HttpRouteIntegrationBindOptions`. The previous parameter `IHttpRoute` is now a property inside the new parameter under the key `route`. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As part of Lambda proxy integration, a
AWS::Lambda::Permissionresource is created to provide the HTTP service permission to invoke
the lambda function, creating the dependency, Permission → API.
The API, on the other hand, needs to refer to the Function's ARN and
hence creates the dependency, API → Function.
However, when the lambda function and the HTTP API are placed in
different stacks, this creates a cyclic dependency between these two
stacks.
A picture is worth a thousand words:
The fix here is to move the Lambda Permission resource into the same
stack as where the API integration is defined, thereby breaking the
dependency cycle.
Now the 'API Gateway stack' will depend one way on the 'Lambda
stack'.
fixes #9075
BREAKING CHANGE: The parameter for the method
bind()onIHttpRouteIntegrationhas changed to accept one of typeHttpRouteIntegrationBindOptions. The previous parameterIHttpRouteis now a property inside the new parameter underthe key
route.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license