Docs Packages
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. OrganizationPreference
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse
pulumiverse/pulumi-grafana

grafana.OrganizationPreference

Explore with Pulumi AI

grafana logo
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse
pulumiverse/pulumi-grafana

    Example Usage

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

const test = new grafana.OrganizationPreference("test", {
    theme: "light",
    timezone: "utc",
    weekStart: "sunday",
});

    import pulumi
import pulumiverse_grafana as grafana

test = grafana.OrganizationPreference("test",
    theme="light",
    timezone="utc",
    week_start="sunday")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := grafana.NewOrganizationPreference(ctx, "test", &grafana.OrganizationPreferenceArgs{
			Theme:     pulumi.String("light"),
			Timezone:  pulumi.String("utc"),
			WeekStart: pulumi.String("sunday"),
		})
		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.OrganizationPreference("test", new()
    {
        Theme = "light",
        Timezone = "utc",
        WeekStart = "sunday",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.OrganizationPreference;
import com.pulumi.grafana.OrganizationPreferenceArgs;
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 OrganizationPreference("test", OrganizationPreferenceArgs.builder()        
            .theme("light")
            .timezone("utc")
            .weekStart("sunday")
            .build());

    }
}

    resources:
  test:
    type: grafana:OrganizationPreference
    properties:
      theme: light
      timezone: utc
      weekStart: sunday

    Create OrganizationPreference Resource

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

    Constructor syntax

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

@overload
def OrganizationPreference(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           home_dashboard_id: Optional[int] = None,
                           home_dashboard_uid: Optional[str] = None,
                           org_id: Optional[str] = None,
                           theme: Optional[str] = None,
                           timezone: Optional[str] = None,
                           week_start: Optional[str] = None)
    func NewOrganizationPreference(ctx *Context, name string, args *OrganizationPreferenceArgs, opts ...ResourceOption) (*OrganizationPreference, error)
    public OrganizationPreference(string name, OrganizationPreferenceArgs? args = null, CustomResourceOptions? opts = null)
    public OrganizationPreference(String name, OrganizationPreferenceArgs args)
public OrganizationPreference(String name, OrganizationPreferenceArgs args, CustomResourceOptions options)

    type: grafana:OrganizationPreference
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 OrganizationPreferenceArgs
    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 OrganizationPreferenceArgs
    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 OrganizationPreferenceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationPreferenceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationPreferenceArgs
    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 organizationPreferenceResource = new Grafana.OrganizationPreference("organizationPreferenceResource", new()
{
    HomeDashboardUid = "string",
    OrgId = "string",
    Theme = "string",
    Timezone = "string",
    WeekStart = "string",
});

    example, err := grafana.NewOrganizationPreference(ctx, "organizationPreferenceResource", &grafana.OrganizationPreferenceArgs{
	HomeDashboardUid: pulumi.String("string"),
	OrgId:            pulumi.String("string"),
	Theme:            pulumi.String("string"),
	Timezone:         pulumi.String("string"),
	WeekStart:        pulumi.String("string"),
})

    var organizationPreferenceResource = new OrganizationPreference("organizationPreferenceResource", OrganizationPreferenceArgs.builder()
    .homeDashboardUid("string")
    .orgId("string")
    .theme("string")
    .timezone("string")
    .weekStart("string")
    .build());

    organization_preference_resource = grafana.OrganizationPreference("organizationPreferenceResource",
    home_dashboard_uid="string",
    org_id="string",
    theme="string",
    timezone="string",
    week_start="string")

    const organizationPreferenceResource = new grafana.OrganizationPreference("organizationPreferenceResource", {
    homeDashboardUid: "string",
    orgId: "string",
    theme: "string",
    timezone: "string",
    weekStart: "string",
});

    type: grafana:OrganizationPreference
properties:
    homeDashboardUid: string
    orgId: string
    theme: string
    timezone: string
    weekStart: string

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

    HomeDashboardId int
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    HomeDashboardUid string
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Theme string
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    Timezone string
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    WeekStart string
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.
    HomeDashboardId int
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    HomeDashboardUid string
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Theme string
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    Timezone string
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    WeekStart string
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.
    homeDashboardId Integer
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    homeDashboardUid String
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    theme String
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    timezone String
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    weekStart String
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.
    homeDashboardId number
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    homeDashboardUid string
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    theme string
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    timezone string
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    weekStart string
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.
    home_dashboard_id int
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    home_dashboard_uid str
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    theme str
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    timezone str
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    week_start str
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.
    homeDashboardId Number
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    homeDashboardUid String
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    theme String
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    timezone String
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    weekStart String
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrganizationPreference 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 OrganizationPreference Resource

    Get an existing OrganizationPreference 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?: OrganizationPreferenceState, opts?: CustomResourceOptions): OrganizationPreference
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        home_dashboard_id: Optional[int] = None,
        home_dashboard_uid: Optional[str] = None,
        org_id: Optional[str] = None,
        theme: Optional[str] = None,
        timezone: Optional[str] = None,
        week_start: Optional[str] = None) -> OrganizationPreference
    func GetOrganizationPreference(ctx *Context, name string, id IDInput, state *OrganizationPreferenceState, opts ...ResourceOption) (*OrganizationPreference, error)
    public static OrganizationPreference Get(string name, Input<string> id, OrganizationPreferenceState? state, CustomResourceOptions? opts = null)
    public static OrganizationPreference get(String name, Output<String> id, OrganizationPreferenceState 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:
    HomeDashboardId int
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    HomeDashboardUid string
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Theme string
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    Timezone string
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    WeekStart string
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.
    HomeDashboardId int
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    HomeDashboardUid string
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Theme string
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    Timezone string
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    WeekStart string
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.
    homeDashboardId Integer
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    homeDashboardUid String
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    theme String
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    timezone String
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    weekStart String
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.
    homeDashboardId number
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    homeDashboardUid string
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    theme string
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    timezone string
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    weekStart string
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.
    home_dashboard_id int
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    home_dashboard_uid str
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    theme str
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    timezone str
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    week_start str
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.
    homeDashboardId Number
    The Organization home dashboard ID. Deprecated: Use home_dashboard_uid instead.

    Deprecated: Use home_dashboard_uid instead.

    homeDashboardUid String
    The Organization home dashboard UID. This is only available in Grafana 9.0+.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    theme String
    The Organization theme. Available values are light, dark, system, or an empty string for the default.
    timezone String
    The Organization timezone. Available values are utc, browser, or an empty string for the default.
    weekStart String
    The Organization week start day. Available values are sunday, monday, saturday, or an empty string for the default. Defaults to ``.

    Import

    $ pulumi import grafana:index/organizationPreference:OrganizationPreference name "{{ orgID }}"

    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.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse
    pulumiverse/pulumi-grafana