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

AWS::ApiGateway::ApiKey

AWS::ApiGateway::ApiKey 资源创建唯一密钥,您可将该密钥分发到需要 API 密钥来执行 Amazon API Gateway (API 网关) Method 资源的客户端。要指定客户端必须使用什么 API 密钥,请将 API 密钥映射到包含需要密钥的方法的 RestApiStage 资源。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::ApiGateway::ApiKey", "Properties" : { "Description" : String, "Enabled" : Boolean, "Name" : String, "StageKeys" : [ StageKey, ... ] } }

YAML

Type: "AWS::ApiGateway::ApiKey" Properties: Description: String Enabled: Boolean Name: String StageKeys: - StageKey - ...

属性

Description

API 密钥用途的描述。

Required: No

Type: String

更新要求无需中断

Enabled

指示客户端是否可以使用 API 密钥。

Required: No

Type: Boolean

更新要求无需中断

Name

API 密钥的名称。如果不指定名称,则 AWS CloudFormation 会生成一个唯一物理 ID 并将该 ID 用作 API 密钥名称。有关更多信息,请参阅 名称类型

重要

如果指定一个名称,您将无法执行需要替换此资源的更新。您可以执行不需要或者只需要部分中断的更新。如果必须替换资源,请指定新名称。

Required: No

Type: String

更新要求替换

StageKeys

与此 API 密钥关联的阶段列表。

Required: No

Type: Amazon API Gateway ApiKey StageKey 列表

更新要求无需中断

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回 API 密钥 ID,例如 m2m1k7sybf

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

示例

下面的示例创建 API 密钥并将其与 TestAPIDeployment 部署的 Test 阶段关联。为确保 AWS CloudFormation 在 API 密钥之前创建阶段和部署(在相同模板中的其他位置声明),该示例在部署和阶段上添加了明确依赖关系。没有此依赖关系时,AWS CloudFormation 可能会先创建 API 密钥,导致关联失败,因为部署和阶段还不存在。

JSON

"ApiKey": { "Type": "AWS::ApiGateway::ApiKey", "DependsOn": ["TestAPIDeployment", "Test"], "Properties": { "Name": "TestApiKey", "Description": "CloudFormation API Key V1", "Enabled": "true", "StageKeys": [{ "RestApiId": { "Ref": "RestApi" }, "StageName": "Test" }] } }

YAML

ApiKey: Type: "AWS::ApiGateway::ApiKey" DependsOn: - "TestAPIDeployment" - "Test" Properties: Name: "TestApiKey" Description: "CloudFormation API Key V1" Enabled: "true" StageKeys: - RestApiId: Ref: "RestApi" StageName: "Test"

本页内容: