AWS Classic

v5.21.1 published on Thursday, Nov 17, 2022 by Pulumi

Dashboard

Provides a CloudWatch Dashboard resource.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var main = new Aws.CloudWatch.Dashboard("main", new()
    {
        DashboardBody = @"{
  ""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""
      }
    }
  ]
}

",
        DashboardName = "my-dashboard",
    });

});
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/cloudwatch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudwatch.NewDashboard(ctx, "main", &cloudwatch.DashboardArgs{
			DashboardBody: pulumi.String(fmt.Sprintf(`{
  "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"
      }
    }
  ]
}

`)),
			DashboardName: pulumi.String("my-dashboard"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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 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()        
            .dashboardBody("""
{
  "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"
      }
    }
  ]
}

            """)
            .dashboardName("my-dashboard")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

main = aws.cloudwatch.Dashboard("main",
    dashboard_body="""{
  "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"
      }
    }
  ]
}

""",
    dashboard_name="my-dashboard")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const main = new aws.cloudwatch.Dashboard("main", {
    dashboardBody: `{
  "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"
      }
    }
  ]
}
`,
    dashboardName: "my-dashboard",
});
resources:
  main:
    type: aws:cloudwatch:Dashboard
    properties:
      dashboardBody: |+
        {
          "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"
              }
            }
          ]
        }        

      dashboardName: my-dashboard

Create Dashboard Resource

new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
@overload
def Dashboard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              dashboard_body: Optional[str] = None,
              dashboard_name: Optional[str] = None)
@overload
def Dashboard(resource_name: str,
              args: DashboardArgs,
              opts: Optional[ResourceOptions] = 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.

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.

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

CloudWatch dashboards can be imported using the dashboard_name, e.g.,

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.