AWS::ApiGatewayV2::Deployment - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::ApiGatewayV2::Deployment

AWS::ApiGatewayV2::Deployment 资源为 API 创建部署。

语法

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

JSON

{ "Type" : "AWS::ApiGatewayV2::Deployment", "Properties" : { "ApiId" : String, "Description" : String, "StageName" : String } }

YAML

Type: AWS::ApiGatewayV2::Deployment Properties: ApiId: String Description: String StageName: String

属性

ApiId

API 标识符。

必需:是

类型:字符串

Update requires: Replacement

Description

部署资源的描述。

必需:否

类型:字符串

Update requires: No interruption

StageName

要创建的 Deployment 资源的 Stage 资源的名称。

必需:否

类型:字符串

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回部署 ID,例如 123abc

For more information about using the Ref function, see Ref.

示例

部署创建示例

以下示例为 MyApi API 创建 deployment 资源,它具有已定义的 MyRoute 路由。

JSON

{ "Deployment": { "Type": "AWS::ApiGatewayV2::Deployment", "DependsOn": [ "MyRoute" ], "Properties": { "Description": "My deployment", "ApiId": { "Ref": "MyApi" }, "StageName": "Beta" } } }

YAML

Deployment: Type: 'AWS::ApiGatewayV2::Deployment' DependsOn: - MyRoute Properties: Description: My deployment ApiId: !Ref MyApi StageName: Beta

另请参阅