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

AWS::ApiGateway::Stage MethodSetting

MethodSetting 属性类型为某个阶段中的所有方法配置设置。

MethodSettings 资源的 AWS::ApiGateway::Stage 属性包含一个 MethodSetting 属性类型列表。

语法

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

JSON

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

YAML

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

属性

CacheDataEncrypted

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

必需:否

类型:布尔值

Update requires: No interruption

CacheTtlInSeconds

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

必需:否

类型:整数

Update requires: No interruption

CachingEnabled

指示是为请求缓存还是返回响应。您必须对阶段启用缓存群集以缓存响应。

必需:否

类型:布尔值

Update requires: No interruption

DataTraceEnabled

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

必需:否

类型:布尔值

Update requires: No interruption

HttpMethod

HTTP 方法。您可以将星号 (*) 作为通配符以将方法设置应用于多个方法。

必需:否

类型:字符串

Update requires: No interruption

LoggingLevel

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

必需:否

类型:字符串

Update requires: No interruption

MetricsEnabled

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

必需:否

类型:布尔值

Update requires: No interruption

ResourcePath

此方法的资源路径。正斜杠 (/) 将编码为 ~1,初始斜杠必须包含正斜杠。例如,路径值 /resource/subresource 必须编码为 /~1resource~1subresource。要指定根路径,请仅使用一个斜杠 (/)。您可以将星号 (*) 作为通配符以将方法设置应用于多个方法。

必需:否

类型:字符串

Update requires: No interruption

ThrottlingBurstLimit

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

必需:否

类型:整数

Update requires: No interruption

ThrottlingRateLimit

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

必需:否

类型:双精度

Update requires: No interruption

另请参阅

  • Amazon API Gateway REST API 参考中的阶段