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

AWS::ApiGateway::Deployment

AWS::ApiGateway::Deployment 资源部署 Amazon API Gateway (API 网关) RestApi 资源到一个阶段,这样客户端可以通过 Internet 调用 API。该阶段用作环境。

语法

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

JSON

{ "Type" : "AWS::ApiGateway::Deployment", "Properties" : { "Description" : String, "RestApiId" : String, "StageDescription" : StageDescription, "StageName" : String } }

YAML

Type: "AWS::ApiGateway::Deployment" Properties: Description: String RestApiId: String StageDescription: StageDescription StageName: String

属性

Description

API 网关 部署用途的描述。

Required: No

Type: String

更新要求无需中断

RestApiId

要部署的 RestApi 资源的 ID。

Required: Yes

Type: String

更新要求替换

StageDescription

配置 API 网关 随此部署创建的阶段。

Required: No

Type: Amazon API Gateway Deployment StageDescription

更新要求无需中断

StageName

API 网关 随此部署创建的阶段的名称。仅使用字母数字字符。

Required: No

Type: String

更新要求无需中断

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回部署 ID,例如 123abc

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

示例

以下部分提供了用于声明 API 网关 部署的示例。

带有空嵌入式阶段的部署

以下示例部署 MyApi API 到名为 DummyStage 阶段。

JSON

"Deployment": { "Type": "AWS::ApiGateway::Deployment", "Properties": { "RestApiId": { "Ref": "MyApi" }, "Description": "My deployment", "StageName": "DummyStage" } }

YAML

Deployment: Type: "AWS::ApiGateway::Deployment" Properties: RestApiId: Ref: "MyApi" Description: "My deployment" StageName: "DummyStage"

AWS::ApiGateway::Method 依赖关系

如果您在与部署相同的模板中创建了 AWS::ApiGateway::RestApi 资源及其方法(使用 AWS::ApiGateway::Method),则该部署必须依赖于 RestApi 的方法。要创建依赖关系,请添加 DependsOn 属性到部署。如果您没有添加,则 AWS CloudFormation 在创建不包含任何方法的 RestApi 资源之后立即创建部署,并且 AWS CloudFormation 将遇到以下错误:The REST API doesn't contain any methods

JSON

"Deployment": { "DependsOn": "MyMethod", "Type": "AWS::ApiGateway::Deployment", "Properties": { "RestApiId": { "Ref": "MyApi" }, "Description": "My deployment", "StageName": "DummyStage" } }

YAML

Deployment: DependsOn: "MyMethod" Type: "AWS::ApiGateway::Deployment" Properties: RestApiId: Ref: "MyApi" Description: "My deployment" StageName: "DummyStage"

本页内容: