AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::UsagePlan

ApiGateway UsagePlan

The AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control cost...

Properties

6 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
ApiStages
Array<ApiStage>
Description
string
Quota
QuotaSettings
Tags
Array<Tag>
Throttle
ThrottleSettings
UsagePlanName
string

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Idstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGateway::UsagePlan

Resources:
  MyResource:
    Type: AWS::ApiGateway::UsagePlan
    Properties:
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:POSTapigateway:GETapigateway:PUT

read

apigateway:GET

update

apigateway:GETapigateway:DELETEapigateway:PATCHapigateway:PUT

delete

apigateway:DELETEapigateway:GETapigateway:PATCH

list

apigateway:GET

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceApiGateway
Properties7
Required0
TaggingSupported
Primary IDId

Supported Operations

CreateReadUpdateDeleteList

Related Resources

External Links