Docs Packages
  1. Pulumi Registry
  2. Grafana Cloud
  3. API Docs
  4. Report
grafana logo
Grafana v0.0.10, May 21 23

grafana.Report

Explore with Pulumi AI

Note: This resource is available only with Grafana Enterprise 7.+.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Lbrlabs.PulumiPackage.Grafana;

return await Deployment.RunAsync(() => 
{
    var testDashboard = new Grafana.Dashboard("testDashboard", new()
    {
        ConfigJson = @"{
  ""title"": ""Dashboard for report"",
  ""uid"": ""report""
}
",
        Message = "inital commit.",
    });

    var testReport = new Grafana.Report("testReport", new()
    {
        DashboardUid = testDashboard.Uid,
        Recipients = new[]
        {
            "some@email.com",
        },
        Schedule = new Grafana.Inputs.ReportScheduleArgs
        {
            Frequency = "hourly",
        },
    });

});

package main

import (
	"github.com/lbrlabs/pulumi-grafana/sdk/go/grafana"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testDashboard, err := grafana.NewDashboard(ctx, "testDashboard", &grafana.DashboardArgs{
			ConfigJson: pulumi.String("{\n  \"title\": \"Dashboard for report\",\n  \"uid\": \"report\"\n}\n"),
			Message:    pulumi.String("inital commit."),
		})
		if err != nil {
			return err
		}
		_, err = grafana.NewReport(ctx, "testReport", &grafana.ReportArgs{
			DashboardUid: testDashboard.Uid,
			Recipients: pulumi.StringArray{
				pulumi.String("some@email.com"),
			},
			Schedule: &grafana.ReportScheduleArgs{
				Frequency: pulumi.String("hourly"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.Dashboard;
import com.pulumi.grafana.DashboardArgs;
import com.pulumi.grafana.Report;
import com.pulumi.grafana.ReportArgs;
import com.pulumi.grafana.inputs.ReportScheduleArgs;
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 testDashboard = new Dashboard("testDashboard", DashboardArgs.builder()        
            .configJson("""
{
  "title": "Dashboard for report",
  "uid": "report"
}
            """)
            .message("inital commit.")
            .build());

        var testReport = new Report("testReport", ReportArgs.builder()        
            .dashboardUid(testDashboard.uid())
            .recipients("some@email.com")
            .schedule(ReportScheduleArgs.builder()
                .frequency("hourly")
                .build())
            .build());

    }
}

import pulumi
import lbrlabs_pulumi_grafana as grafana

test_dashboard = grafana.Dashboard("testDashboard",
    config_json="""{
  "title": "Dashboard for report",
  "uid": "report"
}
""",
    message="inital commit.")
test_report = grafana.Report("testReport",
    dashboard_uid=test_dashboard.uid,
    recipients=["some@email.com"],
    schedule=grafana.ReportScheduleArgs(
        frequency="hourly",
    ))

import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@lbrlabs/pulumi-grafana";

const testDashboard = new grafana.Dashboard("testDashboard", {
    configJson: `{
  "title": "Dashboard for report",
  "uid": "report"
}
`,
    message: "inital commit.",
});
const testReport = new grafana.Report("testReport", {
    dashboardUid: testDashboard.uid,
    recipients: ["some@email.com"],
    schedule: {
        frequency: "hourly",
    },
});

resources:
  testDashboard:
    type: grafana:Dashboard
    properties:
      configJson: |
        {
          "title": "Dashboard for report",
          "uid": "report"
        }        
      message: inital commit.
  testReport:
    type: grafana:Report
    properties:
      dashboardUid: ${testDashboard.uid}
      recipients:
        - some@email.com
      schedule:
        frequency: hourly

Create Report Resource

new Report(name: string, args: ReportArgs, opts?: CustomResourceOptions);
@overload
def Report(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           dashboard_id: Optional[int] = None,
           dashboard_uid: Optional[str] = None,
           include_dashboard_link: Optional[bool] = None,
           include_table_csv: Optional[bool] = None,
           layout: Optional[str] = None,
           message: Optional[str] = None,
           name: Optional[str] = None,
           orientation: Optional[str] = None,
           recipients: Optional[Sequence[str]] = None,
           reply_to: Optional[str] = None,
           schedule: Optional[ReportScheduleArgs] = None,
           time_range: Optional[ReportTimeRangeArgs] = None)
@overload
def Report(resource_name: str,
           args: ReportArgs,
           opts: Optional[ResourceOptions] = None)
func NewReport(ctx *Context, name string, args ReportArgs, opts ...ResourceOption) (*Report, error)
public Report(string name, ReportArgs args, CustomResourceOptions? opts = null)
public Report(String name, ReportArgs args)
public Report(String name, ReportArgs args, CustomResourceOptions options)

type: grafana:Report
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ReportArgs
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 ReportArgs
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 ReportArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ReportArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ReportArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Report Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Report resource accepts the following input properties:

Recipients List<string>

List of recipients of the report.

Schedule Lbrlabs.PulumiPackage.Grafana.Inputs.ReportScheduleArgs

Schedule of the report.

DashboardId int

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

DashboardUid string

Dashboard to be sent in the report.

IncludeDashboardLink bool

Whether to include a link to the dashboard in the report. Defaults to true.

IncludeTableCsv bool

Whether to include a CSV file of table panel data. Defaults to false.

Layout string

Layout of the report. Allowed values: simple, grid. Defaults to grid.

Message string

Message to be sent in the report.

Name string

Name of the report.

Orientation string

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

ReplyTo string

Reply-to email address of the report.

TimeRange Lbrlabs.PulumiPackage.Grafana.Inputs.ReportTimeRangeArgs

Time range of the report.

Recipients []string

List of recipients of the report.

Schedule ReportScheduleArgs

Schedule of the report.

DashboardId int

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

DashboardUid string

Dashboard to be sent in the report.

IncludeDashboardLink bool

Whether to include a link to the dashboard in the report. Defaults to true.

IncludeTableCsv bool

Whether to include a CSV file of table panel data. Defaults to false.

Layout string

Layout of the report. Allowed values: simple, grid. Defaults to grid.

Message string

Message to be sent in the report.

Name string

Name of the report.

Orientation string

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

ReplyTo string

Reply-to email address of the report.

TimeRange ReportTimeRangeArgs

Time range of the report.

recipients List<String>

List of recipients of the report.

schedule ReportScheduleArgs

Schedule of the report.

dashboardId Integer

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

dashboardUid String

Dashboard to be sent in the report.

includeDashboardLink Boolean

Whether to include a link to the dashboard in the report. Defaults to true.

includeTableCsv Boolean

Whether to include a CSV file of table panel data. Defaults to false.

layout String

Layout of the report. Allowed values: simple, grid. Defaults to grid.

message String

Message to be sent in the report.

name String

Name of the report.

orientation String

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

replyTo String

Reply-to email address of the report.

timeRange ReportTimeRangeArgs

Time range of the report.

recipients string[]

List of recipients of the report.

schedule ReportScheduleArgs

Schedule of the report.

dashboardId number

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

dashboardUid string

Dashboard to be sent in the report.

includeDashboardLink boolean

Whether to include a link to the dashboard in the report. Defaults to true.

includeTableCsv boolean

Whether to include a CSV file of table panel data. Defaults to false.

layout string

Layout of the report. Allowed values: simple, grid. Defaults to grid.

message string

Message to be sent in the report.

name string

Name of the report.

orientation string

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

replyTo string

Reply-to email address of the report.

timeRange ReportTimeRangeArgs

Time range of the report.

recipients Sequence[str]

List of recipients of the report.

schedule ReportScheduleArgs

Schedule of the report.

dashboard_id int

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

dashboard_uid str

Dashboard to be sent in the report.

include_dashboard_link bool

Whether to include a link to the dashboard in the report. Defaults to true.

include_table_csv bool

Whether to include a CSV file of table panel data. Defaults to false.

layout str

Layout of the report. Allowed values: simple, grid. Defaults to grid.

message str

Message to be sent in the report.

name str

Name of the report.

orientation str

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

reply_to str

Reply-to email address of the report.

time_range ReportTimeRangeArgs

Time range of the report.

recipients List<String>

List of recipients of the report.

schedule Property Map

Schedule of the report.

dashboardId Number

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

dashboardUid String

Dashboard to be sent in the report.

includeDashboardLink Boolean

Whether to include a link to the dashboard in the report. Defaults to true.

includeTableCsv Boolean

Whether to include a CSV file of table panel data. Defaults to false.

layout String

Layout of the report. Allowed values: simple, grid. Defaults to grid.

message String

Message to be sent in the report.

name String

Name of the report.

orientation String

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

replyTo String

Reply-to email address of the report.

timeRange Property Map

Time range of the report.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing Report Resource

Get an existing Report 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?: ReportState, opts?: CustomResourceOptions): Report
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dashboard_id: Optional[int] = None,
        dashboard_uid: Optional[str] = None,
        include_dashboard_link: Optional[bool] = None,
        include_table_csv: Optional[bool] = None,
        layout: Optional[str] = None,
        message: Optional[str] = None,
        name: Optional[str] = None,
        orientation: Optional[str] = None,
        recipients: Optional[Sequence[str]] = None,
        reply_to: Optional[str] = None,
        schedule: Optional[ReportScheduleArgs] = None,
        time_range: Optional[ReportTimeRangeArgs] = None) -> Report
func GetReport(ctx *Context, name string, id IDInput, state *ReportState, opts ...ResourceOption) (*Report, error)
public static Report Get(string name, Input<string> id, ReportState? state, CustomResourceOptions? opts = null)
public static Report get(String name, Output<String> id, ReportState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
DashboardId int

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

DashboardUid string

Dashboard to be sent in the report.

IncludeDashboardLink bool

Whether to include a link to the dashboard in the report. Defaults to true.

IncludeTableCsv bool

Whether to include a CSV file of table panel data. Defaults to false.

Layout string

Layout of the report. Allowed values: simple, grid. Defaults to grid.

Message string

Message to be sent in the report.

Name string

Name of the report.

Orientation string

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

Recipients List<string>

List of recipients of the report.

ReplyTo string

Reply-to email address of the report.

Schedule Lbrlabs.PulumiPackage.Grafana.Inputs.ReportScheduleArgs

Schedule of the report.

TimeRange Lbrlabs.PulumiPackage.Grafana.Inputs.ReportTimeRangeArgs

Time range of the report.

DashboardId int

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

DashboardUid string

Dashboard to be sent in the report.

IncludeDashboardLink bool

Whether to include a link to the dashboard in the report. Defaults to true.

IncludeTableCsv bool

Whether to include a CSV file of table panel data. Defaults to false.

Layout string

Layout of the report. Allowed values: simple, grid. Defaults to grid.

Message string

Message to be sent in the report.

Name string

Name of the report.

Orientation string

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

Recipients []string

List of recipients of the report.

ReplyTo string

Reply-to email address of the report.

Schedule ReportScheduleArgs

Schedule of the report.

TimeRange ReportTimeRangeArgs

Time range of the report.

dashboardId Integer

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

dashboardUid String

Dashboard to be sent in the report.

includeDashboardLink Boolean

Whether to include a link to the dashboard in the report. Defaults to true.

includeTableCsv Boolean

Whether to include a CSV file of table panel data. Defaults to false.

layout String

Layout of the report. Allowed values: simple, grid. Defaults to grid.

message String

Message to be sent in the report.

name String

Name of the report.

orientation String

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

recipients List<String>

List of recipients of the report.

replyTo String

Reply-to email address of the report.

schedule ReportScheduleArgs

Schedule of the report.

timeRange ReportTimeRangeArgs

Time range of the report.

dashboardId number

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

dashboardUid string

Dashboard to be sent in the report.

includeDashboardLink boolean

Whether to include a link to the dashboard in the report. Defaults to true.

includeTableCsv boolean

Whether to include a CSV file of table panel data. Defaults to false.

layout string

Layout of the report. Allowed values: simple, grid. Defaults to grid.

message string

Message to be sent in the report.

name string

Name of the report.

orientation string

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

recipients string[]

List of recipients of the report.

replyTo string

Reply-to email address of the report.

schedule ReportScheduleArgs

Schedule of the report.

timeRange ReportTimeRangeArgs

Time range of the report.

dashboard_id int

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

dashboard_uid str

Dashboard to be sent in the report.

include_dashboard_link bool

Whether to include a link to the dashboard in the report. Defaults to true.

include_table_csv bool

Whether to include a CSV file of table panel data. Defaults to false.

layout str

Layout of the report. Allowed values: simple, grid. Defaults to grid.

message str

Message to be sent in the report.

name str

Name of the report.

orientation str

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

recipients Sequence[str]

List of recipients of the report.

reply_to str

Reply-to email address of the report.

schedule ReportScheduleArgs

Schedule of the report.

time_range ReportTimeRangeArgs

Time range of the report.

dashboardId Number

Dashboard to be sent in the report. This field is deprecated, use dashboard_uid instead.

Deprecated:

Use dashboard_uid instead

dashboardUid String

Dashboard to be sent in the report.

includeDashboardLink Boolean

Whether to include a link to the dashboard in the report. Defaults to true.

includeTableCsv Boolean

Whether to include a CSV file of table panel data. Defaults to false.

layout String

Layout of the report. Allowed values: simple, grid. Defaults to grid.

message String

Message to be sent in the report.

name String

Name of the report.

orientation String

Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.

recipients List<String>

List of recipients of the report.

replyTo String

Reply-to email address of the report.

schedule Property Map

Schedule of the report.

timeRange Property Map

Time range of the report.

Supporting Types

ReportSchedule

Frequency string

Frequency of the report. Allowed values: never, once, hourly, daily, weekly, monthly, custom.

CustomInterval string

Custom interval of the report. Note: This field is only available when frequency is set to custom.

EndTime string

End time of the report. If empty, the report will be sent indefinitely (according to frequency). Note that times will be saved as UTC in Grafana.

LastDayOfMonth bool

Send the report on the last day of the month Defaults to false.

StartTime string

Start time of the report. If empty, the start date will be set to the creation time. Note that times will be saved as UTC in Grafana.

WorkdaysOnly bool

Whether to send the report only on work days. Defaults to false.

Frequency string

Frequency of the report. Allowed values: never, once, hourly, daily, weekly, monthly, custom.

CustomInterval string

Custom interval of the report. Note: This field is only available when frequency is set to custom.

EndTime string

End time of the report. If empty, the report will be sent indefinitely (according to frequency). Note that times will be saved as UTC in Grafana.

LastDayOfMonth bool

Send the report on the last day of the month Defaults to false.

StartTime string

Start time of the report. If empty, the start date will be set to the creation time. Note that times will be saved as UTC in Grafana.

WorkdaysOnly bool

Whether to send the report only on work days. Defaults to false.

frequency String

Frequency of the report. Allowed values: never, once, hourly, daily, weekly, monthly, custom.

customInterval String

Custom interval of the report. Note: This field is only available when frequency is set to custom.

endTime String

End time of the report. If empty, the report will be sent indefinitely (according to frequency). Note that times will be saved as UTC in Grafana.

lastDayOfMonth Boolean

Send the report on the last day of the month Defaults to false.

startTime String

Start time of the report. If empty, the start date will be set to the creation time. Note that times will be saved as UTC in Grafana.

workdaysOnly Boolean

Whether to send the report only on work days. Defaults to false.

frequency string

Frequency of the report. Allowed values: never, once, hourly, daily, weekly, monthly, custom.

customInterval string

Custom interval of the report. Note: This field is only available when frequency is set to custom.

endTime string

End time of the report. If empty, the report will be sent indefinitely (according to frequency). Note that times will be saved as UTC in Grafana.

lastDayOfMonth boolean

Send the report on the last day of the month Defaults to false.

startTime string

Start time of the report. If empty, the start date will be set to the creation time. Note that times will be saved as UTC in Grafana.

workdaysOnly boolean

Whether to send the report only on work days. Defaults to false.

frequency str

Frequency of the report. Allowed values: never, once, hourly, daily, weekly, monthly, custom.

custom_interval str

Custom interval of the report. Note: This field is only available when frequency is set to custom.

end_time str

End time of the report. If empty, the report will be sent indefinitely (according to frequency). Note that times will be saved as UTC in Grafana.

last_day_of_month bool

Send the report on the last day of the month Defaults to false.

start_time str

Start time of the report. If empty, the start date will be set to the creation time. Note that times will be saved as UTC in Grafana.

workdays_only bool

Whether to send the report only on work days. Defaults to false.

frequency String

Frequency of the report. Allowed values: never, once, hourly, daily, weekly, monthly, custom.

customInterval String

Custom interval of the report. Note: This field is only available when frequency is set to custom.

endTime String

End time of the report. If empty, the report will be sent indefinitely (according to frequency). Note that times will be saved as UTC in Grafana.

lastDayOfMonth Boolean

Send the report on the last day of the month Defaults to false.

startTime String

Start time of the report. If empty, the start date will be set to the creation time. Note that times will be saved as UTC in Grafana.

workdaysOnly Boolean

Whether to send the report only on work days. Defaults to false.

ReportTimeRange

From string

Start of the time range.

To string

End of the time range.

From string

Start of the time range.

To string

End of the time range.

from String

Start of the time range.

to String

End of the time range.

from string

Start of the time range.

to string

End of the time range.

from_ str

Start of the time range.

to str

End of the time range.

from String

Start of the time range.

to String

End of the time range.

Package Details

Repository
grafana lbrlabs/pulumi-grafana
License
Apache-2.0
Notes

This Pulumi package is based on the grafana Terraform Provider.