1. Registry
  2. Packages
  3. Logzio Provider
  4. API Docs
  5. UnifiedDashboard
Viewing docs for logzio 1.29.0
published on Friday, Sep 25, 2026 by logzio
Viewing docs for logzio 1.29.0
published on Friday, Sep 25, 2026 by logzio

    # Unified Dashboard Provider

    Provides a Logz.io unified dashboard resource. This can be used to create and manage Perses-based unified dashboards in Logz.io.

    • Learn more about Logz.io’s unified dashboards API in Logz.io Docs.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as logzio from "@pulumi/logzio";
    
    const myDashboard = new logzio.UnifiedDashboard("my_dashboard", {
        folderId: "my-project-id",
        dashboardJson: `{
      \\"kind\\": \\"Dashboard\\",
      \\"metadata\\": {
        \\"name\\": \\"cpu-usage\\"
      },
      \\"spec\\": {
        \\"display\\": {
          \\"name\\": \\"CPU Usage\\"
        },
        \\"duration\\": \\"1h\\",
        \\"panels\\": {},
        \\"layouts\\": []
      }
    }
    `,
    });
    
    import pulumi
    import pulumi_logzio as logzio
    
    my_dashboard = logzio.UnifiedDashboard("my_dashboard",
        folder_id="my-project-id",
        dashboard_json="""{
      \"kind\": \"Dashboard\",
      \"metadata\": {
        \"name\": \"cpu-usage\"
      },
      \"spec\": {
        \"display\": {
          \"name\": \"CPU Usage\"
        },
        \"duration\": \"1h\",
        \"panels\": {},
        \"layouts\": []
      }
    }
    """)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/logzio/logzio"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := logzio.NewUnifiedDashboard(ctx, "my_dashboard", &logzio.UnifiedDashboardArgs{
    			FolderId: pulumi.String("my-project-id"),
    			DashboardJson: pulumi.String(`{
      \"kind\": \"Dashboard\",
      \"metadata\": {
        \"name\": \"cpu-usage\"
      },
      \"spec\": {
        \"display\": {
          \"name\": \"CPU Usage\"
        },
        \"duration\": \"1h\",
        \"panels\": {},
        \"layouts\": []
      }
    }
    `),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Logzio = Pulumi.Logzio;
    
    return await Deployment.RunAsync(() => 
    {
        var myDashboard = new Logzio.UnifiedDashboard("my_dashboard", new()
        {
            FolderId = "my-project-id",
            DashboardJson = @"{
      \""kind\"": \""Dashboard\"",
      \""metadata\"": {
        \""name\"": \""cpu-usage\""
      },
      \""spec\"": {
        \""display\"": {
          \""name\"": \""CPU Usage\""
        },
        \""duration\"": \""1h\"",
        \""panels\"": {},
        \""layouts\"": []
      }
    }
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.logzio.UnifiedDashboard;
    import com.pulumi.logzio.UnifiedDashboardArgs;
    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 myDashboard = new UnifiedDashboard("myDashboard", UnifiedDashboardArgs.builder()
                .folderId("my-project-id")
                .dashboardJson("""
    {
      \"kind\": \"Dashboard\",
      \"metadata\": {
        \"name\": \"cpu-usage\"
      },
      \"spec\": {
        \"display\": {
          \"name\": \"CPU Usage\"
        },
        \"duration\": \"1h\",
        \"panels\": {},
        \"layouts\": []
      }
    }
                """)
                .build());
    
        }
    }
    
    resources:
      myDashboard:
        type: logzio:UnifiedDashboard
        name: my_dashboard
        properties:
          folderId: my-project-id
          dashboardJson: |
            {
              \"kind\": \"Dashboard\",
              \"metadata\": {
                \"name\": \"cpu-usage\"
              },
              \"spec\": {
                \"display\": {
                  \"name\": \"CPU Usage\"
                },
                \"duration\": \"1h\",
                \"panels\": {},
                \"layouts\": []
              }
            }
    
    Example coming soon!
    

    Create UnifiedDashboard Resource

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

    Constructor syntax

    new UnifiedDashboard(name: string, args: UnifiedDashboardArgs, opts?: CustomResourceOptions);
    @overload
    def UnifiedDashboard(resource_name: str,
                         args: UnifiedDashboardArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def UnifiedDashboard(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         dashboard_json: Optional[str] = None,
                         folder_id: Optional[str] = None,
                         unified_dashboard_id: Optional[str] = None)
    func NewUnifiedDashboard(ctx *Context, name string, args UnifiedDashboardArgs, opts ...ResourceOption) (*UnifiedDashboard, error)
    public UnifiedDashboard(string name, UnifiedDashboardArgs args, CustomResourceOptions? opts = null)
    public UnifiedDashboard(String name, UnifiedDashboardArgs args)
    public UnifiedDashboard(String name, UnifiedDashboardArgs args, CustomResourceOptions options)
    
    type: logzio:UnifiedDashboard
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "logzio_unified_dashboard" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args UnifiedDashboardArgs
    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 UnifiedDashboardArgs
    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 UnifiedDashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UnifiedDashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UnifiedDashboardArgs
    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 unifiedDashboardResource = new Logzio.UnifiedDashboard("unifiedDashboardResource", new()
    {
        DashboardJson = "string",
        FolderId = "string",
        UnifiedDashboardId = "string",
    });
    
    example, err := logzio.NewUnifiedDashboard(ctx, "unifiedDashboardResource", &logzio.UnifiedDashboardArgs{
    	DashboardJson:      pulumi.String("string"),
    	FolderId:           pulumi.String("string"),
    	UnifiedDashboardId: pulumi.String("string"),
    })
    
    resource "logzio_unified_dashboard" "unifiedDashboardResource" {
      lifecycle {
        create_before_destroy = true
      }
      dashboard_json       = "string"
      folder_id            = "string"
      unified_dashboard_id = "string"
    }
    
    var unifiedDashboardResource = new UnifiedDashboard("unifiedDashboardResource", UnifiedDashboardArgs.builder()
        .dashboardJson("string")
        .folderId("string")
        .unifiedDashboardId("string")
        .build());
    
    unified_dashboard_resource = logzio.UnifiedDashboard("unifiedDashboardResource",
        dashboard_json="string",
        folder_id="string",
        unified_dashboard_id="string")
    
    const unifiedDashboardResource = new logzio.UnifiedDashboard("unifiedDashboardResource", {
        dashboardJson: "string",
        folderId: "string",
        unifiedDashboardId: "string",
    });
    
    type: logzio:UnifiedDashboard
    properties:
        dashboardJson: string
        folderId: string
        unifiedDashboardId: string
    

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

    Outputs

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

    DashboardUid string
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (String) The dashboard's Perses identity (metadata.name).
    Version double
    (Int) Dashboard version.
    DashboardUid string
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (String) The dashboard's Perses identity (metadata.name).
    Version float64
    (Int) Dashboard version.
    dashboard_uid string
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (String) The dashboard's Perses identity (metadata.name).
    version number
    (Int) Dashboard version.
    dashboardUid String
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (String) The dashboard's Perses identity (metadata.name).
    version Double
    (Int) Dashboard version.
    dashboardUid string
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (String) The dashboard's Perses identity (metadata.name).
    version number
    (Int) Dashboard version.
    dashboard_uid str
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (String) The dashboard's Perses identity (metadata.name).
    version float
    (Int) Dashboard version.
    dashboardUid String
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (String) The dashboard's Perses identity (metadata.name).
    version Number
    (Int) Dashboard version.

    Look up Existing UnifiedDashboard Resource

    Get an existing UnifiedDashboard 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?: UnifiedDashboardState, opts?: CustomResourceOptions): UnifiedDashboard
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dashboard_json: Optional[str] = None,
            dashboard_uid: Optional[str] = None,
            folder_id: Optional[str] = None,
            name: Optional[str] = None,
            unified_dashboard_id: Optional[str] = None,
            version: Optional[float] = None) -> UnifiedDashboard
    func GetUnifiedDashboard(ctx *Context, name string, id IDInput, state *UnifiedDashboardState, opts ...ResourceOption) (*UnifiedDashboard, error)
    public static UnifiedDashboard Get(string name, Input<string> id, UnifiedDashboardState? state, CustomResourceOptions? opts = null)
    public static UnifiedDashboard get(String name, Output<String> id, UnifiedDashboardState state, CustomResourceOptions options)
    resources:  _:    type: logzio:UnifiedDashboard    get:      id: ${id}
    import {
      to = logzio_unified_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:
    DashboardJson string
    DashboardUid string
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    FolderId string
    Name string
    (String) The dashboard's Perses identity (metadata.name).
    UnifiedDashboardId string
    Version double
    (Int) Dashboard version.
    DashboardJson string
    DashboardUid string
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    FolderId string
    Name string
    (String) The dashboard's Perses identity (metadata.name).
    UnifiedDashboardId string
    Version float64
    (Int) Dashboard version.
    dashboard_json string
    dashboard_uid string
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    folder_id string
    name string
    (String) The dashboard's Perses identity (metadata.name).
    unified_dashboard_id string
    version number
    (Int) Dashboard version.
    dashboardJson String
    dashboardUid String
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    folderId String
    name String
    (String) The dashboard's Perses identity (metadata.name).
    unifiedDashboardId String
    version Double
    (Int) Dashboard version.
    dashboardJson string
    dashboardUid string
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    folderId string
    name string
    (String) The dashboard's Perses identity (metadata.name).
    unifiedDashboardId string
    version number
    (Int) Dashboard version.
    dashboard_json str
    dashboard_uid str
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    folder_id str
    name str
    (String) The dashboard's Perses identity (metadata.name).
    unified_dashboard_id str
    version float
    (Int) Dashboard version.
    dashboardJson String
    dashboardUid String
    (String) The stable unique identifier of the dashboard. Persist this value; do not use the API's version-row id.
    folderId String
    name String
    (String) The dashboard's Perses identity (metadata.name).
    unifiedDashboardId String
    version Number
    (Int) Dashboard version.

    Package Details

    Repository
    logzio logzio/terraform-provider-logzio
    License
    Notes
    This Pulumi package is based on the logzio Terraform Provider.
    Viewing docs for logzio 1.29.0
    published on Friday, Sep 25, 2026 by logzio

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial