AWS::ApiGateway::UsagePlan

The AWS::ApiGateway::UsagePlan resource specifies a usage plan for deployed Amazon API Gateway (API Gateway) APIs. A usage plan enforces throttling and quota limits on individual client API keys. For more information, see Creating and Using API Usage Plans in Amazon API Gateway in the API Gateway Developer Guide.

Syntax

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

{
  "Type" : "AWS::ApiGateway::UsagePlan",
  "Properties" : {
    "ApiStages" : [ ApiStage, ... ],
    "Description" : String,
    "Quota" : QuotaSettings,
    "Throttle" : ThrottleSettings,
    "UsagePlanName" : String
  }
}

Type: AWS::ApiGateway::UsagePlan
Properties:
  ApiStages: 
  - ApiStage
  Description: String
  Quota: QuotaSettings
  Throttle: ThrottleSettings
  UsagePlanName: String

Properties

Return Value

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the usage plan ID, such as MyUsagePlan.

For more information about using the Ref function, see Ref.

Examples

The following examples create a usage plan for the Prod API stage, with a quota of 5000 requests per month and a rate limit of 100 requests per second.

"usagePlan" : {
  "Type" : "AWS::ApiGateway::UsagePlan",
  "Properties" : {
    "ApiStages" : [ {"ApiId" : { "Ref" : "MyRestApi" }, "Stage" : { "Ref" : "Prod" }} ],
    "Description" : "Customer ABC's usage plan",
    "Quota" : {
      "Limit" : 5000,
      "Period" : "MONTH"
    },
    "Throttle" : {
      "BurstLimit" : 200,
      "RateLimit" : 100
    },
    "UsagePlanName" : "Plan_ABC"
  }
}

usagePlan:
  Type: AWS::ApiGateway::UsagePlan
  Properties:
    ApiStages:
    - ApiId: !Ref 'MyRestApi'
      Stage: !Ref 'Prod'
    Description: Customer ABC's usage plan
    Quota:
      Limit: 5000
      Period: MONTH
    Throttle:
      BurstLimit: 200
      RateLimit: 100
    UsagePlanName: Plan_ABC

On this page:

• Syntax
• Properties
• Return Value
• Examples