Skip to main content

Dashboard

Manages an Cloud Watch Dashboard.

Sample code​

exports.createResources = () => [
  {
    type: "Dashboard",
    group: "CloudWatch",
    properties: ({}) => ({
      DashboardBody: {
        widgets: [
          {
            type: "metric",
            x: 0,
            y: 15,
            width: 6,
            height: 6,
            properties: {
              view: "timeSeries",
              stacked: false,
              metrics: [
                [
                  "AWS/Billing",
                  "EstimatedCharges",
                  "Currency",
                  "USD",
                  {
                    period: 21600,
                    stat: "Maximum",
                  },
                ],
              ],
              region: "us-east-1",
            },
          },
        ],
      },
      DashboardName: "my-dashboard",
    }),
  },
];

Properties​

Full Examples​

List​

The dashboard can be filtered with the CloudWatch::Dashboard type:

gc l -t CloudWatch::Dashboard
Listing resources on 1 provider: aws
✓ aws us-east-1
  ✓ Initialising
  ✓ Listing 1/1
┌─────────────────────────────────────────────────────────────────────────┐
│ 1 CloudWatch::Dashboard from aws                                        │
├─────────────────────────────────────────────────────────────────────────┤
│ name: my-dashboard                                                      │
│ managedByUs: Yes                                                        │
│ live:                                                                   │
│   DashboardArn: arn:aws:cloudwatch::840541460064:dashboard/my-dashboard │
│   DashboardBody:                                                        │
│     widgets:                                                            │
│       - type: metric                                                    │
│         x: 0                                                            │
│         y: 15                                                           │
│         width: 6                                                        │
│         height: 6                                                       │
│         properties:                                                     │
│           view: timeSeries                                              │
│           stacked: false                                                │
│           metrics:                                                      │
│             -                                                           │
│               - "AWS/Billing"                                           │
│               - "EstimatedCharges"                                      │
│               - "Currency"                                              │
│               - "USD"                                                   │
│               - period: 21600                                           │
│                 stat: Maximum                                           │
│           region: us-east-1                                             │
│   DashboardName: my-dashboard                                           │
│                                                                         │
└─────────────────────────────────────────────────────────────────────────┘


List Summary:
Provider: aws
┌────────────────────────────────────────────────────────────────────────┐
│ aws                                                                    │
├───────────────────────┬────────────────────────────────────────────────┤
│ CloudWatch::Dashboard │ my-dashboard                                   │
└───────────────────────┴────────────────────────────────────────────────┘
1 resource, 1 type, 1 provider
Command "gc l -t CloudWatch::Dashboard" executed in 3s, 101 MB