fix(apigateway): LambdaRestApi fails when a user defined Stage is attached #5838
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
…ached LambdaRestApi, by default, sets up a proxy integration as part of its construction which in turn binds the specified lambda function handler to the proxy using the LambdaIntegration class. The LambdaIntegration class needs to set up the right IAM permissions so API Gateway is able to invoke the Lambda function. The policy for this permission requires the ARN of the 'ANY' Method that is set up by the Proxy. When the 'deploy' option is set, it indicates to the RestApi construct and its sub-constructs (of which LambdaRestApi is one) to create a default deployment and stage as part of its construction. The user can also unset the 'deploy' option and specify their own Stage by setting the 'deploymentStage' on the RestApi construct. However, when the 'deploy' option is unset, the LambdaIntegration class cannot compute the ARN for the 'ANY' Method since there's no Stage and Deployment created. This generates at synthesis, even though there may be a Stage that the user has configured against the RestApi later on. The fix here is straightforward. Computation of the Method ARN should occur at the time of synthesis rather than at the time of construction. fixes #5744
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
rix0rrr
approved these changes
Jan 17, 2020
|
Thank you for contributing! Your pull request is now being automatically merged. |
RomainMuller
approved these changes
Jan 17, 2020
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request is now being automatically merged. |
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.
LambdaRestApi, by default, sets up a proxy integration as part of its
construction which in turn binds the specified lambda function handler
to the proxy using the LambdaIntegration class.
The LambdaIntegration class needs to set up the right IAM permissions
so API Gateway is able to invoke the Lambda function. The policy for
this permission requires the ARN of the 'ANY' Method that is set up by
the Proxy.
When the 'deploy' option is set, it indicates to the RestApi construct
and its sub-constructs (of which LambdaRestApi is one) to create a
default deployment and stage as part of its construction. The user can
also unset the 'deploy' option and specify their own Stage by setting
the 'deploymentStage' on the RestApi construct.
However, when the 'deploy' option is unset, the LambdaIntegration class
cannot compute the ARN for the 'ANY' Method since there's no Stage and
Deployment associated. This produces an error when LambdaRestApi is
constructed, even though the user may configure a Stage later on.
The fix here is straightforward. Computation of the Method ARN should
occur at the time of synthesis rather than at the time of construction.
fixes #5744
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license