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

AWS::ApiGateway::Deployment StageDescription

StageDescription 是配置部署阶段的 AWS::ApiGateway::Deployment 资源的属性。

语法

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

JSON

{ "AccessLogSetting" : AccessLogSetting, "CacheClusterEnabled" : Boolean, "CacheClusterSize" : String, "CacheDataEncrypted" : Boolean, "CacheTtlInSeconds" : Integer, "CachingEnabled" : Boolean, "CanarySetting" : CanarySetting, "ClientCertificateId" : String, "DataTraceEnabled" : Boolean, "Description" : String, "DocumentationVersion" : String, "LoggingLevel" : String, "MethodSettings" : [ MethodSetting, ... ], "MetricsEnabled" : Boolean, "Tags" : [ Tag, ... ], "ThrottlingBurstLimit" : Integer, "ThrottlingRateLimit" : Double, "TracingEnabled" : Boolean, "Variables" : {Key : Value, ...} }

属性

AccessLogSetting

为该阶段中的日志记录访问指定设置。

必需:否

类型: AccessLogSetting

Update requires: No interruption

CacheClusterEnabled

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

必需:否

类型:布尔值

Update requires: No interruption

CacheClusterSize

阶段的缓存群集的大小。

必需:否

类型:字符串

Update requires: No interruption

CacheDataEncrypted

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

必需:否

类型:布尔值

Update requires: No interruption

CacheTtlInSeconds

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

必需:否

类型:整数

Update requires: No interruption

CachingEnabled

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

必需:否

类型:布尔值

Update requires: No interruption

CanarySetting

为该阶段中的金丝雀部署指定设置。

必需:否

类型CanarySetting

Update requires: No interruption

ClientCertificateId

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

必需:否

类型:字符串

Update requires: No interruption

DataTraceEnabled

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

必需:否

类型:布尔值

Update requires: No interruption

Description

阶段的用途的描述。

必需:否

类型:字符串

Update requires: No interruption

DocumentationVersion

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

必需:否

类型:字符串

Update requires: No interruption

LoggingLevel

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

必需:否

类型:字符串

Update requires: No interruption

MethodSettings

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

必需:否

类型MethodSetting 的列表

Update requires: No interruption

MetricsEnabled

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

必需:否

类型:布尔值

Update requires: No interruption

Tags

与阶段关联的任意标签(键值对)的数组。

必需:否

类型Tag 的列表

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

TracingEnabled

指定是否为该阶段启用了通过 X-Ray 进行的主动跟踪。

有关更多信息,请参阅 API Gateway 开发人员指南中的使用 AWS X-Ray 跟踪 API Gateway API 执行情况

必需:否

类型:布尔值

Update requires: No interruption

Variables

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

必需:否

类型:字符串的映射

Update requires: No interruption

另请参阅

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