aws-cdk-lib.aws_apigateway.QuotaSettings

interface QuotaSettings

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.QuotaSettings
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#QuotaSettings
Javasoftware.amazon.awscdk.services.apigateway.QuotaSettings
Pythonaws_cdk.aws_apigateway.QuotaSettings
TypeScript (source)aws-cdk-lib » aws_apigateway » QuotaSettings

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

Example

declare const api: apigateway.RestApi;

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

Properties

NameTypeDescription
limit?numberThe maximum number of requests that users can make within the specified time period.
offset?numberFor the initial time period, the number of requests to subtract from the specified limit.
period?PeriodThe 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.