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

AWS::ApiGateway::Method IntegrationResponse

IntegrationResponseAmazon API Gateway 方法集成属性类型的属性,用于指定 API Gateway 在方法的后端处理完请求后发送的响应。

语法

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

JSON

{ "ContentHandling" : String, "ResponseParameters" : {Key : Value, ...}, "ResponseTemplates" : {Key : Value, ...}, "SelectionPattern" : String, "StatusCode" : String }

YAML

ContentHandling: String ResponseParameters: Key : Value ResponseTemplates: Key : Value SelectionPattern: String StatusCode: String

属性

ContentHandling

指定如何处理请求负载内容类型转换。有效值为:

  • CONVERT_TO_BINARY:将请求负载从 base64 编码字符串转换为二进制 Blob。

  • CONVERT_TO_TEXT:将请求负载从二进制 Blob 转换为 base64 编码字符串。

如果未定义该属性,则会在不修改的情况下直接将请求负载从方法请求传递到集成请求。

必需:否

类型:字符串

Update requires: No interruption

ResponseParameters

来自 API Gateway 发送到方法响应的后端响应的响应参数。指定响应参数作为键/值对(字符串到字符串映射)。

将目标用作键,并将源用作值:

  • 目标必须是 MethodResponse 属性中的现有响应参数。

  • 源必须是现有方法请求参数或静态值。您必须用单引号将静态值引起来,并基于请求中指定的目标对这些值预先进行编码。

有关模板的更多信息,请参阅 API Gateway 开发人员指南中的 API Gateway 映射模板和访问日志变量参考

必需:否

类型:字符串的映射

Update requires: No interruption

ResponseTemplates

用于转换集成响应正文的模板。将目标指定为键值对 (字符串-字符串映射),其中内容类型作为键,模板作为值。有关更多信息,请参阅 API Gateway 开发人员指南中的 API Gateway 映射模板和访问日志变量参考

必需:否

类型:字符串的映射

Update requires: No interruption

SelectionPattern

一个正则表达式,用于指定来自后端的哪些错误字符串或状态代码将映射到集成响应。

必需:否

类型:字符串

Update requires: No interruption

StatusCode

API Gateway 用于将集成响应映射到 MethodResponse 状态代码的状态代码。

必需:是

类型:字符串

Update requires: No interruption

另请参阅

  • Amazon API Gateway REST API 参考中的方法