Throttle API Stage

Question

I am finding the documentation a little confusing. I am trying to throttle a method and do not know how to do this in cloud formation:  
  
  ProviderAPIUsagePlan:  
    Type: 'AWS::ApiGateway::UsagePlan'  
    Properties:  
      ApiStages:  
        - ApiId: !Ref ProviderAPIGatewayID  
          Stage: Prod  
          **Throttle:**  
             **'/route/{routeId}/PATCH'**  
             **BurstLimit: 30**  
             **RateLimit: 30**  
      Description: Provider API usage plan  
      Quota:  
        Limit: 100000  
        Period: WEEK  
      UsagePlanName: !Sub   
        - 'bill-usage'  
On the Stage I need to specify the path and method but I also need to specify the BurstLimit and RateLimit.

billbeckett · Answer

I did it like this:  
ProviderAPIUsagePlan:  
Type: 'AWS::ApiGateway::UsagePlan'  
Properties:  
ApiStages:  
- ApiId: !Ref ProviderAPIGatewayID  
Stage: Prod  
Throttle:  
'/route/{routeId}/PATCH':  
BurstLimit: 30  
RateLimit: 30  
Description: Provider API usage plan  
Quota:  
Limit: 100000  
Period: WEEK  
UsagePlanName: !Sub  
- 'bill-usage'

Throttle API Stage

Add your answer

Relevant content