AWS ドキュメント » AWS CloudFormation » ユーザーガイド » テンプレートリファレンス » AWS リソースおよびプロパティタイプのリファレンス » Amazon API Gateway リソースタイプのリファレンス » AWS::ApiGateway::UsagePlan » Amazon API Gateway UsagePlan ApiStage

Filter View: All JSON YAML

Amazon API Gateway UsagePlan ApiStage

ApiStage は、どの Amazon API Gateway (API Gateway) ステージと API を使用プランに関連付けるかを指定する AWS::ApiGateway::UsagePlan リソースのプロパティです。

構文

JSON

{
  "ApiId" : String,
  "Stage" : String,
  "Throttle" : { String: [ ThrottleSettings, ...  ] }
}

YAML

ApiId: String
Stage: String
Throttle: 
  String:
    - ThrottleSettings

プロパティ

ApiId

使用プランと関連付ける指定された Stage プロパティにある API の ID。

Required: No

Type: String

Stage

使用プランに関連付ける API Gateway ステージ名。

Required: No

Type: String

Throttle

使用量プランで API ステージに関するメソッドレベルのスロットリング情報が含まれるマッピング。

重複は許可されません。

Required: No

Type: 文字列から Amazon API Gateway UsagePlan ThrottleSettings へのマッピング

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