1. Registry
  2. Packages
  3. Signalfx Provider
  4. API Docs
  5. getBuiltinDashboards
Viewing docs for SignalFx v7.29.0
published on Tuesday, Aug 25, 2026 by Pulumi
signalfx logo signalfx logo
Viewing docs for SignalFx v7.29.0
published on Tuesday, Aug 25, 2026 by Pulumi

    This data source is responsible for capturing all the built in content available for the user so that they can be used within their own dashboard groups.

    import * as pulumi from "@pulumi/pulumi";
    import * as signalfx from "@pulumi/signalfx";
    
    export = async () => {
        const example = await signalfx.getBuiltinDashboards({});
        //# A simple example making a reference to a specific dashboard group and dashboard. 
        const my_service_dashboard_group = new signalfx.DashboardGroup("my-service-dashboard-group", {
            name: "Example Dashboard Group",
            dashboards: [{
                dashboardId: example.results?.AWS_ECS?.eCSService,
                nameOverride: "My Awesome Service ECS Dashboard",
            }],
        });
        return {
            "all-dashboards": example,
        };
    }
    
    import pulumi
    import pulumi_signalfx as signalfx
    
    example = signalfx.get_builtin_dashboards()
    pulumi.export("all-dashboards", example)
    ## A simple example making a reference to a specific dashboard group and dashboard. 
    my_service_dashboard_group = signalfx.DashboardGroup("my-service-dashboard-group",
        name="Example Dashboard Group",
        dashboards=[{
            "dashboard_id": example.results["AWS_ECS"]["eCSService"],
            "name_override": "My Awesome Service ECS Dashboard",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := signalfx.GetBuiltinDashboards(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("all-dashboards", example)
    		// # A simple example making a reference to a specific dashboard group and dashboard.
    		_, err = signalfx.NewDashboardGroup(ctx, "my-service-dashboard-group", &signalfx.DashboardGroupArgs{
    			Name: pulumi.String("Example Dashboard Group"),
    			Dashboards: signalfx.DashboardGroupDashboardArray{
    				&signalfx.DashboardGroupDashboardArgs{
    					DashboardId:  pulumi.String(example.Results.AWS_ECS.ECSService),
    					NameOverride: pulumi.String("My Awesome Service ECS Dashboard"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using SignalFx = Pulumi.SignalFx;
    
    return await Deployment.RunAsync(() => 
    {
        var example = SignalFx.GetBuiltinDashboards.Invoke();
    
        //# A simple example making a reference to a specific dashboard group and dashboard. 
        var my_service_dashboard_group = new SignalFx.DashboardGroup("my-service-dashboard-group", new()
        {
            Name = "Example Dashboard Group",
            Dashboards = new[]
            {
                new SignalFx.Inputs.DashboardGroupDashboardArgs
                {
                    DashboardId = example.Apply(getBuiltinDashboardsResult => getBuiltinDashboardsResult.Results?.AWS_ECS?.ECSService),
                    NameOverride = "My Awesome Service ECS Dashboard",
                },
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["all-dashboards"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.signalfx.SignalfxFunctions;
    import com.pulumi.signalfx.DashboardGroup;
    import com.pulumi.signalfx.DashboardGroupArgs;
    import com.pulumi.signalfx.inputs.DashboardGroupDashboardArgs;
    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) {
            final var example = SignalfxFunctions.getBuiltinDashboards(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);
    
            ctx.export("all-dashboards", example);
            //# A simple example making a reference to a specific dashboard group and dashboard. 
            var my_service_dashboard_group = new DashboardGroup("my-service-dashboard-group", DashboardGroupArgs.builder()
                .name("Example Dashboard Group")
                .dashboards(DashboardGroupDashboardArgs.builder()
                    .dashboardId(example.results().AWS_ECS().eCSService())
                    .nameOverride("My Awesome Service ECS Dashboard")
                    .build())
                .build());
    
        }
    }
    
    resources:
      ## A simple example making a reference to a specific dashboard group and dashboard.
      my-service-dashboard-group:
        type: signalfx:DashboardGroup
        properties:
          name: Example Dashboard Group
          dashboards:
            - dashboardId: ${example.results.AWS_ECS.eCSService}
              nameOverride: My Awesome Service ECS Dashboard
    variables:
      example:
        fn::invoke:
          function: signalfx:getBuiltinDashboards
          arguments: {}
    outputs:
      all-dashboards: ${example}
    
    pulumi {
      required_providers {
        signalfx = {
          source = "pulumi/signalfx"
        }
      }
    }
    
    data "signalfx_getbuiltindashboards" "example" {
    }
    
    ## A simple example making a reference to a specific dashboard group and dashboard. 
    resource "signalfx_dashboardgroup" "my-service-dashboard-group" {
      name = "Example Dashboard Group"
      dashboards {
        dashboard_id  = data.signalfx_getbuiltindashboards.example.results.AWS_ECS.eCSService
        name_override = "My Awesome Service ECS Dashboard"
      }
    }
    output "all-dashboards" {
      value = data.signalfx_getbuiltindashboards.example
    }
    

    Using getBuiltinDashboards

    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 getBuiltinDashboards(opts?: InvokeOptions): Promise<GetBuiltinDashboardsResult>
    function getBuiltinDashboardsOutput(opts?: InvokeOutputOptions): Output<GetBuiltinDashboardsResult>
    def get_builtin_dashboards(opts: Optional[InvokeOptions] = None) -> GetBuiltinDashboardsResult
    def get_builtin_dashboards_output(opts: Optional[InvokeOutputOptions] = None) -> Output[GetBuiltinDashboardsResult]
    func GetBuiltinDashboards(ctx *Context, opts ...InvokeOption) (*GetBuiltinDashboardsResult, error)
    func GetBuiltinDashboardsOutput(ctx *Context, opts ...InvokeOption) GetBuiltinDashboardsResultOutput

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

    public static class GetBuiltinDashboards 
    {
        public static Task<GetBuiltinDashboardsResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetBuiltinDashboardsResult> Invoke(InvokeOptions? opts = null)
        public static Output<GetBuiltinDashboardsResult> Invoke(InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetBuiltinDashboardsResult> getBuiltinDashboards(InvokeOptions options)
    public static Output<GetBuiltinDashboardsResult> getBuiltinDashboards(InvokeOptions options)
    public static Output<GetBuiltinDashboardsResult> getBuiltinDashboards(InvokeOutputOptions options)
    
    fn::invoke:
      function: signalfx:index/getBuiltinDashboards:getBuiltinDashboards
      arguments:
        # arguments dictionary
    data "signalfx_get_builtin_dashboards" "name" {
        # arguments
    }

    getBuiltinDashboards Result

    The following output properties are available:

    Results Dictionary<string, ImmutableDictionary<string, string>>
    Map of the builtin content dashboard groups and their associated dashboards. The keys are the dashboard group names and the values are maps of dashboard names to their IDs.
    Results map[string]map[string]string
    Map of the builtin content dashboard groups and their associated dashboards. The keys are the dashboard group names and the values are maps of dashboard names to their IDs.
    results map(map(string))
    Map of the builtin content dashboard groups and their associated dashboards. The keys are the dashboard group names and the values are maps of dashboard names to their IDs.
    results Map<String,Map<String,String>>
    Map of the builtin content dashboard groups and their associated dashboards. The keys are the dashboard group names and the values are maps of dashboard names to their IDs.
    results {[key: string]: {[key: string]: string}}
    Map of the builtin content dashboard groups and their associated dashboards. The keys are the dashboard group names and the values are maps of dashboard names to their IDs.
    results Mapping[str, Mapping[str, str]]
    Map of the builtin content dashboard groups and their associated dashboards. The keys are the dashboard group names and the values are maps of dashboard names to their IDs.
    results Map<Map<String>>
    Map of the builtin content dashboard groups and their associated dashboards. The keys are the dashboard group names and the values are maps of dashboard names to their IDs.

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo signalfx logo
    Viewing docs for SignalFx v7.29.0
    published on Tuesday, Aug 25, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial