AWS::ApiGateway::UsagePlan ThrottleSettings - AWS CloudFormation

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" : Double }

YAML

BurstLimit: Integer RateLimit: Double

Properties

BurstLimit

The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information about request throttling, see Manage API Request Throttling in the API Gateway Developer Guide.

Required: No

Type: Integer

Update requires: No interruption

RateLimit

The API target request steady-state rate limit. For more information about request throttling, see Manage API Request Throttling in the API Gateway Developer Guide.

Required: No

Type: Double

Update requires: No interruption

See also

  • UsagePlan in the Amazon API Gateway REST API Reference