fix(apigateway): cannot create an ApiKey with an imported RestApi #22368
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
The current implementation of `ApiKey` is a little confusing. It takes a `resources` property which expects a list of `IRestApi`s. An ApiKey is not associated with a RestApi by itself though, it needs to be associated with a specific `Stage` on the RestApi. When you import a RestApi you cannot import it with a `Stage` and even if you could provide an `IStage` I don't think that makes the most sense (you can have multiple stages). Instead, this PR deprecates the `resources` prop and adds a new `stages` prop which expects a list of `IStage`s. To facilitate this I have also done a couple of other things - Added the ability to import a Stage using `Stage.fromStageAttributes()`. - Added an `addApiKey` method to `IStage`. - Added additional error handling if the user does try to create an ApiKey with an imported RestApi. fixes #22102
|
|
comcalvi
approved these changes
Oct 11, 2022
|
Thank you for contributing! Your pull request will be updated from main 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 |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
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.
The current implementation of
ApiKeyis a little confusing. It takes aresourcesproperty which expects a list ofIRestApis. An ApiKey is not associated with a RestApi by itself though, it needs to be associated with a specificStageon the RestApi. When you import a RestApi you cannot import it with aStageand even if you could provide anIStageI don't think that makes the most sense (you can have multiple stages).Instead, this PR deprecates the
resourcesprop and adds a newstagesprop which expects a list ofIStages. To facilitate this I have also done a couple of other thingsStage.fromStageAttributes().addApiKeymethod toIStage.fixes #22102
All Submissions:
Adding new Unconventional Dependencies:
New Features
yarn integto deploy the infrastructure and generate the snapshot (i.e.yarn integwithout--dry-run)?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license