Dashboard class
Provides a CloudWatch Dashboard resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const main = new aws.cloudwatch.Dashboard("main", {
dashboardName: "my-dashboard",
dashboardBody: JSON.stringify({
widgets: [
{
type: "metric",
x: 0,
y: 0,
width: 12,
height: 6,
properties: {
metrics: [[
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345",
]],
period: 300,
stat: "Average",
region: "us-east-1",
title: "EC2 Instance CPU",
},
},
{
type: "text",
x: 0,
y: 7,
width: 3,
height: 3,
properties: {
markdown: "Hello world",
},
},
],
}),
});
import pulumi
import json
import pulumi_aws as aws
main = aws.cloudwatch.Dashboard("main",
dashboard_name="my-dashboard",
dashboard_body=json.dumps({
"widgets": [
{
"type": "metric",
"x": 0,
"y": 0,
"width": 12,
"height": 6,
"properties": {
"metrics": [[
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345",
]],
"period": 300,
"stat": "Average",
"region": "us-east-1",
"title": "EC2 Instance CPU",
},
},
{
"type": "text",
"x": 0,
"y": 7,
"width": 3,
"height": 3,
"properties": {
"markdown": "Hello world",
},
},
],
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var main = new Aws.CloudWatch.Dashboard("main", new()
{
DashboardName = "my-dashboard",
DashboardBody = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["widgets"] = new[]
{
new Dictionary<string, object?>
{
["type"] = "metric",
["x"] = 0,
["y"] = 0,
["width"] = 12,
["height"] = 6,
["properties"] = new Dictionary<string, object?>
{
["metrics"] = new[]
{
new[]
{
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345",
},
},
["period"] = 300,
["stat"] = "Average",
["region"] = "us-east-1",
["title"] = "EC2 Instance CPU",
},
},
new Dictionary<string, object?>
{
["type"] = "text",
["x"] = 0,
["y"] = 7,
["width"] = 3,
["height"] = 3,
["properties"] = new Dictionary<string, object?>
{
["markdown"] = "Hello world",
},
},
},
}),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string][]interface{}{
"widgets": []interface{}{
map[string]interface{}{
"type": "metric",
"x": 0,
"y": 0,
"width": 12,
"height": 6,
"properties": map[string]interface{}{
"metrics": [][]string{
[]string{
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345",
},
},
"period": 300,
"stat": "Average",
"region": "us-east-1",
"title": "EC2 Instance CPU",
},
},
map[string]interface{}{
"type": "text",
"x": 0,
"y": 7,
"width": 3,
"height": 3,
"properties": map[string]string{
"markdown": "Hello world",
},
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = cloudwatch.NewDashboard(ctx, "main", &cloudwatch.DashboardArgs{
DashboardName: pulumi.String("my-dashboard"),
DashboardBody: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_cloudwatch_dashboard" "main" {
dashboard_name = "my-dashboard"
dashboard_body = jsonencode({
"widgets" = [{
"type" = "metric"
"x" = 0
"y" = 0
"width" = 12
"height" = 6
"properties" = {
"metrics" = [["AWS/EC2", "CPUUtilization", "InstanceId", "i-012345"]]
"period" = 300
"stat" = "Average"
"region" = "us-east-1"
"title" = "EC2 Instance CPU"
}
}, {
"type" = "text"
"x" = 0
"y" = 7
"width" = 3
"height" = 3
"properties" = {
"markdown" = "Hello world"
}
}]
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.Dashboard;
import com.pulumi.aws.cloudwatch.DashboardArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var main = new Dashboard("main", DashboardArgs.builder()
.dashboardName("my-dashboard")
.dashboardBody(serializeJson(
jsonObject(
jsonProperty("widgets", jsonArray(
jsonObject(
jsonProperty("type", "metric"),
jsonProperty("x", 0),
jsonProperty("y", 0),
jsonProperty("width", 12),
jsonProperty("height", 6),
jsonProperty("properties", jsonObject(
jsonProperty("metrics", jsonArray(jsonArray(
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345"
))),
jsonProperty("period", 300),
jsonProperty("stat", "Average"),
jsonProperty("region", "us-east-1"),
jsonProperty("title", "EC2 Instance CPU")
))
),
jsonObject(
jsonProperty("type", "text"),
jsonProperty("x", 0),
jsonProperty("y", 7),
jsonProperty("width", 3),
jsonProperty("height", 3),
jsonProperty("properties", jsonObject(
jsonProperty("markdown", "Hello world")
))
)
))
)))
.build());
}
}
resources:
main:
type: aws:cloudwatch:Dashboard
properties:
dashboardName: my-dashboard
dashboardBody:
fn::toJSON:
widgets:
- type: metric
x: 0
y: 0
width: 12
height: 6
properties:
metrics:
- - AWS/EC2
- CPUUtilization
- InstanceId
- i-012345
period: 300
stat: Average
region: us-east-1
title: EC2 Instance CPU
- type: text
x: 0
y: 7
width: 3
height: 3
properties:
markdown: Hello world
Import
Identity Schema
Required
dashboardName(String) Name of the dashboard.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import Dashboards using dashboardName. For example:
$ pulumi import aws:cloudwatch/dashboard:Dashboard example example-dashboard
Constructors
- Dashboard(String name, {DashboardArgs? args, CustomResourceOptions? options})
-
Creates a new Dashboard.
nameThe Pulumi resource name.argsArguments used to configure this Dashboard. The set of arguments for Dashboard.optionsResource options controlling this resource's behavior. - Dashboard.reference(String urn)
- Creates a typed reference to an existing Dashboard resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
dashboardArn
↔ Output<
String> -
ARN of the dashboard.
latefinal
-
dashboardBody
↔ Output<
String> -
The detailed information about the dashboard, including what widgets are included and their location on the dashboard. You can read more about the body structure in the documentation.
latefinal
-
dashboardName
↔ Output<
String> -
The name of the dashboard.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited