aws-cdk-lib.aws_apigatewayv2.Period

Period Enum

Time period for which quota settings apply.

Source

aws-apigatewayv2/lib/websocket/usage-plan.ts

Type last changed

v2.212.0 · 20 Aug 2025

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
  }
});

Members

Member	Description
DAY	The quota resets every day.
WEEK	The quota resets every week.
MONTH	The quota resets every month.

Referenced by

• QuotaSettings.periodperiodperiodPeriodPeriod