feat(apigateway): rate limited API key #6509

vaibhav-walia · 2020-02-28T20:34:08Z

Commit Message

feat(apigateway): rate limited API key (#6509)

In cases when we need to configure throttling and quotas etc., at the api key level, we need to create a usage plan for the api key and link the two.
This commit introduces a construct which allows the user to create an api key and spicify rate limiting settings, while creating the api key and not worry about creating usage plan and linking the two.

fixes #6405

End Commit Message

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

… at api key level In cases when we need to configure throttling and quotas etc., at the api key level, we need to create a usage plan for the api key and link the two. This commit introduces a construct which allows the user to create an api key and spicify rate limiting settings, while creating the api key and not worry about creating usage plan and linking the two. fixes aws#6405

aws-cdk-automation · 2020-02-28T21:17:23Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 81f9454
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

… at api key level In cases when we need to configure throttling and quotas etc., at the api key level, we need to create a usage plan for the api key and link the two. This commit introduces a construct which allows the user to create an api key and spicify rate limiting settings, while creating the api key and not worry about creating usage plan and linking the two. fixes aws#6405

aws-cdk-automation · 2020-02-28T23:07:11Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: b677b31
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

packages/@aws-cdk/aws-apigateway/lib/rate-limited-api-key.ts

packages/@aws-cdk/aws-apigateway/README.md

packages/@aws-cdk/aws-apigateway/lib/rate-limited-api-key.ts

… at api key level In cases when we need to configure throttling and quotas etc., at the api key level, we need to create a usage plan for the api key and link the two. This commit introduces a construct which allows the user to create an api key and spicify rate limiting settings, while creating the api key and not worry about creating usage plan and linking the two. fixes aws#6405

Pull request has been modified.

… at api key level In cases when we need to configure throttling and quotas etc., at the api key level, we need to create a usage plan for the api key and link the two. This commit introduces a construct which allows the user to create an api key and spicify rate limiting settings, while creating the api key and not worry about creating usage plan and linking the two. fixes aws#6405

aws-cdk-automation · 2020-03-04T23:05:04Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 4eafcb5
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-04T23:12:35Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: c56bdec
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

packages/@aws-cdk/aws-apigateway/README.md

nija-at · 2020-03-09T17:51:15Z

packages/@aws-cdk/aws-apigateway/lib/api-key.ts

@@ -20,6 +20,7 @@ export interface IApiKey extends IResourceBase {
 */
 export interface ApiKeyProps extends ResourceOptions {
  /**
+   * [disable-awslint:ref-via-interface]


Why is this needed? We generally don't encourage any new linter exclusions.

The build was failing after I made RateLimitedApiKeyProps extend ApiKeyProps :

error: [awslint:ref-via-interface:@aws-cdk/aws-apigateway.RateLimitedApiKeyProps.resources] API should use interface and not the concrete class (@aws-cdk/aws-apigateway.RestApi). If this is intentional, add "[disable-awslint:ref-via-interface]" to element's jsdoc

So I followed the suggestion and added [disable-awslint:ref-via-interface] to the jsdoc of resources property in ApiKeyProps

I see it now.

I believe this is occurring because this object is using RestApi instead of IRestApi as the type for resources.
Can we try switching it to IRestApi and see if all tests still pass?

I tried doing that, but it resulted in compilation errors as renderStageKeys method expects resources to be of type RestApi and changing it to IRestApi is not possible as it doesn't have deploymentStage property needed by this method
https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-apigateway/lib/api-key.ts#L90-L101

packages/@aws-cdk/aws-apigateway/lib/rate-limited-api-key.ts

Co-Authored-By: Niranjan Jayakar <[email protected]>

Pull request has been modified.

aws-cdk-automation · 2020-03-09T19:08:19Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 4bccb02
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-09T19:11:27Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 4bccb02
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

… at api key level Incorporates changes from code review.

aws-cdk-automation · 2020-03-09T21:25:20Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 9493c35
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

nija-at · 2020-03-10T09:12:07Z

packages/@aws-cdk/aws-apigateway/lib/api-key.ts

@@ -20,6 +20,7 @@ export interface IApiKey extends IResourceBase {
 */
 export interface ApiKeyProps extends ResourceOptions {
  /**
+   * [disable-awslint:ref-via-interface]


I see it now.

I believe this is occurring because this object is using RestApi instead of IRestApi as the type for resources.
Can we try switching it to IRestApi and see if all tests still pass?

nija-at · 2020-03-10T09:14:37Z

packages/@aws-cdk/aws-apigateway/lib/rate-limited-api-key.ts

+/**
+ * RateLimitedApiKey properties.
+ */
+export interface RateLimitedApiKeyProps extends ApiKeyProps {


Missed something from last time. We usually don't extend one Props class from another Props class.

The following changes are needed here

Rename ApiKeyProps to ApiKeyOptions

Create a new empty ApiKeyProps class -
export interface ApiKeyProps extends ApiKeyOptions { }

Not sure if I understand.

Is the suggestion to :

Rename ApiKeyProps defined in ApiKey, to ApiKeyOptions

Create an empty interface (ApiKeyProps) in RateLimitedApiKey extending ApiKeyOptions

Use it like

export interface RateLimitedApiKeyProps extends ApiKeyProps {

If that's the case, I'm confused how it will help/is better

You're correct. I think I was looking for an optimization/future-proofing whose value is unclear yet. Ignore this.

mergify · 2020-03-11T13:52:59Z

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-cdk-automation · 2020-03-11T14:25:39Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: dd6269a
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Pull request has been modified.

aws-cdk-automation · 2020-03-11T16:44:26Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 6dcce28
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2020-03-11T16:46:23Z

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-cdk-automation · 2020-03-11T17:30:24Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 05c8742
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2020-03-11T17:30:50Z

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).

SomayaB assigned nija-at Feb 28, 2020

nija-at previously requested changes Mar 4, 2020

View reviewed changes

vaibhav-walia requested a review from nija-at March 6, 2020 06:41

nija-at changed the title ~~feat(apigateway): Adds construct which allow configuring ratelimiting…~~ feat(apigateway): rate limited API key Mar 9, 2020

nija-at previously requested changes Mar 9, 2020

View reviewed changes

Apply suggestions from code review

4bccb02

Co-Authored-By: Niranjan Jayakar <[email protected]>

feat(apigateway): Adds construct which allow configuring ratelimiting…

9493c35

… at api key level Incorporates changes from code review.

vaibhav-walia requested a review from nija-at March 9, 2020 22:13

nija-at suggested changes Mar 10, 2020

View reviewed changes

nija-at previously approved these changes Mar 11, 2020

View reviewed changes

Merge branch 'master' into master

dd6269a

Merge branch 'master' into master

6dcce28

nija-at approved these changes Mar 11, 2020

View reviewed changes

Merge branch 'master' into master

05c8742

mergify bot merged commit 040906f into aws:master Mar 11, 2020

snyk-bot mentioned this pull request Apr 10, 2020

[Snyk] Upgrade aws-cdk from 1.28.0 to 1.30.0 ammobinDOTca/ammobin-cdk#2

Closed

akagire mentioned this pull request Sep 22, 2024

docs(apigateway): update RateLimitedApiKey example code #31490

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(apigateway): rate limited API key #6509

feat(apigateway): rate limited API key #6509

vaibhav-walia commented Feb 28, 2020 •

edited by nija-at

Loading

aws-cdk-automation commented Feb 28, 2020

aws-cdk-automation commented Feb 28, 2020

aws-cdk-automation commented Mar 4, 2020

aws-cdk-automation commented Mar 4, 2020

nija-at Mar 9, 2020

vaibhav-walia Mar 9, 2020

nija-at Mar 10, 2020

vaibhav-walia Mar 10, 2020

aws-cdk-automation commented Mar 9, 2020

aws-cdk-automation commented Mar 9, 2020

aws-cdk-automation commented Mar 9, 2020

nija-at Mar 10, 2020

nija-at Mar 10, 2020

vaibhav-walia Mar 10, 2020

nija-at Mar 11, 2020

mergify bot commented Mar 11, 2020

aws-cdk-automation commented Mar 11, 2020

aws-cdk-automation commented Mar 11, 2020

mergify bot commented Mar 11, 2020

aws-cdk-automation commented Mar 11, 2020

mergify bot commented Mar 11, 2020

feat(apigateway): rate limited API key #6509

feat(apigateway): rate limited API key #6509

Conversation

vaibhav-walia commented Feb 28, 2020 • edited by nija-at Loading

Commit Message

End Commit Message

aws-cdk-automation commented Feb 28, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Feb 28, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 4, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 4, 2020

AWS CodeBuild CI Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-cdk-automation commented Mar 9, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 9, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 9, 2020

AWS CodeBuild CI Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mergify bot commented Mar 11, 2020

aws-cdk-automation commented Mar 11, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 11, 2020

AWS CodeBuild CI Report

mergify bot commented Mar 11, 2020

aws-cdk-automation commented Mar 11, 2020

AWS CodeBuild CI Report

mergify bot commented Mar 11, 2020

vaibhav-walia commented Feb 28, 2020 •

edited by nija-at

Loading