interface ThrottleSettings
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGatewayv2.ThrottleSettings |
 Java | software.amazon.awscdk.services.apigatewayv2.ThrottleSettings |
 Python | aws_cdk.aws_apigatewayv2.ThrottleSettings |
 TypeScript (source) | @aws-cdk/aws-apigatewayv2 » ThrottleSettings |
Container for defining throttling parameters to API stages.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';
const throttleSettings: apigatewayv2.ThrottleSettings = {
burstLimit: 123,
rateLimit: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| burst | number | The maximum API request rate limit over a time ranging from one to a few seconds. |
| rate | number | The API request steady-state rate limit (average requests per second over an extended period of time). |
burstLimit?
Type:
number
(optional, default: none)
The maximum API request rate limit over a time ranging from one to a few seconds.
rateLimit?
Type:
number
(optional, default: none)
The API request steady-state rate limit (average requests per second over an extended period of time).