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

AWS::ApiGateway::UsagePlanKey

AWS::ApiGateway::UsagePlanKey リソースは、API Gateway で Amazon API Gateway API キーを使用量プランに関連付けます。この関連付けにより、どのユーザーに使用量プランが適用されるかが決まります。

構文

JSON

Copy
{ "Type" : "AWS::ApiGateway::UsagePlanKey", "Properties" : { "KeyId" : String, "KeyType" : String, "UsagePlanId" : String } }

YAML

Copy
Type: "AWS::ApiGateway::UsagePlanKey" Properties: KeyId: String KeyType: String UsagePlanId: String

プロパティ

KeyId

使用量プランキーの ID です。

Required: Yes

Type: String

更新に伴う要件: 置換

KeyType

使用プランキーのタイプです。現在、有効なキータイプは API_KEY です。

Required: Yes

Type: String

更新に伴う要件: 置換

UsagePlanId

使用量プランキーの値です。

Required: Yes

Type: String

更新に伴う要件: 置換

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりリソース名が返されます。 例:

Copy
{ "Ref": "MyProfile" }

論理 ID MyProfile を持つ IAM::InstanceProfile に対し、Ref はリソース名を返します。

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

JSON

Copy
"usagePlanKey" : { "Type": "AWS::ApiGateway::UsagePlanKey", "Properties": { "KeyId" : {"Ref" : "myApiKey"}, "KeyType" : "API_KEY", "UsagePlanId" : {"Ref" : "myUsagePlan"} } }

YAML

Copy
usagePlanKey: Type: "AWS::ApiGateway::UsagePlanKey" Properties : KeyId: !Ref 'myApiKey' KeyType: API_KEY UsagePlanId: !Ref 'myUsagePlan'

このページの内容: