datadog logo
Datadog v4.16.0, Mar 27 23

datadog.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 System.Collections.Generic;
using Pulumi;
using Datadog = Pulumi.Datadog;

return await Deployment.RunAsync(() => 
{
    var test = Datadog.GetDashboard.Invoke(new()
    {
        Name = "My super dashboard",
    });

});
package main

import (
	"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.DatadogFunctions;
import com.pulumi.datadog.inputs.GetDashboardArgs;
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) {
        final var test = DatadogFunctions.getDashboard(GetDashboardArgs.builder()
            .name("My super dashboard")
            .build());

    }
}
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 = datadog.getDashboard({
    name: "My super dashboard",
});
variables:
  test:
    fn::invoke:
      Function: datadog:getDashboard
      Arguments:
        name: My super dashboard

Using getDashboard

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDashboard(args: GetDashboardArgs, opts?: InvokeOptions): Promise<GetDashboardResult>
function getDashboardOutput(args: GetDashboardOutputArgs, opts?: InvokeOptions): Output<GetDashboardResult>
def get_dashboard(name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDashboardResult
def get_dashboard_output(name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDashboardResult]
func LookupDashboard(ctx *Context, args *LookupDashboardArgs, opts ...InvokeOption) (*LookupDashboardResult, error)
func LookupDashboardOutput(ctx *Context, args *LookupDashboardOutputArgs, opts ...InvokeOption) LookupDashboardResultOutput

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

public static class GetDashboard 
{
    public static Task<GetDashboardResult> InvokeAsync(GetDashboardArgs args, InvokeOptions? opts = null)
    public static Output<GetDashboardResult> Invoke(GetDashboardInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: datadog:index/getDashboard:getDashboard
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

The dashboard name to search for. Must only match one dashboard.

Name string

The dashboard name to search for. Must only match one dashboard.

name String

The dashboard name to search for. Must only match one dashboard.

name string

The dashboard name to search for. Must only match one dashboard.

name str

The dashboard name to search for. Must only match one dashboard.

name String

The dashboard name to search for. Must only match one dashboard.

getDashboard Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Name string

The dashboard name to search for. Must only match one dashboard.

Title string

The name of the dashboard.

Url string

The URL to a specific dashboard.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The dashboard name to search for. Must only match one dashboard.

Title string

The name of the dashboard.

Url string

The URL to a specific dashboard.

id String

The provider-assigned unique ID for this managed resource.

name String

The dashboard name to search for. Must only match one dashboard.

title String

The name of the dashboard.

url String

The URL to a specific dashboard.

id string

The provider-assigned unique ID for this managed resource.

name string

The dashboard name to search for. Must only match one dashboard.

title string

The name of the dashboard.

url string

The URL to a specific dashboard.

id str

The provider-assigned unique ID for this managed resource.

name str

The dashboard name to search for. Must only match one dashboard.

title str

The name of the dashboard.

url str

The URL to a specific dashboard.

id String

The provider-assigned unique ID for this managed resource.

name String

The dashboard name to search for. Must only match one dashboard.

title String

The name of the dashboard.

url String

The URL to a specific dashboard.

Package Details

Repository
Datadog pulumi/pulumi-datadog
License
Apache-2.0
Notes

This Pulumi package is based on the datadog Terraform Provider.