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

AWS::ApiGatewayV2::IntegrationResponse

AWS::ApiGatewayV2::IntegrationResponse 资源更新 WebSocket API 的集成响应。有关更多信息,请参阅 API Gateway 开发人员指南中的在 API Gateway 中设置 WebSocket API 集成响应

语法

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

JSON

{ "Type" : "AWS::ApiGatewayV2::IntegrationResponse", "Properties" : { "ApiId" : String, "ContentHandlingStrategy" : String, "IntegrationId" : String, "IntegrationResponseKey" : String, "ResponseParameters" : Json, "ResponseTemplates" : Json, "TemplateSelectionExpression" : String } }

YAML

Type: AWS::ApiGatewayV2::IntegrationResponse Properties: ApiId: String ContentHandlingStrategy: String IntegrationId: String IntegrationResponseKey: String ResponseParameters: Json ResponseTemplates: Json TemplateSelectionExpression: String

属性

ApiId

API 标识符。

必需:是

类型:字符串

Update requires: No interruption

ContentHandlingStrategy

仅 WebSocket API 支持。指定如何处理响应负载内容类型转换。支持的值为 CONVERT_TO_BINARYCONVERT_TO_TEXT,以及以下行为:

CONVERT_TO_BINARY:将响应负载从 Base64 编码字符串转换为相应的二进制 Blob。

CONVERT_TO_TEXT:将响应负载从二进制 Blob 转换为 Base64 编码字符串。

如果未定义此属性,则响应负载将从集成响应传递到路由响应或方法响应,而不进行修改。

必需:否

类型:字符串

Update requires: No interruption

IntegrationId

集成 ID。

必需:是

类型:字符串

Update requires: No interruption

IntegrationResponseKey

集成响应键。

必需:是

类型:字符串

Update requires: No interruption

ResponseParameters

一个键/值映射,用于指定从后端传递到方法响应的响应参数。键是方法响应标头参数名称,映射值是集成响应标头值、包含在一对单引号中的静态值或来自集成响应正文的 JSON 表达式。映射键必须与 method.response.header.{name} 模式匹配,其中 name 是一个有效且唯一的标头名称。映射的非静态值必须与 integration.response.header.{name} integration.response.body.{JSON-expression} 模式匹配,其中 {name} 是有效且唯一的响应标头名称, {JSON-expression} 是有效的 JSON 表达式(不带 $ 前缀)。

必需:否

类型:Json

Update requires: No interruption

ResponseTemplates

集成响应的响应模板集合(作为键/值对的字符串到字符串映射)。响应模板表示为键/值映射,其中内容类型为键,模板为值。

必需:否

类型:Json

Update requires: No interruption

TemplateSelectionExpression

集成响应的模板选择表达式。仅 WebSocket API 支持。

必需:否

类型:字符串

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回集成响应资源 ID,例如 abcd123

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

示例

集成响应创建示例

以下示例为名为 MyApi 的 API 创建一个 IntegrationResponse 资源(具有名为 MyIntegrationintegration 资源)。

JSON

{ "IntegrationResponse": { "Type": "AWS::ApiGatewayV2::IntegrationResponse", "Properties": { "IntegrationId": { "Ref": "MyIntegration" }, "IntegrationResponseKey": "/400/", "ApiId": { "Ref": "MyApi" } } } }

YAML

IntegrationResponse: Type: 'AWS::ApiGatewayV2::IntegrationResponse' Properties: IntegrationId: !Ref MyIntegration IntegrationResponseKey: /400/ ApiId: !Ref MyApi

另请参阅