Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon API Gateway UsagePlan QuotaSettings

QuotaSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies the maximum number of requests users can make to your Amazon API Gateway (API Gateway) APIs.

Syntax

JSON

{ "Limit" : Integer, "Offset" : Integer, "Period" : String }

YAML

Limit: Integer Offset: Integer Period: String

Properties

Limit

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

Required: No

Type: Integer

Offset

For the initial time period, the number of requests to subtract from the specified limit. When you first implement a usage plan, the plan might start in the middle of the week or month. With this property, you can decrease the limit for this initial time period.

Required: No

Type: Integer

Period

The time period for which the maximum limit of requests applies, such as DAY or WEEK. For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference.

Required: No

Type: String

On this page: