Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. enterprise
  5. Report
Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse
pulumiverse/pulumi-grafana

grafana.enterprise.Report

Explore with Pulumi AI

grafana logo
Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse
pulumiverse/pulumi-grafana

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@pulumiverse/grafana";

const test = new grafana.oss.Dashboard("test", {
    configJson: `{
  "uid": "report-dashboard",
  "title": "report-dashboard"
}
`,
    message: "inital commit.",
});
const testReport = new grafana.enterprise.Report("test", {
    name: "my report",
    recipients: ["some@email.com"],
    dashboards: [{
        uid: test.uid,
    }],
    schedule: {
        frequency: "hourly",
    },
});

    import pulumi
import pulumiverse_grafana as grafana

test = grafana.oss.Dashboard("test",
    config_json="""{
  "uid": "report-dashboard",
  "title": "report-dashboard"
}
""",
    message="inital commit.")
test_report = grafana.enterprise.Report("test",
    name="my report",
    recipients=["some@email.com"],
    dashboards=[{
        "uid": test.uid,
    }],
    schedule={
        "frequency": "hourly",
    })

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-grafana/sdk/go/grafana/enterprise"
	"github.com/pulumiverse/pulumi-grafana/sdk/go/grafana/oss"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := oss.NewDashboard(ctx, "test", &oss.DashboardArgs{
			ConfigJson: pulumi.String("{\n  \"uid\": \"report-dashboard\",\n  \"title\": \"report-dashboard\"\n}\n"),
			Message:    pulumi.String("inital commit."),
		})
		if err != nil {
			return err
		}
		_, err = enterprise.NewReport(ctx, "test", &enterprise.ReportArgs{
			Name: pulumi.String("my report"),
			Recipients: pulumi.StringArray{
				pulumi.String("some@email.com"),
			},
			Dashboards: enterprise.ReportDashboardArray{
				&enterprise.ReportDashboardArgs{
					Uid: test.Uid,
				},
			},
			Schedule: &enterprise.ReportScheduleArgs{
				Frequency: pulumi.String("hourly"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Pulumiverse.Grafana;

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

    var testReport = new Grafana.Enterprise.Report("test", new()
    {
        Name = "my report",
        Recipients = new[]
        {
            "some@email.com",
        },
        Dashboards = new[]
        {
            new Grafana.Enterprise.Inputs.ReportDashboardArgs
            {
                Uid = test.Uid,
            },
        },
        Schedule = new Grafana.Enterprise.Inputs.ReportScheduleArgs
        {
            Frequency = "hourly",
        },
    });

});

    package generated_program;

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

        var testReport = new Report("testReport", ReportArgs.builder()
            .name("my report")
            .recipients("some@email.com")
            .dashboards(ReportDashboardArgs.builder()
                .uid(test.uid())
                .build())
            .schedule(ReportScheduleArgs.builder()
                .frequency("hourly")
                .build())
            .build());

    }
}

    resources:
  test:
    type: grafana:oss:Dashboard
    properties:
      configJson: |
        {
          "uid": "report-dashboard",
          "title": "report-dashboard"
        }        
      message: inital commit.
  testReport:
    type: grafana:enterprise:Report
    name: test
    properties:
      name: my report
      recipients:
        - some@email.com
      dashboards:
        - uid: ${test.uid}
      schedule:
        frequency: hourly

    Create Report Resource

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

    Constructor syntax

    new Report(name: string, args: ReportArgs, opts?: CustomResourceOptions);
    @overload
def Report(resource_name: str,
           args: ReportArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Report(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           recipients: Optional[Sequence[str]] = None,
           schedule: Optional[ReportScheduleArgs] = None,
           dashboards: Optional[Sequence[ReportDashboardArgs]] = None,
           formats: Optional[Sequence[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,
           org_id: Optional[str] = None,
           orientation: Optional[str] = None,
           reply_to: Optional[str] = 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:enterprise:Report
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 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.

    Constructor example

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

    var reportResource = new Grafana.Enterprise.Report("reportResource", new()
{
    Recipients = new[]
    {
        "string",
    },
    Schedule = new Grafana.Enterprise.Inputs.ReportScheduleArgs
    {
        Frequency = "string",
        CustomInterval = "string",
        EndTime = "string",
        LastDayOfMonth = false,
        StartTime = "string",
        Timezone = "string",
        WorkdaysOnly = false,
    },
    Dashboards = new[]
    {
        new Grafana.Enterprise.Inputs.ReportDashboardArgs
        {
            Uid = "string",
            ReportVariables = 
            {
                { "string", "string" },
            },
            TimeRange = new Grafana.Enterprise.Inputs.ReportDashboardTimeRangeArgs
            {
                From = "string",
                To = "string",
            },
        },
    },
    Formats = new[]
    {
        "string",
    },
    IncludeDashboardLink = false,
    IncludeTableCsv = false,
    Layout = "string",
    Message = "string",
    Name = "string",
    OrgId = "string",
    Orientation = "string",
    ReplyTo = "string",
});

    example, err := enterprise.NewReport(ctx, "reportResource", &enterprise.ReportArgs{
	Recipients: pulumi.StringArray{
		pulumi.String("string"),
	},
	Schedule: &enterprise.ReportScheduleArgs{
		Frequency:      pulumi.String("string"),
		CustomInterval: pulumi.String("string"),
		EndTime:        pulumi.String("string"),
		LastDayOfMonth: pulumi.Bool(false),
		StartTime:      pulumi.String("string"),
		Timezone:       pulumi.String("string"),
		WorkdaysOnly:   pulumi.Bool(false),
	},
	Dashboards: enterprise.ReportDashboardArray{
		&enterprise.ReportDashboardArgs{
			Uid: pulumi.String("string"),
			ReportVariables: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			TimeRange: &enterprise.ReportDashboardTimeRangeArgs{
				From: pulumi.String("string"),
				To:   pulumi.String("string"),
			},
		},
	},
	Formats: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncludeDashboardLink: pulumi.Bool(false),
	IncludeTableCsv:      pulumi.Bool(false),
	Layout:               pulumi.String("string"),
	Message:              pulumi.String("string"),
	Name:                 pulumi.String("string"),
	OrgId:                pulumi.String("string"),
	Orientation:          pulumi.String("string"),
	ReplyTo:              pulumi.String("string"),
})

    var reportResource = new Report("reportResource", ReportArgs.builder()
    .recipients("string")
    .schedule(ReportScheduleArgs.builder()
        .frequency("string")
        .customInterval("string")
        .endTime("string")
        .lastDayOfMonth(false)
        .startTime("string")
        .timezone("string")
        .workdaysOnly(false)
        .build())
    .dashboards(ReportDashboardArgs.builder()
        .uid("string")
        .reportVariables(Map.of("string", "string"))
        .timeRange(ReportDashboardTimeRangeArgs.builder()
            .from("string")
            .to("string")
            .build())
        .build())
    .formats("string")
    .includeDashboardLink(false)
    .includeTableCsv(false)
    .layout("string")
    .message("string")
    .name("string")
    .orgId("string")
    .orientation("string")
    .replyTo("string")
    .build());

    report_resource = grafana.enterprise.Report("reportResource",
    recipients=["string"],
    schedule={
        "frequency": "string",
        "custom_interval": "string",
        "end_time": "string",
        "last_day_of_month": False,
        "start_time": "string",
        "timezone": "string",
        "workdays_only": False,
    },
    dashboards=[{
        "uid": "string",
        "report_variables": {
            "string": "string",
        },
        "time_range": {
            "from_": "string",
            "to": "string",
        },
    }],
    formats=["string"],
    include_dashboard_link=False,
    include_table_csv=False,
    layout="string",
    message="string",
    name="string",
    org_id="string",
    orientation="string",
    reply_to="string")

    const reportResource = new grafana.enterprise.Report("reportResource", {
    recipients: ["string"],
    schedule: {
        frequency: "string",
        customInterval: "string",
        endTime: "string",
        lastDayOfMonth: false,
        startTime: "string",
        timezone: "string",
        workdaysOnly: false,
    },
    dashboards: [{
        uid: "string",
        reportVariables: {
            string: "string",
        },
        timeRange: {
            from: "string",
            to: "string",
        },
    }],
    formats: ["string"],
    includeDashboardLink: false,
    includeTableCsv: false,
    layout: "string",
    message: "string",
    name: "string",
    orgId: "string",
    orientation: "string",
    replyTo: "string",
});

    type: grafana:enterprise:Report
properties:
    dashboards:
        - reportVariables:
            string: string
          timeRange:
            from: string
            to: string
          uid: string
    formats:
        - string
    includeDashboardLink: false
    includeTableCsv: false
    layout: string
    message: string
    name: string
    orgId: string
    orientation: string
    recipients:
        - string
    replyTo: string
    schedule:
        customInterval: string
        endTime: string
        frequency: string
        lastDayOfMonth: false
        startTime: string
        timezone: string
        workdaysOnly: false

    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

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

    The Report resource accepts the following input properties:

    Recipients List<string>
    List of recipients of the report.
    Schedule Pulumiverse.Grafana.Enterprise.Inputs.ReportSchedule
    Schedule of the report.
    Dashboards List<Pulumiverse.Grafana.Enterprise.Inputs.ReportDashboard>
    List of dashboards to render into the report
    Formats List<string>
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Orientation string
    Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.
    ReplyTo string
    Reply-to email address of the report.
    Recipients []string
    List of recipients of the report.
    Schedule ReportScheduleArgs
    Schedule of the report.
    Dashboards []ReportDashboardArgs
    List of dashboards to render into the report
    Formats []string
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Orientation string
    Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.
    ReplyTo string
    Reply-to email address of the report.
    recipients List<String>
    List of recipients of the report.
    schedule ReportSchedule
    Schedule of the report.
    dashboards List<ReportDashboard>
    List of dashboards to render into the report
    formats List<String>
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    orientation String
    Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.
    replyTo String
    Reply-to email address of the report.
    recipients string[]
    List of recipients of the report.
    schedule ReportSchedule
    Schedule of the report.
    dashboards ReportDashboard[]
    List of dashboards to render into the report
    formats string[]
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    orientation string
    Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.
    replyTo string
    Reply-to email address of the report.
    recipients Sequence[str]
    List of recipients of the report.
    schedule ReportScheduleArgs
    Schedule of the report.
    dashboards Sequence[ReportDashboardArgs]
    List of dashboards to render into the report
    formats Sequence[str]
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    orientation str
    Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.
    reply_to str
    Reply-to email address of the report.
    recipients List<String>
    List of recipients of the report.
    schedule Property Map
    Schedule of the report.
    dashboards List<Property Map>
    List of dashboards to render into the report
    formats List<String>
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    orientation String
    Orientation of the report. Allowed values: landscape, portrait. Defaults to landscape.
    replyTo String
    Reply-to email address 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,
        dashboards: Optional[Sequence[ReportDashboardArgs]] = None,
        formats: Optional[Sequence[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,
        org_id: Optional[str] = None,
        orientation: Optional[str] = None,
        recipients: Optional[Sequence[str]] = None,
        reply_to: Optional[str] = None,
        schedule: Optional[ReportScheduleArgs] = 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:
    Dashboards List<Pulumiverse.Grafana.Enterprise.Inputs.ReportDashboard>
    List of dashboards to render into the report
    Formats List<string>
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    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 Pulumiverse.Grafana.Enterprise.Inputs.ReportSchedule
    Schedule of the report.
    Dashboards []ReportDashboardArgs
    List of dashboards to render into the report
    Formats []string
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    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.
    dashboards List<ReportDashboard>
    List of dashboards to render into the report
    formats List<String>
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    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 ReportSchedule
    Schedule of the report.
    dashboards ReportDashboard[]
    List of dashboards to render into the report
    formats string[]
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    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 ReportSchedule
    Schedule of the report.
    dashboards Sequence[ReportDashboardArgs]
    List of dashboards to render into the report
    formats Sequence[str]
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    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.
    dashboards List<Property Map>
    List of dashboards to render into the report
    formats List<String>
    Specifies what kind of attachment to generate for the report. Allowed values: pdf, csv, image.
    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.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    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.

    Supporting Types

    ReportDashboard, ReportDashboardArgs

    Uid string
    Dashboard uid.
    ReportVariables Dictionary<string, string>
    Add report variables to the dashboard. Values should be separated by commas.
    TimeRange Pulumiverse.Grafana.Enterprise.Inputs.ReportDashboardTimeRange
    Time range of the report.
    Uid string
    Dashboard uid.
    ReportVariables map[string]string
    Add report variables to the dashboard. Values should be separated by commas.
    TimeRange ReportDashboardTimeRange
    Time range of the report.
    uid String
    Dashboard uid.
    reportVariables Map<String,String>
    Add report variables to the dashboard. Values should be separated by commas.
    timeRange ReportDashboardTimeRange
    Time range of the report.
    uid string
    Dashboard uid.
    reportVariables {[key: string]: string}
    Add report variables to the dashboard. Values should be separated by commas.
    timeRange ReportDashboardTimeRange
    Time range of the report.
    uid str
    Dashboard uid.
    report_variables Mapping[str, str]
    Add report variables to the dashboard. Values should be separated by commas.
    time_range ReportDashboardTimeRange
    Time range of the report.
    uid String
    Dashboard uid.
    reportVariables Map<String>
    Add report variables to the dashboard. Values should be separated by commas.
    timeRange Property Map
    Time range of the report.

    ReportDashboardTimeRange, ReportDashboardTimeRangeArgs

    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.

    ReportSchedule, ReportScheduleArgs

    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    Timezone string
    Set the report time zone. Defaults to GMT.
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    Timezone string
    Set the report time zone. Defaults to GMT.
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    timezone String
    Set the report time zone. Defaults to GMT.
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    timezone string
    Set the report time zone. Defaults to GMT.
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    timezone str
    Set the report time zone. Defaults to GMT.
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    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. Use 2006-01-02T15:04:05 format if you want to set a custom timezone
    timezone String
    Set the report time zone. Defaults to GMT.
    workdaysOnly Boolean
    Whether to send the report only on work days. Defaults to false.

    Import

    $ pulumi import grafana:enterprise/report:Report name "{{ id }}"

    $ pulumi import grafana:enterprise/report:Report name "{{ orgID }}:{{ id }}"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse
    pulumiverse/pulumi-grafana