interface QuotaSettings

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

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

Example

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

Name	Type	Description
limit?	number	The maximum number of requests that users can make within the specified time period.
offset?	number	For the initial time period, the number of requests to subtract from the specified limit.
period?	Period	The time period for which the maximum limit of requests applies.

---

limit?

Type: number (optional, default: none)

The maximum number of requests that users can make within the specified time period.

---

offset?

Type: number (optional, default: none)

For the initial time period, the number of requests to subtract from the specified limit.

---

period?

Type: Period (optional, default: none)

The time period for which the maximum limit of requests applies.