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

AWS::ApiGatewayV2::RouteResponse

AWS::ApiGatewayV2::RouteResponse 资源为 WebSocket API 创建路由响应。有关更多信息,请参阅 API Gateway 开发人员指南中的在 API Gateway 中设置 WebSocket API 的路由响应

语法

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

JSON

{ "Type" : "AWS::ApiGatewayV2::RouteResponse", "Properties" : { "ApiId" : String, "ModelSelectionExpression" : String, "ResponseModels" : Json, "ResponseParameters" : Json, "RouteId" : String, "RouteResponseKey" : String } }

YAML

Type: AWS::ApiGatewayV2::RouteResponse Properties: ApiId: String ModelSelectionExpression: String ResponseModels: Json ResponseParameters: Json RouteId: String RouteResponseKey: String

属性

ApiId

API 标识符。

必需:是

类型:字符串

Update requires: Replacement

ModelSelectionExpression

路由响应的模型选择表达式。仅 WebSocket API 支持。

必需:否

类型:字符串

Update requires: No interruption

ResponseModels

路由响应的响应模型。

必需:否

类型:Json

Update requires: No interruption

ResponseParameters

路由响应参数。

必需:否

类型:Json

Update requires: No interruption

RouteId

路由 ID。

必需:是

类型:字符串

Update requires: Replacement

RouteResponseKey

路由响应键。

必需:是

类型:字符串

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 Route Response 资源 ID,例如 abc123

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

示例

路由响应创建示例

以下示例为名为 MyApi 的 WebSocket API 创建一个 RouteResponse 资源(已具有一个名为 MyIntegrationintegration 和一个名为 MyRouteroute)。

JSON

{ "MyRouteResponse": { "Type": "AWS::ApiGatewayV2::RouteResponse", "Properties": { "RouteId": { "Ref": "MyRoute" }, "ApiId": { "Ref": "MyApi" }, "RouteResponseKey": "$default" } } }

YAML

MyRouteResponse: Type: 'AWS::ApiGatewayV2::RouteResponse' Properties: RouteId: !Ref MyRoute ApiId: !Ref MyApi RouteResponseKey: $default

另请参阅