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

AWS::ApiGateway::Method MethodResponse

MethodResponseAWS::ApiGateway::Method 资源的属性,用于定义可以发送到调用方法的客户端的响应。

语法

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

JSON

{ "ResponseModels" : {Key : Value, ...}, "ResponseParameters" : {Key : Value, ...}, "StatusCode" : String }

YAML

ResponseModels: Key : Value ResponseParameters: Key : Value StatusCode: String

属性

ResponseModels

为响应的内容类型使用的资源。指定响应模型为键/值对格式(字符串到字符串映射),使用内容类型作为键,并使用模型资源名称作为值。

必需:否

类型:字符串的映射

Update requires: No interruption

ResponseParameters

API Gateway 发送到调用了方法的客户端的响应参数。指定响应参数为键值对格式 (字符串到布尔值映射),使用目标作为键,使用布尔值作为值。使用以下模式指定目标:method.response.header.name,其中 名称是有效的唯一标头名称。布尔值指定是否需要参数。

必需:否

类型:布尔值的映射

Update requires: No interruption

StatusCode

方法响应的状态代码,您将其映射到 IntegrationResponse

必需:是

类型:字符串

Update requires: No interruption

另请参阅

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