AWS::CloudWatch::OmniDashboard - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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

AWS::CloudWatch::OmniDashboard

Resource type definition for AWS::CloudWatch::OmniDashboard

Syntax

To declare this entity in your 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 body, a JSON document describing the dashboard's widgets and layout.

Required: Yes

Type: String

Minimum: 1

Maximum: 1048576

Update requires: No interruption

Description

The description of the dashboard.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Name

The name of the dashboard.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 256

Update requires: No interruption

SpaceId

The unique identifier of the space the dashboard belongs to.

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 time the dashboard was created.

CreatedBy

The principal that created the dashboard.

DashboardId

The unique identifier of the dashboard.

UpdatedAt

The time the dashboard was last updated.