AWS::ApiGateway::UsagePlan QuotaSettings - Amazon CloudFormation
SyntaxPropertiesSee also
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 QuotaSettings

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

In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Budgets to monitor costs and Amazon WAF to manage API requests.

Syntax

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

JSON

{
  "Limit" : Integer,
  "Offset" : Integer,
  "Period" : String
}

YAML

  Limit: Integer
  Offset: Integer
  Period: String

Properties

Limit

The target maximum number of requests that can be made in a given time period.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

Offset

The number of requests subtracted from the given limit in the initial time period.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

Period

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Required: No

Type: String

Allowed values: DAY | WEEK | MONTH

Update requires: No interruption

See also

  • UsagePlan in the Amazon API Gateway REST API Reference