Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Vantage Provider
  4. API Docs
  5. Dashboard
Viewing docs for vantage 0.4.1
published on Wednesday, Oct 7, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

vantage.Dashboard

vantage
Viewing docs for vantage 0.4.1
published on Wednesday, Oct 7, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as vantage from "@pulumi/vantage";

const demoDashboard = new vantage.Dashboard("demo_dashboard", {
    title: "Demo Dashboard",
    dateInterval: "last_month",
    widgets: [
        {
            settings: {
                displayType: "chart",
                grid: {
                    x: 0,
                    y: 0,
                    w: 6,
                    h: 4,
                },
            },
            widgetableToken: "rprt_a2846903070824f4",
        },
        {
            settings: {
                displayType: "kpi",
                kpiCalculation: "sum",
                kpiType: "cost",
                grid: {
                    x: 6,
                    y: 0,
                    w: 6,
                    h: 4,
                },
            },
            title: "Total Spend",
            widgetableToken: "rprt_a2846903070824f4",
        },
        {
            title: "Notes",
            widgetableType: "free_text",
            content: JSON.stringify({
                type: "doc",
                content: [{
                    type: "paragraph",
                    content: [{
                        type: "text",
                        text: "Use free text widgets for dashboard context.",
                    }],
                }],
            }),
        },
    ],
    workspaceToken: "wrkspc_47c3254c790e9351",
});

    import pulumi
import json
import pulumi_vantage as vantage

demo_dashboard = vantage.Dashboard("demo_dashboard",
    title="Demo Dashboard",
    date_interval="last_month",
    widgets=[
        {
            "settings": {
                "display_type": "chart",
                "grid": {
                    "x": 0,
                    "y": 0,
                    "w": 6,
                    "h": 4,
                },
            },
            "widgetable_token": "rprt_a2846903070824f4",
        },
        {
            "settings": {
                "display_type": "kpi",
                "kpi_calculation": "sum",
                "kpi_type": "cost",
                "grid": {
                    "x": 6,
                    "y": 0,
                    "w": 6,
                    "h": 4,
                },
            },
            "title": "Total Spend",
            "widgetable_token": "rprt_a2846903070824f4",
        },
        {
            "title": "Notes",
            "widgetable_type": "free_text",
            "content": json.dumps({
                "type": "doc",
                "content": [{
                    "type": "paragraph",
                    "content": [{
                        "type": "text",
                        "text": "Use free text widgets for dashboard context.",
                    }],
                }],
            }),
        },
    ],
    workspace_token="wrkspc_47c3254c790e9351")

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vantage/vantage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"type": "doc",
			"content": []map[string]interface{}{
				map[string]interface{}{
					"type": "paragraph",
					"content": []map[string]interface{}{
						map[string]interface{}{
							"type": "text",
							"text": "Use free text widgets for dashboard context.",
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = vantage.NewDashboard(ctx, "demo_dashboard", &vantage.DashboardArgs{
			Title:        pulumi.String("Demo Dashboard"),
			DateInterval: pulumi.String("last_month"),
			Widgets: vantage.DashboardWidgetArray{
				&vantage.DashboardWidgetArgs{
					Settings: &vantage.DashboardWidgetSettingsArgs{
						DisplayType: pulumi.String("chart"),
						Grid: &vantage.DashboardWidgetSettingsGridArgs{
							X: pulumi.Float64(0),
							Y: pulumi.Float64(0),
							W: pulumi.Float64(6),
							H: pulumi.Float64(4),
						},
					},
					WidgetableToken: pulumi.String("rprt_a2846903070824f4"),
				},
				&vantage.DashboardWidgetArgs{
					Settings: &vantage.DashboardWidgetSettingsArgs{
						DisplayType:    pulumi.String("kpi"),
						KpiCalculation: pulumi.String("sum"),
						KpiType:        pulumi.String("cost"),
						Grid: &vantage.DashboardWidgetSettingsGridArgs{
							X: pulumi.Float64(6),
							Y: pulumi.Float64(0),
							W: pulumi.Float64(6),
							H: pulumi.Float64(4),
						},
					},
					Title:           pulumi.String("Total Spend"),
					WidgetableToken: pulumi.String("rprt_a2846903070824f4"),
				},
				&vantage.DashboardWidgetArgs{
					Title:          pulumi.String("Notes"),
					WidgetableType: pulumi.String("free_text"),
					Content:        pulumi.String(json0),
				},
			},
			WorkspaceToken: pulumi.String("wrkspc_47c3254c790e9351"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Vantage = Pulumi.Vantage;

return await Deployment.RunAsync(() => 
{
    var demoDashboard = new Vantage.Dashboard("demo_dashboard", new()
    {
        Title = "Demo Dashboard",
        DateInterval = "last_month",
        Widgets = new[]
        {
            new Vantage.Inputs.DashboardWidgetArgs
            {
                Settings = new Vantage.Inputs.DashboardWidgetSettingsArgs
                {
                    DisplayType = "chart",
                    Grid = new Vantage.Inputs.DashboardWidgetSettingsGridArgs
                    {
                        X = 0,
                        Y = 0,
                        W = 6,
                        H = 4,
                    },
                },
                WidgetableToken = "rprt_a2846903070824f4",
            },
            new Vantage.Inputs.DashboardWidgetArgs
            {
                Settings = new Vantage.Inputs.DashboardWidgetSettingsArgs
                {
                    DisplayType = "kpi",
                    KpiCalculation = "sum",
                    KpiType = "cost",
                    Grid = new Vantage.Inputs.DashboardWidgetSettingsGridArgs
                    {
                        X = 6,
                        Y = 0,
                        W = 6,
                        H = 4,
                    },
                },
                Title = "Total Spend",
                WidgetableToken = "rprt_a2846903070824f4",
            },
            new Vantage.Inputs.DashboardWidgetArgs
            {
                Title = "Notes",
                WidgetableType = "free_text",
                Content = JsonSerializer.Serialize(new Dictionary<string, object?>
                {
                    ["type"] = "doc",
                    ["content"] = new[]
                    {
                        new Dictionary<string, object?>
                        {
                            ["type"] = "paragraph",
                            ["content"] = new[]
                            {
                                new Dictionary<string, object?>
                                {
                                    ["type"] = "text",
                                    ["text"] = "Use free text widgets for dashboard context.",
                                },
                            },
                        },
                    },
                }),
            },
        },
        WorkspaceToken = "wrkspc_47c3254c790e9351",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vantage.Dashboard;
import com.pulumi.vantage.DashboardArgs;
import com.pulumi.vantage.inputs.DashboardWidgetArgs;
import com.pulumi.vantage.inputs.DashboardWidgetSettingsArgs;
import com.pulumi.vantage.inputs.DashboardWidgetSettingsGridArgs;
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 demoDashboard = new Dashboard("demoDashboard", DashboardArgs.builder()
            .title("Demo Dashboard")
            .dateInterval("last_month")
            .widgets(            
                DashboardWidgetArgs.builder()
                    .settings(DashboardWidgetSettingsArgs.builder()
                        .displayType("chart")
                        .grid(DashboardWidgetSettingsGridArgs.builder()
                            .x(0.0)
                            .y(0.0)
                            .w(6.0)
                            .h(4.0)
                            .build())
                        .build())
                    .widgetableToken("rprt_a2846903070824f4")
                    .build(),
                DashboardWidgetArgs.builder()
                    .settings(DashboardWidgetSettingsArgs.builder()
                        .displayType("kpi")
                        .kpiCalculation("sum")
                        .kpiType("cost")
                        .grid(DashboardWidgetSettingsGridArgs.builder()
                            .x(6.0)
                            .y(0.0)
                            .w(6.0)
                            .h(4.0)
                            .build())
                        .build())
                    .title("Total Spend")
                    .widgetableToken("rprt_a2846903070824f4")
                    .build(),
                DashboardWidgetArgs.builder()
                    .title("Notes")
                    .widgetableType("free_text")
                    .content(serializeJson(
                        jsonObject(
                            jsonProperty("type", "doc"),
                            jsonProperty("content", jsonArray(jsonObject(
                                jsonProperty("type", "paragraph"),
                                jsonProperty("content", jsonArray(jsonObject(
                                    jsonProperty("type", "text"),
                                    jsonProperty("text", "Use free text widgets for dashboard context.")
                                )))
                            )))
                        )))
                    .build())
            .workspaceToken("wrkspc_47c3254c790e9351")
            .build());

    }
}

    resources:
  demoDashboard:
    type: vantage:Dashboard
    name: demo_dashboard
    properties:
      title: Demo Dashboard
      dateInterval: last_month
      widgets:
        - settings:
            displayType: chart
            grid:
              x: 0
              y: 0
              w: 6
              h: 4
          widgetableToken: rprt_a2846903070824f4
        - settings:
            displayType: kpi
            kpiCalculation: sum
            kpiType: cost
            grid:
              x: 6
              y: 0
              w: 6
              h: 4
          title: Total Spend
          widgetableToken: rprt_a2846903070824f4
        - title: Notes
          widgetableType: free_text
          content:
            fn::toJSON:
              type: doc
              content:
                - type: paragraph
                  content:
                    - type: text
                      text: Use free text widgets for dashboard context.
      workspaceToken: wrkspc_47c3254c790e9351

    Example coming soon!

    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: Optional[DashboardArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Dashboard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              date_bin: Optional[str] = None,
              date_interval: Optional[str] = None,
              end_date: Optional[str] = None,
              saved_filter_tokens: Optional[Sequence[str]] = None,
              start_date: Optional[str] = None,
              title: Optional[str] = None,
              widgets: Optional[Sequence[DashboardWidgetArgs]] = None,
              workspace_token: Optional[str] = None)
    func NewDashboard(ctx *Context, name string, args *DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
    public Dashboard(string name, DashboardArgs? args = null, CustomResourceOptions? opts = null)
    public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)

    type: vantage:Dashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "vantage_dashboard" "name" {
    # resource properties
}

    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.

    Constructor example

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

    var dashboardResource = new Vantage.Dashboard("dashboardResource", new()
{
    DateBin = "string",
    DateInterval = "string",
    EndDate = "string",
    SavedFilterTokens = new[]
    {
        "string",
    },
    StartDate = "string",
    Title = "string",
    Widgets = new[]
    {
        new Vantage.Inputs.DashboardWidgetArgs
        {
            Content = "string",
            Settings = new Vantage.Inputs.DashboardWidgetSettingsArgs
            {
                DisplayType = "string",
                Grid = new Vantage.Inputs.DashboardWidgetSettingsGridArgs
                {
                    H = 0.0,
                    W = 0.0,
                    X = 0.0,
                    Y = 0.0,
                },
                KpiCalculation = "string",
                KpiType = "string",
                KpiUsageUnit = "string",
            },
            Title = "string",
            Token = "string",
            WidgetableToken = "string",
            WidgetableType = "string",
        },
    },
    WorkspaceToken = "string",
});

    example, err := vantage.NewDashboard(ctx, "dashboardResource", &vantage.DashboardArgs{
	DateBin:      pulumi.String("string"),
	DateInterval: pulumi.String("string"),
	EndDate:      pulumi.String("string"),
	SavedFilterTokens: pulumi.StringArray{
		pulumi.String("string"),
	},
	StartDate: pulumi.String("string"),
	Title:     pulumi.String("string"),
	Widgets: vantage.DashboardWidgetArray{
		&vantage.DashboardWidgetArgs{
			Content: pulumi.String("string"),
			Settings: &vantage.DashboardWidgetSettingsArgs{
				DisplayType: pulumi.String("string"),
				Grid: &vantage.DashboardWidgetSettingsGridArgs{
					H: pulumi.Float64(0),
					W: pulumi.Float64(0),
					X: pulumi.Float64(0),
					Y: pulumi.Float64(0),
				},
				KpiCalculation: pulumi.String("string"),
				KpiType:        pulumi.String("string"),
				KpiUsageUnit:   pulumi.String("string"),
			},
			Title:           pulumi.String("string"),
			Token:           pulumi.String("string"),
			WidgetableToken: pulumi.String("string"),
			WidgetableType:  pulumi.String("string"),
		},
	},
	WorkspaceToken: pulumi.String("string"),
})

    resource "vantage_dashboard" "dashboardResource" {
  lifecycle {
    create_before_destroy = true
  }
  date_bin            = "string"
  date_interval       = "string"
  end_date            = "string"
  saved_filter_tokens = ["string"]
  start_date          = "string"
  title               = "string"
  widgets {
    content = "string"
    settings = {
      display_type = "string"
      grid = {
        h = 0
        w = 0
        x = 0
        y = 0
      }
      kpi_calculation = "string"
      kpi_type        = "string"
      kpi_usage_unit  = "string"
    }
    title            = "string"
    token            = "string"
    widgetable_token = "string"
    widgetable_type  = "string"
  }
  workspace_token = "string"
}

    var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
    .dateBin("string")
    .dateInterval("string")
    .endDate("string")
    .savedFilterTokens("string")
    .startDate("string")
    .title("string")
    .widgets(DashboardWidgetArgs.builder()
        .content("string")
        .settings(DashboardWidgetSettingsArgs.builder()
            .displayType("string")
            .grid(DashboardWidgetSettingsGridArgs.builder()
                .h(0.0)
                .w(0.0)
                .x(0.0)
                .y(0.0)
                .build())
            .kpiCalculation("string")
            .kpiType("string")
            .kpiUsageUnit("string")
            .build())
        .title("string")
        .token("string")
        .widgetableToken("string")
        .widgetableType("string")
        .build())
    .workspaceToken("string")
    .build());

    dashboard_resource = vantage.Dashboard("dashboardResource",
    date_bin="string",
    date_interval="string",
    end_date="string",
    saved_filter_tokens=["string"],
    start_date="string",
    title="string",
    widgets=[{
        "content": "string",
        "settings": {
            "display_type": "string",
            "grid": {
                "h": float(0),
                "w": float(0),
                "x": float(0),
                "y": float(0),
            },
            "kpi_calculation": "string",
            "kpi_type": "string",
            "kpi_usage_unit": "string",
        },
        "title": "string",
        "token": "string",
        "widgetable_token": "string",
        "widgetable_type": "string",
    }],
    workspace_token="string")

    const dashboardResource = new vantage.Dashboard("dashboardResource", {
    dateBin: "string",
    dateInterval: "string",
    endDate: "string",
    savedFilterTokens: ["string"],
    startDate: "string",
    title: "string",
    widgets: [{
        content: "string",
        settings: {
            displayType: "string",
            grid: {
                h: 0,
                w: 0,
                x: 0,
                y: 0,
            },
            kpiCalculation: "string",
            kpiType: "string",
            kpiUsageUnit: "string",
        },
        title: "string",
        token: "string",
        widgetableToken: "string",
        widgetableType: "string",
    }],
    workspaceToken: "string",
});

    type: vantage:Dashboard
properties:
    dateBin: string
    dateInterval: string
    endDate: string
    savedFilterTokens:
        - string
    startDate: string
    title: string
    widgets:
        - content: string
          settings:
            displayType: string
            grid:
                h: 0
                w: 0
                x: 0
                "y": 0
            kpiCalculation: string
            kpiType: string
            kpiUsageUnit: string
          title: string
          token: string
          widgetableToken: string
          widgetableType: string
    workspaceToken: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Dashboard resource accepts the following input properties:

    DateBin string
    Determines how to group costs in the Dashboard.
    DateInterval string
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    EndDate string
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    SavedFilterTokens List<string>
    The tokens of the Saved Filters used in the Dashboard.
    StartDate string
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    Title string
    The title of the Dashboard.
    Widgets List<DashboardWidget>
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    WorkspaceToken string
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    DateBin string
    Determines how to group costs in the Dashboard.
    DateInterval string
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    EndDate string
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    SavedFilterTokens []string
    The tokens of the Saved Filters used in the Dashboard.
    StartDate string
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    Title string
    The title of the Dashboard.
    Widgets []DashboardWidgetArgs
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    WorkspaceToken string
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    date_bin string
    Determines how to group costs in the Dashboard.
    date_interval string
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    end_date string
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    saved_filter_tokens list(string)
    The tokens of the Saved Filters used in the Dashboard.
    start_date string
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title string
    The title of the Dashboard.
    widgets list(object)
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    workspace_token string
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    dateBin String
    Determines how to group costs in the Dashboard.
    dateInterval String
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    endDate String
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    savedFilterTokens List<String>
    The tokens of the Saved Filters used in the Dashboard.
    startDate String
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title String
    The title of the Dashboard.
    widgets List<DashboardWidget>
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    workspaceToken String
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    dateBin string
    Determines how to group costs in the Dashboard.
    dateInterval string
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    endDate string
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    savedFilterTokens string[]
    The tokens of the Saved Filters used in the Dashboard.
    startDate string
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title string
    The title of the Dashboard.
    widgets DashboardWidget[]
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    workspaceToken string
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    date_bin str
    Determines how to group costs in the Dashboard.
    date_interval str
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    end_date str
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    saved_filter_tokens Sequence[str]
    The tokens of the Saved Filters used in the Dashboard.
    start_date str
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title str
    The title of the Dashboard.
    widgets Sequence[DashboardWidgetArgs]
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    workspace_token str
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    dateBin String
    Determines how to group costs in the Dashboard.
    dateInterval String
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    endDate String
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    savedFilterTokens List<String>
    The tokens of the Saved Filters used in the Dashboard.
    startDate String
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title String
    The title of the Dashboard.
    widgets List<Property Map>
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    workspaceToken String
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.

    Outputs

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

    CreatedAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the dashboard
    CreatedAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the dashboard
    created_at string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the dashboard
    createdAt String
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the dashboard
    createdAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the dashboard
    created_at str
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The token of the dashboard
    createdAt String
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the dashboard

    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,
        created_at: Optional[str] = None,
        date_bin: Optional[str] = None,
        date_interval: Optional[str] = None,
        end_date: Optional[str] = None,
        saved_filter_tokens: Optional[Sequence[str]] = None,
        start_date: Optional[str] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        widgets: Optional[Sequence[DashboardWidgetArgs]] = None,
        workspace_token: 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)
    resources:  _:    type: vantage:Dashboard    get:      id: ${id}
    import {
  to = vantage_dashboard.example
  id = "${id}"
}
    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:
    CreatedAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    DateBin string
    Determines how to group costs in the Dashboard.
    DateInterval string
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    EndDate string
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    SavedFilterTokens List<string>
    The tokens of the Saved Filters used in the Dashboard.
    StartDate string
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    Title string
    The title of the Dashboard.
    Token string
    The token of the dashboard
    Widgets List<DashboardWidget>
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    WorkspaceToken string
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    CreatedAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    DateBin string
    Determines how to group costs in the Dashboard.
    DateInterval string
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    EndDate string
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    SavedFilterTokens []string
    The tokens of the Saved Filters used in the Dashboard.
    StartDate string
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    Title string
    The title of the Dashboard.
    Token string
    The token of the dashboard
    Widgets []DashboardWidgetArgs
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    WorkspaceToken string
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    created_at string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    date_bin string
    Determines how to group costs in the Dashboard.
    date_interval string
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    end_date string
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    saved_filter_tokens list(string)
    The tokens of the Saved Filters used in the Dashboard.
    start_date string
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title string
    The title of the Dashboard.
    token string
    The token of the dashboard
    widgets list(object)
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    workspace_token string
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    createdAt String
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    dateBin String
    Determines how to group costs in the Dashboard.
    dateInterval String
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    endDate String
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    savedFilterTokens List<String>
    The tokens of the Saved Filters used in the Dashboard.
    startDate String
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title String
    The title of the Dashboard.
    token String
    The token of the dashboard
    widgets List<DashboardWidget>
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    workspaceToken String
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    createdAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    dateBin string
    Determines how to group costs in the Dashboard.
    dateInterval string
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    endDate string
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    savedFilterTokens string[]
    The tokens of the Saved Filters used in the Dashboard.
    startDate string
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title string
    The title of the Dashboard.
    token string
    The token of the dashboard
    widgets DashboardWidget[]
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    workspaceToken string
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    created_at str
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    date_bin str
    Determines how to group costs in the Dashboard.
    date_interval str
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    end_date str
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    saved_filter_tokens Sequence[str]
    The tokens of the Saved Filters used in the Dashboard.
    start_date str
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title str
    The title of the Dashboard.
    token str
    The token of the dashboard
    widgets Sequence[DashboardWidgetArgs]
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    workspace_token str
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
    createdAt String
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    dateBin String
    Determines how to group costs in the Dashboard.
    dateInterval String
    Determines the date range in the Dashboard. Incompatible with 'startdate' and 'enddate' parameters.
    endDate String
    The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    savedFilterTokens List<String>
    The tokens of the Saved Filters used in the Dashboard.
    startDate String
    The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title String
    The title of the Dashboard.
    token String
    The token of the dashboard
    widgets List<Property Map>
    The widgets to add to the Dashboard. Report-backed widgets use widgetabletoken. Free text widgets use widgetabletype set to free_text and require content.
    workspaceToken String
    The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.

    Supporting Types

    DashboardWidget, DashboardWidgetArgs

    Content string
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    Settings DashboardWidgetSettings
    The display and grid layout settings for the DashboardWidget.
    Title string
    The title of the Widget (defaults to the Resource title, or Free Text for a free text widget).
    Token string
    The token of the Dashboard Widget.
    WidgetableToken string
    The token of the represented Resource.
    WidgetableType string
    The widget type. Use free_text for a free text widget.
    Content string
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    Settings DashboardWidgetSettings
    The display and grid layout settings for the DashboardWidget.
    Title string
    The title of the Widget (defaults to the Resource title, or Free Text for a free text widget).
    Token string
    The token of the Dashboard Widget.
    WidgetableToken string
    The token of the represented Resource.
    WidgetableType string
    The widget type. Use free_text for a free text widget.
    content string
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    settings object
    The display and grid layout settings for the DashboardWidget.
    title string
    The title of the Widget (defaults to the Resource title, or Free Text for a free text widget).
    token string
    The token of the Dashboard Widget.
    widgetable_token string
    The token of the represented Resource.
    widgetable_type string
    The widget type. Use free_text for a free text widget.
    content String
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    settings DashboardWidgetSettings
    The display and grid layout settings for the DashboardWidget.
    title String
    The title of the Widget (defaults to the Resource title, or Free Text for a free text widget).
    token String
    The token of the Dashboard Widget.
    widgetableToken String
    The token of the represented Resource.
    widgetableType String
    The widget type. Use free_text for a free text widget.
    content string
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    settings DashboardWidgetSettings
    The display and grid layout settings for the DashboardWidget.
    title string
    The title of the Widget (defaults to the Resource title, or Free Text for a free text widget).
    token string
    The token of the Dashboard Widget.
    widgetableToken string
    The token of the represented Resource.
    widgetableType string
    The widget type. Use free_text for a free text widget.
    content str
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    settings DashboardWidgetSettings
    The display and grid layout settings for the DashboardWidget.
    title str
    The title of the Widget (defaults to the Resource title, or Free Text for a free text widget).
    token str
    The token of the Dashboard Widget.
    widgetable_token str
    The token of the represented Resource.
    widgetable_type str
    The widget type. Use free_text for a free text widget.
    content String
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    settings Property Map
    The display and grid layout settings for the DashboardWidget.
    title String
    The title of the Widget (defaults to the Resource title, or Free Text for a free text widget).
    token String
    The token of the Dashboard Widget.
    widgetableToken String
    The token of the represented Resource.
    widgetableType String
    The widget type. Use free_text for a free text widget.

    DashboardWidgetSettings, DashboardWidgetSettingsArgs

    DisplayType string
    Grid DashboardWidgetSettingsGrid
    The widget's size and position in the dashboard's 12-column grid.
    KpiCalculation string
    The aggregation used when display_type is kpi.
    KpiType string
    The metric represented when display_type is kpi.
    KpiUsageUnit string
    The usage unit represented when kpi_type is usage.
    DisplayType string
    Grid DashboardWidgetSettingsGrid
    The widget's size and position in the dashboard's 12-column grid.
    KpiCalculation string
    The aggregation used when display_type is kpi.
    KpiType string
    The metric represented when display_type is kpi.
    KpiUsageUnit string
    The usage unit represented when kpi_type is usage.
    display_type string
    grid object
    The widget's size and position in the dashboard's 12-column grid.
    kpi_calculation string
    The aggregation used when display_type is kpi.
    kpi_type string
    The metric represented when display_type is kpi.
    kpi_usage_unit string
    The usage unit represented when kpi_type is usage.
    displayType String
    grid DashboardWidgetSettingsGrid
    The widget's size and position in the dashboard's 12-column grid.
    kpiCalculation String
    The aggregation used when display_type is kpi.
    kpiType String
    The metric represented when display_type is kpi.
    kpiUsageUnit String
    The usage unit represented when kpi_type is usage.
    displayType string
    grid DashboardWidgetSettingsGrid
    The widget's size and position in the dashboard's 12-column grid.
    kpiCalculation string
    The aggregation used when display_type is kpi.
    kpiType string
    The metric represented when display_type is kpi.
    kpiUsageUnit string
    The usage unit represented when kpi_type is usage.
    display_type str
    grid DashboardWidgetSettingsGrid
    The widget's size and position in the dashboard's 12-column grid.
    kpi_calculation str
    The aggregation used when display_type is kpi.
    kpi_type str
    The metric represented when display_type is kpi.
    kpi_usage_unit str
    The usage unit represented when kpi_type is usage.
    displayType String
    grid Property Map
    The widget's size and position in the dashboard's 12-column grid.
    kpiCalculation String
    The aggregation used when display_type is kpi.
    kpiType String
    The metric represented when display_type is kpi.
    kpiUsageUnit String
    The usage unit represented when kpi_type is usage.

    DashboardWidgetSettingsGrid, DashboardWidgetSettingsGridArgs

    H double
    The widget height in grid rows.
    W double
    The widget width in grid columns.
    X double
    The zero-based horizontal position.
    Y double
    The zero-based vertical position.
    H float64
    The widget height in grid rows.
    W float64
    The widget width in grid columns.
    X float64
    The zero-based horizontal position.
    Y float64
    The zero-based vertical position.
    h number
    The widget height in grid rows.
    w number
    The widget width in grid columns.
    x number
    The zero-based horizontal position.
    y number
    The zero-based vertical position.
    h Double
    The widget height in grid rows.
    w Double
    The widget width in grid columns.
    x Double
    The zero-based horizontal position.
    y Double
    The zero-based vertical position.
    h number
    The widget height in grid rows.
    w number
    The widget width in grid columns.
    x number
    The zero-based horizontal position.
    y number
    The zero-based vertical position.
    h float
    The widget height in grid rows.
    w float
    The widget width in grid columns.
    x float
    The zero-based horizontal position.
    y float
    The zero-based vertical position.
    h Number
    The widget height in grid rows.
    w Number
    The widget width in grid columns.
    x Number
    The zero-based horizontal position.
    y Number
    The zero-based vertical position.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage
    Viewing docs for vantage 0.4.1
    published on Wednesday, Oct 7, 2026 by vantage-sh
    Schema (JSON)
    vantage-sh/terraform-provider-vantage

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial