Applying tiering strategies to manage throttling in a multi-tenant system with Amazon API Gateway Usage Plans
Amazon API Gateway Usage Plans and API Keys help implement solutions for tiering strategy, managing noisy neighbor effects in a multi-tenant environment. Throttling and quotas help manage and minimize potential impacts by one tenant's ability to affect other tenants experience commonly known as noisy neighbor.
This repository contains a working demo of throttling REST APIs in Amazon API Gateway in a multi-tenant situation. Throttling is an important strategy to protect backend services from excessive load. API Gateway offers the ability to apply throttling on a per-tenant basis, so that all tenants get their fair share.
This code sample implements a tiered multi-tenant strategy which is a practical consideration at large scale, because the number API Keys available per account per region is subject to quota limits and may be significantly less than the total number of tenants.
The sample web application provides administrative functions on how customers can sign up and "purchase" API Keys at different service tiers. The sample app also allows users to call the REST API protected by API Key to test and observe throttle and quota behavior with Usage Plans.
The web app invokes REST APIs on a single Amazon API Gateway deployment. Calls that perform CRUD operations on API Keys are grouped into /admin/* and require authentication with Amazon Cognito. A single REST API, GET /api/data is protected by the Usage Plan.
See INSTALL
See WALKTHROUGH
See POOLING_AKI_KEYS
Removing the deployed assets from AWS account is done with the following commands
cd cdk
cdk destroy --all
cd react
amplify deleteNote that the default behavior of cdk destroy is to retain certain stateful resources, such as Amazon DynamoDB Tables. As this is a code sample for training only, the CDK scripts have an explicit removalPolicy to override that default behavior and remove the Amazon DynamoDB Tables as well.
See CONTRIBUTING for more information.
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opensource-codeofconduct@amazon.com with any additional questions or comments.
This library is licensed under the MIT-0 License. See the LICENSE file.
SPDX-License-Identifier: MIT-0 OSI Approved :: MIT No Attribution License (MIT-0)