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.

Syntax

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

JSON


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

YAML


  BurstLimit: Integer
  RateLimit: Number

Properties

BurstLimit

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

RateLimit

The API target request rate limit.