aws-cdk-lib.aws_apigateway.CfnUsagePlan.QuotaSettingsProperty

interface QuotaSettingsProperty

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnUsagePlan.QuotaSettingsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnUsagePlan_QuotaSettingsProperty
Javasoftware.amazon.awscdk.services.apigateway.CfnUsagePlan.QuotaSettingsProperty
Pythonaws_cdk.aws_apigateway.CfnUsagePlan.QuotaSettingsProperty
TypeScript aws-cdk-lib » aws_apigateway » CfnUsagePlan » QuotaSettingsProperty

QuotaSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies a target for the maximum number of requests users can make to your REST APIs.

In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using AWS Budgets to monitor costs and AWS WAF to manage API requests.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const quotaSettingsProperty: apigateway.CfnUsagePlan.QuotaSettingsProperty = {
  limit: 123,
  offset: 123,
  period: 'period',
};

Properties

NameTypeDescription
limit?numberThe target maximum number of requests that can be made in a given time period.
offset?numberThe number of requests subtracted from the given limit in the initial time period.
period?stringThe time period in which the limit applies.

limit?

Type: number (optional)

The target maximum number of requests that can be made in a given time period.


offset?

Type: number (optional)

The number of requests subtracted from the given limit in the initial time period.


period?

Type: string (optional)

The time period in which the limit applies.

Valid values are "DAY", "WEEK" or "MONTH".