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

AWS::CloudWatch::Dashboard

AWS::CloudWatch::Dashboard 资源创建一个 Amazon CloudWatch 控制面板。控制面板是 CloudWatch 控制台中的一种自定义主页,可用于在单一视图中监视 AWS 资源。控制面板上的每个指标、图形、警报或文本块称作一个小部件。

该资源支持更新。有关更新该资源的更多信息,请参阅 Amazon CloudWatch API Reference 中的 PutDashboard。有关更新堆栈的详细信息,请参阅 AWS CloudFormation 堆栈更新

语法

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

JSON

{ "Type" : "AWS::CloudWatch::Dashboard", "Properties" : { "DashboardName" : String, "DashboardBody" : String, } }

YAML

Type: "AWS::CloudWatch::Dashboard" Properties: DashboardName: String DashboardBody: String

属性

DashboardName

控制面板的名称。名称长度必须介于 1 到 255 个字符之间。如果不指定名称,系统会自动生成一个。

Required: No

Type: String

更新要求替换

DashboardBody

一个 JSON 字符串,用于定义控制面板中包含的小部件及其位置。有关如何格式化该字符串的信息,请参阅控制面板主体结构和语法

Required: Yes

Type: String

更新要求无需中断

返回值

Ref

如果将 AWS::CloudWatch::Dashboard 资源指定为 Ref 函数的参数,AWS CloudFormation 将返回 Name 的值。

有关使用 Ref 功能的更多信息,请参阅参考

示例

有关示例,请参阅 Amazon CloudWatch 模板代码段

本页内容: