AWS CloudFormation
User Guide (API 版本 2010-05-15)
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

Amazon API Gateway Deployment MethodSetting

MethodSetting 属性类型为 Amazon API Gateway (API 网关) 阶段中的所有方法配置设置。

Amazon API Gateway Deployment StageDescription 属性类型的 MethodSettings 属性包含一个 MethodSetting 属性类型列表。

语法

JSON

{ "CacheDataEncrypted" : Boolean, "CacheTtlInSeconds" : Integer, "CachingEnabled" : Boolean, "DataTraceEnabled" : Boolean, "HttpMethod" : String, "LoggingLevel" : String, "MetricsEnabled" : Boolean, "ResourcePath" : String, "ThrottlingBurstLimit" : Integer, "ThrottlingRateLimit" : Number }

YAML

CacheDataEncrypted: Boolean CacheTtlInSeconds: Integer CachingEnabled: Boolean DataTraceEnabled: Boolean HttpMethod: String LoggingLevel: String MetricsEnabled: Boolean ResourcePath: String ThrottlingBurstLimit: Integer ThrottlingRateLimit: Number

属性

CacheDataEncrypted

指示是否加密缓存的响应。

Required: No

Type: Boolean

CacheTtlInSeconds

生存时间 (TTL) 期间(以秒为单位),用于指定 API 网关 缓存响应的时长。

Required: No

Type: Integer

CachingEnabled

指示是为请求缓存还是返回响应。您必须对阶段启用缓存群集以缓存响应。有关更多信息,请参阅 API 网关 开发人员指南 中的在阶段中启用 API 网关 缓存以增强 API 性能

Required: No

Type: Boolean

DataTraceEnabled

指示是否为阶段中的方法启用数据跟踪日志记录。API 网关 将这些日志推送到 Amazon CloudWatch Logs。

Required: No

Type: Boolean

HttpMethod

HTTP 方法。

Required: No

Type: String

LoggingLevel

此方法的日志记录级别。有关有效值的信息,请参阅 Amazon API Gateway API 参考阶段资源的 loggingLevel 属性。

Required: No

Type: String

MetricsEnabled

指示是否为阶段中的方法启用 Amazon CloudWatch 指标。

Required: No

Type: Boolean

ResourcePath

此方法的资源路径。正斜杠 (/) 将编码为 ~1,初始斜杠必须包含正斜杠。例如,路径值 /resource/subresource 必须编码为 /~1resource~1subresource。要指定根路径,请仅使用一个斜杠 (/)。

Required: No

Type: String

ThrottlingBurstLimit

API 网关 允许跨 AWS 账户中的所有 API、阶段和方法的每秒突发请求数。有关更多信息,请参阅 API 网关 开发人员指南 中的管理 API 请求限制

Required: No

Type: Integer

ThrottlingRateLimit

API 网关 允许跨 AWS 账户中的所有 API、阶段和方法的每秒稳态请求数。有关更多信息,请参阅 API 网关 开发人员指南 中的管理 API 请求限制

Required: No

Type: Number

本页内容: