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

Amazon API Gateway ApiKey StageKey

StageKey は、AWS::ApiGateway::ApiKey リソースのプロパティで、API キーと関連付ける Amazon API Gateway (API ゲートウェイ) ステージを指定します。この関連付けにより、キーを持つクライアントだけがそのステージ内のメソッドにリクエストを行うことができます。

構文

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

JSON

Copy
{ "RestApiId" : String, "StageName" : String }

YAML

Copy
RestApiId: String StageName: String

プロパティ

RestApiId

API キーを関連付けるステージを含む RestApi リソースの ID。

Required: No

Type: String

StageName

API キーを関連付けるステージの名前。ステージは、RestApiId プロパティで指定した RestApi リソースに含める必要があります。

Required: No

Type: String

このページの内容: