メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::CloudWatch::Dashboard

AWS::CloudWatch::Dashboard リソースは、Amazon CloudWatch ダッシュボードを作成します。ダッシュボードは、CloudWatch コンソールのカスタマイズ可能なホームページで、AWS リソースを単一のビューで監視するために使用できます。ダッシュボード上の各メトリクス、グラフ、アラーム、またはテキストブロックは、ウィジェットと呼ばれます。

このリソースは更新をサポートしています。このリソースの更新の詳細については、『Amazon CloudWatch API リファレンス』の「PutDashboard」を参照して下さい。スタックの更新の詳細については、「AWS CloudFormation スタックの更新」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

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

YAML

Copy
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 リソースを指定すると、AWS CloudFormation は Name の値を返します。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

例については、「Amazon CloudWatch テンプレートスニペット」を参照してください。

このページの内容: