AWS::ApiGateway::UsagePlan ThrottleSettings - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::ApiGateway::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 REST APIs.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


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


BurstLimit: Integer RateLimit: Number



The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption


The API target request rate limit.

Required: No

Type: Number

Minimum: 0

Update requires: No interruption

See also

  • UsagePlan in the Amazon API Gateway REST API Reference