interface ThrottleSettings
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Apigatewayv2.ThrottleSettings |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#ThrottleSettings |
![]() | software.amazon.awscdk.services.apigatewayv2.ThrottleSettings |
![]() | aws_cdk.aws_apigatewayv2.ThrottleSettings |
![]() | aws-cdk-lib » aws_apigatewayv2 » ThrottleSettings |
Container for defining throttling parameters to API stages.
Example
declare const api: apigwv2.HttpApi;
new apigwv2.HttpStage(this, 'Stage', {
httpApi: api,
throttle: {
rateLimit: 1000,
burstLimit: 1000,
},
detailedMetricsEnabled: true,
});
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).