AWS CDK Reference

Appearance

v2.275.0

QuotaSettings Struct ​

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

Source
aws-apigateway/lib/usage-plan.ts

Example ​

ts
declare const api: apigateway.RestApi;

const key = new apigateway.RateLimitedApiKey(this, 'rate-limited-api-key', {
  customerId: 'hello-customer',
  apiStages: [{ stage: api.deploymentStage }],
  quota: {
    limit: 10000,
    period: apigateway.Period.MONTH
  }
});

Properties ​

limitoptionalnumberlimitoptionalint | floatlimitoptionalNumberLimitoptionaldoubleLimitoptional*float64= none#
The maximum number of requests that users can make within the specified time period.
offsetoptionalnumberoffsetoptionalint | floatoffsetoptionalNumberOffsetoptionaldoubleOffsetoptional*float64= none#
For the initial time period, the number of requests to subtract from the specified limit.
periodoptionalPeriodperiodoptionalPeriodperiodoptionalPeriodPeriodoptionalPeriodPeriodoptionalPeriod= none#
The time period for which the maximum limit of requests applies.