AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::ApiGateway::UsagePlanKey

AWS::ApiGateway::UsagePlanKey 资源将 Amazon API Gateway API 密钥关联到某个 API 网关 使用计划。该关联用于确定将使用计划应用到哪些用户。

语法

JSON

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

YAML

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

更新要求替换

返回值

Ref

当该资源的逻辑 ID 提供给 Ref内部函数时,Ref 将返回资源名称。 示例:

{ "Ref": "MyProfile" }

对于逻辑 ID 为 MyProfileIAM::InstanceProfileRef 将返回资源名称。

有关使用 Ref 功能的更多信息,请参阅参考

示例

JSON

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

YAML

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

本页内容: