Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Datadog
  5. getDashboard

getDashboard

Use this data source to retrieve information about an existing dashboard, for use in other resources. In particular, it can be used in a monitor message to link to a specific dashboard.

Example Usage

using Pulumi;
using Datadog = Pulumi.Datadog;

class MyStack : Stack
{
    public MyStack()
    {
        var test = Output.Create(Datadog.GetDashboard.InvokeAsync(new Datadog.GetDashboardArgs
        {
            Name = "My super dashboard",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-datadog/sdk/v2/go/datadog"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := datadog.LookupDashboard(ctx, &datadog.LookupDashboardArgs{
            Name: "My super dashboard",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_datadog as datadog

test = datadog.get_dashboard(name="My super dashboard")
import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";

const test = pulumi.output(datadog.getDashboard({
    name: "My super dashboard",
}, { async: true }));

Using getDashboard

function getDashboard(args: GetDashboardArgs, opts?: InvokeOptions): Promise<GetDashboardResult>
def get_dashboard(name: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetDashboardResult
func LookupDashboard(ctx *Context, args *LookupDashboardArgs, opts ...InvokeOption) (*LookupDashboardResult, error)

Note: This function is named LookupDashboard in the Go SDK.

public static class GetDashboard {
    public static Task<GetDashboardResult> InvokeAsync(GetDashboardArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string
Name string
name string
name str

getDashboard Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Name string
Title string
Url string
Id string

The provider-assigned unique ID for this managed resource.

Name string
Title string
Url string
id string

The provider-assigned unique ID for this managed resource.

name string
title string
url string
id str

The provider-assigned unique ID for this managed resource.

name str
title str
url str

Package Details

Repository
https://github.com/pulumi/pulumi-datadog
License
Apache-2.0
Notes
This Pulumi package is based on the datadog Terraform Provider.