@aws-cdk_aws-apigatewayv2-alpha.ThrottleSettings
interface ThrottleSettings
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Apigatewayv2.Alpha.ThrottleSettings |
![]() | github.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#ThrottleSettings |
![]() | software.amazon.awscdk.services.apigatewayv2.alpha.ThrottleSettings |
![]() | aws_cdk.aws_apigatewayv2_alpha.ThrottleSettings |
![]() | @aws-cdk/aws-apigatewayv2-alpha ยป 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_alpha from '@aws-cdk/aws-apigatewayv2-alpha';
const throttleSettings: apigatewayv2_alpha.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).