AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

Amazon API Gateway Deployment StageDescription

StageDescriptionAWS::ApiGateway::Deployment 资源的一个属性,它配置 Amazon API Gateway (API 网关) 部署阶段。

语法

JSON

{ "CacheClusterEnabled" : Boolean, "CacheClusterSize" : String, "CacheDataEncrypted" : Boolean, "CacheTtlInSeconds" : Integer, "CachingEnabled" : Boolean, "ClientCertificateId" : String, "DataTraceEnabled" : Boolean, "Description" : String, "DocumentationVersion" : String, "LoggingLevel" : String, "MethodSettings" : [ MethodSetting ], "MetricsEnabled" : Boolean, "StageName" : String, "ThrottlingBurstLimit" : Integer, "ThrottlingRateLimit" : Number, "Variables" : { 字符串字符串, ... } }

属性

CacheClusterEnabled

指示是否为阶段启用缓存群集。

Required: No

Type: Boolean

CacheClusterSize

阶段的缓存群集的大小。

Required: No

Type: String

CacheDataEncrypted

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

Required: No

Type: Boolean

CacheTtlInSeconds

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

Required: No

Type: Integer

CachingEnabled

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

Required: No

Type: Boolean

ClientCertificateId

API 网关 用来调用阶段中的集成终端节点的客户端证书的标识符。

Required: No

Type: String

DataTraceEnabled

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

Required: No

Type: Boolean

Description

阶段的用途的描述。

Required: No

Type: String

DocumentationVersion

API 文档快照的版本标识符。

Required: No

Type: String

LoggingLevel

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

Required: No

Type: String

MethodSettings

配置阶段的所有方法的设置。

Required: No

Type: Amazon API Gateway Deployment StageDescription MethodSetting

MetricsEnabled

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

Required: No

Type: Boolean

StageName

阶段的名称,API 网关 将它用作调用统一资源标识符 (URI) 中的第一个路径部分。

Required: No

Type: String

ThrottlingBurstLimit

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

Required: No

Type: Integer

ThrottlingRateLimit

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

Required: No

Type: Number

Variables

一个定义阶段变量的映射。变量名称必须包含数字字母字符,并且值必须匹配以下正则表达式:[A-Za-z0-9-._~:/?#&=,]+

Required: No

类型:键值对的映射

本页内容: