AWS::ApiGateway::UsagePlan QuotaSettings - AWS CloudFormation

AWS::ApiGateway::UsagePlan QuotaSettings

QuotaSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies the maximum number of requests users can make to your REST APIs.

Syntax

To declare this entity in your AWS CloudFormation template, use the following 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

Update requires: No interruption

Offset

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Required: No

Type: Integer

Update requires: No interruption

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

Update requires: No interruption

See also

  • UsagePlan in the Amazon API Gateway REST API Reference