1. Packages
  2. AWS Classic
  3. API Docs
  4. cloudwatch
  5. Dashboard

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.cloudwatch.Dashboard

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    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",
                    },
                },
            ],
        }))
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/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]interface{}{
    						"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
    	})
    }
    
    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 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.List;
    import java.util.ArrayList;
    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
    

    Create Dashboard Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
    @overload
    def Dashboard(resource_name: str,
                  args: DashboardArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Dashboard(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  dashboard_body: Optional[str] = None,
                  dashboard_name: Optional[str] = None)
    func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
    public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
    public Dashboard(String name, DashboardArgs args)
    public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
    
    type: aws:cloudwatch:Dashboard
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var dashboardResource = new Aws.CloudWatch.Dashboard("dashboardResource", new()
    {
        DashboardBody = "string",
        DashboardName = "string",
    });
    
    example, err := cloudwatch.NewDashboard(ctx, "dashboardResource", &cloudwatch.DashboardArgs{
    	DashboardBody: pulumi.String("string"),
    	DashboardName: pulumi.String("string"),
    })
    
    var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
        .dashboardBody("string")
        .dashboardName("string")
        .build());
    
    dashboard_resource = aws.cloudwatch.Dashboard("dashboardResource",
        dashboard_body="string",
        dashboard_name="string")
    
    const dashboardResource = new aws.cloudwatch.Dashboard("dashboardResource", {
        dashboardBody: "string",
        dashboardName: "string",
    });
    
    type: aws:cloudwatch:Dashboard
    properties:
        dashboardBody: string
        dashboardName: string
    

    Dashboard Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Dashboard resource accepts the following input properties:

    DashboardBody 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.
    DashboardName string
    The name of the dashboard.
    DashboardBody 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.
    DashboardName string
    The name of the dashboard.
    dashboardBody 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.
    dashboardName String
    The name of the dashboard.
    dashboardBody 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.
    dashboardName string
    The name of the dashboard.
    dashboard_body str
    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.
    dashboard_name str
    The name of the dashboard.
    dashboardBody 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.
    dashboardName String
    The name of the dashboard.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:

    DashboardArn string
    The Amazon Resource Name (ARN) of the dashboard.
    Id string
    The provider-assigned unique ID for this managed resource.
    DashboardArn string
    The Amazon Resource Name (ARN) of the dashboard.
    Id string
    The provider-assigned unique ID for this managed resource.
    dashboardArn String
    The Amazon Resource Name (ARN) of the dashboard.
    id String
    The provider-assigned unique ID for this managed resource.
    dashboardArn string
    The Amazon Resource Name (ARN) of the dashboard.
    id string
    The provider-assigned unique ID for this managed resource.
    dashboard_arn str
    The Amazon Resource Name (ARN) of the dashboard.
    id str
    The provider-assigned unique ID for this managed resource.
    dashboardArn String
    The Amazon Resource Name (ARN) of the dashboard.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Dashboard Resource

    Get an existing Dashboard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DashboardState, opts?: CustomResourceOptions): Dashboard
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dashboard_arn: Optional[str] = None,
            dashboard_body: Optional[str] = None,
            dashboard_name: Optional[str] = None) -> Dashboard
    func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
    public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
    public static Dashboard get(String name, Output<String> id, DashboardState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DashboardArn string
    The Amazon Resource Name (ARN) of the dashboard.
    DashboardBody 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.
    DashboardName string
    The name of the dashboard.
    DashboardArn string
    The Amazon Resource Name (ARN) of the dashboard.
    DashboardBody 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.
    DashboardName string
    The name of the dashboard.
    dashboardArn String
    The Amazon Resource Name (ARN) of the dashboard.
    dashboardBody 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.
    dashboardName String
    The name of the dashboard.
    dashboardArn string
    The Amazon Resource Name (ARN) of the dashboard.
    dashboardBody 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.
    dashboardName string
    The name of the dashboard.
    dashboard_arn str
    The Amazon Resource Name (ARN) of the dashboard.
    dashboard_body str
    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.
    dashboard_name str
    The name of the dashboard.
    dashboardArn String
    The Amazon Resource Name (ARN) of the dashboard.
    dashboardBody 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.
    dashboardName String
    The name of the dashboard.

    Import

    Using pulumi import, import CloudWatch dashboards using the dashboard_name. For example:

    $ pulumi import aws:cloudwatch/dashboard:Dashboard sample dashboard_name
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi