aws-cdk-lib.aws_apigatewayv2.ThrottleSettings

ThrottleSettings Struct

Container for defining throttling parameters to API stages.

Source

aws-apigatewayv2/lib/common/stage.ts

Type last changed

v2.112.0 · 1 Dec 2023

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

burstLimit?optionalnumberburst_limit?optionalint | floatburstLimit?optionalNumberBurstLimit?optionaldoubleBurstLimit?optional*float64= none#

The maximum API request rate limit over a time ranging from one to a few seconds.

rateLimit?optionalnumberrate_limit?optionalint | floatrateLimit?optionalNumberRateLimit?optionaldoubleRateLimit?optional*float64= none#

The API request steady-state rate limit (average requests per second over an extended period of time).