View a markdown version of this page

AWS::CloudWatch::OmniDashboard - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::CloudWatch::OmniDashboard

Resource Type definition for AWS::CloudWatch::OmniDashboard. A dashboard is a saved arrangement of panels that shows your team one agreed view of a system, backed by queries against your space's telemetry.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::CloudWatch::OmniDashboard", "Properties" : { "Body" : String, "Description" : String, "Name" : String, "SpaceId" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::CloudWatch::OmniDashboard Properties: Body: String Description: String Name: String SpaceId: String Tags: - Tag

Properties

Body

The dashboard definition.

Required: Yes

Type: String

Minimum: 1

Maximum: 1048576

Update requires: No interruption

Description

An optional description of the dashboard.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Name

A name that identifies the dashboard.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_.@~()-]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

SpaceId

The unique ID of the space to create the dashboard in.

Required: Yes

Type: String

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a unique identifier for this resource.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the dashboard.

CreatedAt

The timestamp when the dashboard was created.

CreatedBy

The principal that created the dashboard.

DashboardId

The unique ID of the dashboard.

UpdatedAt

The timestamp when the dashboard was last updated.