1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. Dashboards
Harness v0.7.5 published on Thursday, Jun 19, 2025 by Pulumi

harness.platform.Dashboards

Explore with Pulumi AI

harness logo
Harness v0.7.5 published on Thursday, Jun 19, 2025 by Pulumi

    Resource for a Harness Custom Dashboard.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const example = new harness.platform.Dashboards("example", {
        dashboardId: "48507",
        description: "Example dashboard description",
        resourceIdentifier: "shared",
        title: "Example Dashboard",
        dataSources: [],
        models: [],
    });
    
    import pulumi
    import pulumi_harness as harness
    
    example = harness.platform.Dashboards("example",
        dashboard_id="48507",
        description="Example dashboard description",
        resource_identifier="shared",
        title="Example Dashboard",
        data_sources=[],
        models=[])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewDashboards(ctx, "example", &platform.DashboardsArgs{
    			DashboardId:        pulumi.String("48507"),
    			Description:        pulumi.String("Example dashboard description"),
    			ResourceIdentifier: pulumi.String("shared"),
    			Title:              pulumi.String("Example Dashboard"),
    			DataSources:        pulumi.StringArray{},
    			Models:             pulumi.StringArray{},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Harness.Platform.Dashboards("example", new()
        {
            DashboardId = "48507",
            Description = "Example dashboard description",
            ResourceIdentifier = "shared",
            Title = "Example Dashboard",
            DataSources = new[] {},
            Models = new[] {},
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.Dashboards;
    import com.pulumi.harness.platform.DashboardsArgs;
    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 example = new Dashboards("example", DashboardsArgs.builder()
                .dashboardId("48507")
                .description("Example dashboard description")
                .resourceIdentifier("shared")
                .title("Example Dashboard")
                .dataSources()
                .models()
                .build());
    
        }
    }
    
    resources:
      example:
        type: harness:platform:Dashboards
        properties:
          dashboardId: '48507'
          description: Example dashboard description
          resourceIdentifier: shared
          title: Example Dashboard
          dataSources: []
          models: []
    

    Create Dashboards Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Dashboards(name: string, args: DashboardsArgs, opts?: CustomResourceOptions);
    @overload
    def Dashboards(resource_name: str,
                   args: DashboardsArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Dashboards(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   dashboard_id: Optional[str] = None,
                   resource_identifier: Optional[str] = None,
                   created_at: Optional[str] = None,
                   data_sources: Optional[Sequence[str]] = None,
                   description: Optional[str] = None,
                   folder_id: Optional[str] = None,
                   models: Optional[Sequence[str]] = None,
                   name: Optional[str] = None,
                   title: Optional[str] = None,
                   type: Optional[str] = None,
                   view_count: Optional[int] = None)
    func NewDashboards(ctx *Context, name string, args DashboardsArgs, opts ...ResourceOption) (*Dashboards, error)
    public Dashboards(string name, DashboardsArgs args, CustomResourceOptions? opts = null)
    public Dashboards(String name, DashboardsArgs args)
    public Dashboards(String name, DashboardsArgs args, CustomResourceOptions options)
    
    type: harness:platform:Dashboards
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DashboardsArgs
    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 DashboardsArgs
    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 DashboardsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardsArgs
    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 dashboardsResource = new Harness.Platform.Dashboards("dashboardsResource", new()
    {
        DashboardId = "string",
        ResourceIdentifier = "string",
        CreatedAt = "string",
        DataSources = new[]
        {
            "string",
        },
        Description = "string",
        FolderId = "string",
        Models = new[]
        {
            "string",
        },
        Name = "string",
        Title = "string",
        Type = "string",
        ViewCount = 0,
    });
    
    example, err := platform.NewDashboards(ctx, "dashboardsResource", &platform.DashboardsArgs{
    	DashboardId:        pulumi.String("string"),
    	ResourceIdentifier: pulumi.String("string"),
    	CreatedAt:          pulumi.String("string"),
    	DataSources: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	FolderId:    pulumi.String("string"),
    	Models: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name:      pulumi.String("string"),
    	Title:     pulumi.String("string"),
    	Type:      pulumi.String("string"),
    	ViewCount: pulumi.Int(0),
    })
    
    var dashboardsResource = new Dashboards("dashboardsResource", DashboardsArgs.builder()
        .dashboardId("string")
        .resourceIdentifier("string")
        .createdAt("string")
        .dataSources("string")
        .description("string")
        .folderId("string")
        .models("string")
        .name("string")
        .title("string")
        .type("string")
        .viewCount(0)
        .build());
    
    dashboards_resource = harness.platform.Dashboards("dashboardsResource",
        dashboard_id="string",
        resource_identifier="string",
        created_at="string",
        data_sources=["string"],
        description="string",
        folder_id="string",
        models=["string"],
        name="string",
        title="string",
        type="string",
        view_count=0)
    
    const dashboardsResource = new harness.platform.Dashboards("dashboardsResource", {
        dashboardId: "string",
        resourceIdentifier: "string",
        createdAt: "string",
        dataSources: ["string"],
        description: "string",
        folderId: "string",
        models: ["string"],
        name: "string",
        title: "string",
        type: "string",
        viewCount: 0,
    });
    
    type: harness:platform:Dashboards
    properties:
        createdAt: string
        dashboardId: string
        dataSources:
            - string
        description: string
        folderId: string
        models:
            - string
        name: string
        resourceIdentifier: string
        title: string
        type: string
        viewCount: 0
    

    Dashboards 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 Dashboards resource accepts the following input properties:

    DashboardId string
    Unique identifier of the Template Dashboard to create from.
    ResourceIdentifier string
    The Folder ID that the Dashboard belongs to.
    CreatedAt string
    Created at timestamp of the Dashboard.
    DataSources List<string>
    Data Sources within the Dashboard.
    Description string
    Description of the Dashboard.
    FolderId string
    The Folder ID that the Dashboard belongs to.
    Models List<string>
    Data Models within the Dashboard.
    Name string
    Name of the Dashboard.
    Title string
    Title of the Dashboard.
    Type string
    Type of the dashboard.
    ViewCount int
    View count of the dashboard.
    DashboardId string
    Unique identifier of the Template Dashboard to create from.
    ResourceIdentifier string
    The Folder ID that the Dashboard belongs to.
    CreatedAt string
    Created at timestamp of the Dashboard.
    DataSources []string
    Data Sources within the Dashboard.
    Description string
    Description of the Dashboard.
    FolderId string
    The Folder ID that the Dashboard belongs to.
    Models []string
    Data Models within the Dashboard.
    Name string
    Name of the Dashboard.
    Title string
    Title of the Dashboard.
    Type string
    Type of the dashboard.
    ViewCount int
    View count of the dashboard.
    dashboardId String
    Unique identifier of the Template Dashboard to create from.
    resourceIdentifier String
    The Folder ID that the Dashboard belongs to.
    createdAt String
    Created at timestamp of the Dashboard.
    dataSources List<String>
    Data Sources within the Dashboard.
    description String
    Description of the Dashboard.
    folderId String
    The Folder ID that the Dashboard belongs to.
    models List<String>
    Data Models within the Dashboard.
    name String
    Name of the Dashboard.
    title String
    Title of the Dashboard.
    type String
    Type of the dashboard.
    viewCount Integer
    View count of the dashboard.
    dashboardId string
    Unique identifier of the Template Dashboard to create from.
    resourceIdentifier string
    The Folder ID that the Dashboard belongs to.
    createdAt string
    Created at timestamp of the Dashboard.
    dataSources string[]
    Data Sources within the Dashboard.
    description string
    Description of the Dashboard.
    folderId string
    The Folder ID that the Dashboard belongs to.
    models string[]
    Data Models within the Dashboard.
    name string
    Name of the Dashboard.
    title string
    Title of the Dashboard.
    type string
    Type of the dashboard.
    viewCount number
    View count of the dashboard.
    dashboard_id str
    Unique identifier of the Template Dashboard to create from.
    resource_identifier str
    The Folder ID that the Dashboard belongs to.
    created_at str
    Created at timestamp of the Dashboard.
    data_sources Sequence[str]
    Data Sources within the Dashboard.
    description str
    Description of the Dashboard.
    folder_id str
    The Folder ID that the Dashboard belongs to.
    models Sequence[str]
    Data Models within the Dashboard.
    name str
    Name of the Dashboard.
    title str
    Title of the Dashboard.
    type str
    Type of the dashboard.
    view_count int
    View count of the dashboard.
    dashboardId String
    Unique identifier of the Template Dashboard to create from.
    resourceIdentifier String
    The Folder ID that the Dashboard belongs to.
    createdAt String
    Created at timestamp of the Dashboard.
    dataSources List<String>
    Data Sources within the Dashboard.
    description String
    Description of the Dashboard.
    folderId String
    The Folder ID that the Dashboard belongs to.
    models List<String>
    Data Models within the Dashboard.
    name String
    Name of the Dashboard.
    title String
    Title of the Dashboard.
    type String
    Type of the dashboard.
    viewCount Number
    View count of the dashboard.

    Outputs

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

    FavoriteCount int
    Favorite count of the dashboard.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastAccessedAt string
    Last accessed at timestamp of the Dashboard.
    FavoriteCount int
    Favorite count of the dashboard.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastAccessedAt string
    Last accessed at timestamp of the Dashboard.
    favoriteCount Integer
    Favorite count of the dashboard.
    id String
    The provider-assigned unique ID for this managed resource.
    lastAccessedAt String
    Last accessed at timestamp of the Dashboard.
    favoriteCount number
    Favorite count of the dashboard.
    id string
    The provider-assigned unique ID for this managed resource.
    lastAccessedAt string
    Last accessed at timestamp of the Dashboard.
    favorite_count int
    Favorite count of the dashboard.
    id str
    The provider-assigned unique ID for this managed resource.
    last_accessed_at str
    Last accessed at timestamp of the Dashboard.
    favoriteCount Number
    Favorite count of the dashboard.
    id String
    The provider-assigned unique ID for this managed resource.
    lastAccessedAt String
    Last accessed at timestamp of the Dashboard.

    Look up Existing Dashboards Resource

    Get an existing Dashboards 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?: DashboardsState, opts?: CustomResourceOptions): Dashboards
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            dashboard_id: Optional[str] = None,
            data_sources: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            favorite_count: Optional[int] = None,
            folder_id: Optional[str] = None,
            last_accessed_at: Optional[str] = None,
            models: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            resource_identifier: Optional[str] = None,
            title: Optional[str] = None,
            type: Optional[str] = None,
            view_count: Optional[int] = None) -> Dashboards
    func GetDashboards(ctx *Context, name string, id IDInput, state *DashboardsState, opts ...ResourceOption) (*Dashboards, error)
    public static Dashboards Get(string name, Input<string> id, DashboardsState? state, CustomResourceOptions? opts = null)
    public static Dashboards get(String name, Output<String> id, DashboardsState state, CustomResourceOptions options)
    resources:  _:    type: harness:platform:Dashboards    get:      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
    Created at timestamp of the Dashboard.
    DashboardId string
    Unique identifier of the Template Dashboard to create from.
    DataSources List<string>
    Data Sources within the Dashboard.
    Description string
    Description of the Dashboard.
    FavoriteCount int
    Favorite count of the dashboard.
    FolderId string
    The Folder ID that the Dashboard belongs to.
    LastAccessedAt string
    Last accessed at timestamp of the Dashboard.
    Models List<string>
    Data Models within the Dashboard.
    Name string
    Name of the Dashboard.
    ResourceIdentifier string
    The Folder ID that the Dashboard belongs to.
    Title string
    Title of the Dashboard.
    Type string
    Type of the dashboard.
    ViewCount int
    View count of the dashboard.
    CreatedAt string
    Created at timestamp of the Dashboard.
    DashboardId string
    Unique identifier of the Template Dashboard to create from.
    DataSources []string
    Data Sources within the Dashboard.
    Description string
    Description of the Dashboard.
    FavoriteCount int
    Favorite count of the dashboard.
    FolderId string
    The Folder ID that the Dashboard belongs to.
    LastAccessedAt string
    Last accessed at timestamp of the Dashboard.
    Models []string
    Data Models within the Dashboard.
    Name string
    Name of the Dashboard.
    ResourceIdentifier string
    The Folder ID that the Dashboard belongs to.
    Title string
    Title of the Dashboard.
    Type string
    Type of the dashboard.
    ViewCount int
    View count of the dashboard.
    createdAt String
    Created at timestamp of the Dashboard.
    dashboardId String
    Unique identifier of the Template Dashboard to create from.
    dataSources List<String>
    Data Sources within the Dashboard.
    description String
    Description of the Dashboard.
    favoriteCount Integer
    Favorite count of the dashboard.
    folderId String
    The Folder ID that the Dashboard belongs to.
    lastAccessedAt String
    Last accessed at timestamp of the Dashboard.
    models List<String>
    Data Models within the Dashboard.
    name String
    Name of the Dashboard.
    resourceIdentifier String
    The Folder ID that the Dashboard belongs to.
    title String
    Title of the Dashboard.
    type String
    Type of the dashboard.
    viewCount Integer
    View count of the dashboard.
    createdAt string
    Created at timestamp of the Dashboard.
    dashboardId string
    Unique identifier of the Template Dashboard to create from.
    dataSources string[]
    Data Sources within the Dashboard.
    description string
    Description of the Dashboard.
    favoriteCount number
    Favorite count of the dashboard.
    folderId string
    The Folder ID that the Dashboard belongs to.
    lastAccessedAt string
    Last accessed at timestamp of the Dashboard.
    models string[]
    Data Models within the Dashboard.
    name string
    Name of the Dashboard.
    resourceIdentifier string
    The Folder ID that the Dashboard belongs to.
    title string
    Title of the Dashboard.
    type string
    Type of the dashboard.
    viewCount number
    View count of the dashboard.
    created_at str
    Created at timestamp of the Dashboard.
    dashboard_id str
    Unique identifier of the Template Dashboard to create from.
    data_sources Sequence[str]
    Data Sources within the Dashboard.
    description str
    Description of the Dashboard.
    favorite_count int
    Favorite count of the dashboard.
    folder_id str
    The Folder ID that the Dashboard belongs to.
    last_accessed_at str
    Last accessed at timestamp of the Dashboard.
    models Sequence[str]
    Data Models within the Dashboard.
    name str
    Name of the Dashboard.
    resource_identifier str
    The Folder ID that the Dashboard belongs to.
    title str
    Title of the Dashboard.
    type str
    Type of the dashboard.
    view_count int
    View count of the dashboard.
    createdAt String
    Created at timestamp of the Dashboard.
    dashboardId String
    Unique identifier of the Template Dashboard to create from.
    dataSources List<String>
    Data Sources within the Dashboard.
    description String
    Description of the Dashboard.
    favoriteCount Number
    Favorite count of the dashboard.
    folderId String
    The Folder ID that the Dashboard belongs to.
    lastAccessedAt String
    Last accessed at timestamp of the Dashboard.
    models List<String>
    Data Models within the Dashboard.
    name String
    Name of the Dashboard.
    resourceIdentifier String
    The Folder ID that the Dashboard belongs to.
    title String
    Title of the Dashboard.
    type String
    Type of the dashboard.
    viewCount Number
    View count of the dashboard.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.7.5 published on Thursday, Jun 19, 2025 by Pulumi