AWS CDK Reference

Appearance

v2.274.0

QuotaSettings Struct ​

Specifies the maximum number of requests that clients can make to API Gateway APIs.

Source
aws-apigatewayv2/lib/websocket/usage-plan.ts
Type last changed
v2.212.0 · 20 Aug 2025

Example ​

ts
declare const api: apigwv2.WebSocketApi;
declare const stage: apigwv2.WebSocketStage;

const key = new apigwv2.RateLimitedApiKey(this, 'rate-limited-api-key', {
  customerId: 'test-customer',
  apiStages: [{
    api: api,
    stage: stage
  }],
  quota: {
    limit: 10000,
    period: apigwv2.Period.MONTH
  },
  throttle: {
    rateLimit: 100,
    burstLimit: 200
  }
});

Properties ​

limitnumberlimitint | floatlimitNumberLimitdoubleLimit*float64= none#
The maximum number of requests that users can make within the specified time period.
offsetnumberoffsetint | floatoffsetNumberOffsetdoubleOffset*float64= none#
For the initial time period, the number of requests to subtract from the specified limit.
periodPeriodperiodPeriodperiodPeriodPeriodPeriodPeriodPeriod= none#
The time period for which the maximum limit of requests applies.