メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::ApiGateway::UsagePlan

AWS::ApiGateway::UsagePlan リソースは、デプロイした Amazon API Gateway (API Gateway) API の使用プランを指定します。使用プランは、個々のクライアント API キーのスロットリングとクォータ制限を適用します。詳細については、API Gateway 開発者ガイドAmazon API Gateway で API 使用プランを作成し使用するを参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

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

YAML

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

プロパティ

ApiStages

この使用プランに関連付ける API ステージです。

Required: No

Amazon API Gateway UsagePlan ApiStageType: リスト

更新に伴う要件: 中断はありません。

Description

この使用プランの目的。

Required: No

Type: String

更新に伴う要件: 中断はありません。

Quota

指定された間隔内にユーザーが実行できるリクエストの数を設定します。

Required: No

Type: Amazon API Gateway UsagePlan QuotaSettings

更新に伴う要件: 中断はありません。

Throttle

全体的なリクエスト率 (1 秒あたりの平均リクエスト数) と増大するキャパシティを設定します。

Required: No

Type: Amazon API Gateway UsagePlan ThrottleSettings

更新に伴う要件: 中断はありません。

UsagePlanName

この使用プランの名前。

Required: No

Type: String

更新に伴う要件: 中断はありません。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により MyUsagePlan のような使用プラン ID が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

次の例では、1 か月あたり 5000 リクエストのクォータと 1 秒あたり 100 リクエストのレート制限で Prod API ステージの使用プランを作成します。

JSON

Copy
"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" } }

YAML

Copy
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

このページの内容: