interface ThrottleSettings

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.ThrottleSettings
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#ThrottleSettings
Java	software.amazon.awscdk.services.apigatewayv2.ThrottleSettings
Python	aws_cdk.aws_apigatewayv2.ThrottleSettings
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » ThrottleSettings

Container for defining throttling parameters to API stages.

Example

const apiKey = new apigwv2.ApiKey(this, "ApiKey");

const usagePlan = new apigwv2.UsagePlan(this, "UsagePlan", {
  usagePlanName: "WebSocketUsagePlan",
  throttle: {
    rateLimit: 10,
    burstLimit: 2
  }
});

usagePlan.addApiKey(apiKey);

Properties

Name	Type	Description
burstLimit?	number	The maximum API request rate limit over a time ranging from one to a few seconds.
rateLimit?	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).