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

Amazon API Gateway UsagePlan ThrottleSettings

ThrottleSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies the overall request rate (average requests per second) and burst capacity when users call your Amazon API Gateway (API Gateway) APIs.

Syntax

JSON

Copy
{ "BurstLimit" : Integer, "RateLimit" : Number }

YAML

Copy
BurstLimit: Integer RateLimit: Number

Properties

BurstLimit

The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity. For more information about request throttling, see Manage API Request Throttling in the API Gateway Developer Guide.

Required: No

Type: Integer

RateLimit

The API request steady-state rate limit (average requests per second over an extended period of time). For more information about request throttling, see Manage API Request Throttling in the API Gateway Developer Guide.

Required: No

Type: Number