

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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# 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
<a name="aws-resource-cloudwatch-omnidashboard-syntax"></a>

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

### JSON
<a name="aws-resource-cloudwatch-omnidashboard-syntax.json"></a>

```json
{
  "Type" : "AWS::CloudWatch::OmniDashboard",
  "Properties" : {
      "[Body](#cfn-cloudwatch-omnidashboard-body)" : {{String}},
      "[Description](#cfn-cloudwatch-omnidashboard-description)" : {{String}},
      "[Name](#cfn-cloudwatch-omnidashboard-name)" : {{String}},
      "[SpaceId](#cfn-cloudwatch-omnidashboard-spaceid)" : {{String}},
      "[Tags](#cfn-cloudwatch-omnidashboard-tags)" : {{[ Tag, ... ]}}
    }
}
```

### YAML
<a name="aws-resource-cloudwatch-omnidashboard-syntax.yaml"></a>

```yaml
Type: AWS::CloudWatch::OmniDashboard
Properties:
  [Body](#cfn-cloudwatch-omnidashboard-body): {{String}}
  [Description](#cfn-cloudwatch-omnidashboard-description): {{String}}
  [Name](#cfn-cloudwatch-omnidashboard-name): {{String}}
  [SpaceId](#cfn-cloudwatch-omnidashboard-spaceid): {{String}}
  [Tags](#cfn-cloudwatch-omnidashboard-tags): {{
    - Tag}}
```

## Properties
<a name="aws-resource-cloudwatch-omnidashboard-properties"></a>

`Body`  <a name="cfn-cloudwatch-omnidashboard-body"></a>
The dashboard definition.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1048576`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-cloudwatch-omnidashboard-description"></a>
An optional description of the dashboard.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudwatch-omnidashboard-name"></a>
A name that identifies the dashboard.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_.@~()-]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SpaceId`  <a name="cfn-cloudwatch-omnidashboard-spaceid"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-cloudwatch-omnidashboard-tags"></a>
An array of key-value pairs to apply to this resource.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-cloudwatch-omnidashboard-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudwatch-omnidashboard-return-values"></a>

### Ref
<a name="aws-resource-cloudwatch-omnidashboard-return-values-ref"></a>

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`](https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudwatch-omnidashboard-return-values-fn--getatt"></a>

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`](https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudwatch-omnidashboard-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the dashboard.

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the dashboard was created.

`CreatedBy`  <a name="CreatedBy-fn::getatt"></a>
The principal that created the dashboard.

`DashboardId`  <a name="DashboardId-fn::getatt"></a>
The unique ID of the dashboard.

`UpdatedAt`  <a name="UpdatedAt-fn::getatt"></a>
The timestamp when the dashboard was last updated.