@pulumiverse/grafana/oss/organizationPreferences.d.ts

A Pulumi package for creating and managing grafana.

import * as pulumi from "@pulumi/pulumi";
/**
 * * [Official documentation](https://grafana.com/docs/grafana/latest/administration/organization-management/)
 * * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/preferences/#get-current-org-prefs)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as grafana from "@pulumiverse/grafana";
 *
 * const test = new grafana.oss.OrganizationPreferences("test", {
 *     theme: "light",
 *     timezone: "utc",
 *     weekStart: "sunday",
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import grafana:oss/organizationPreferences:OrganizationPreferences name "{{ orgID }}"
 * ```
 */
export declare class OrganizationPreferences extends pulumi.CustomResource {
    /**
     * Get an existing OrganizationPreferences resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OrganizationPreferencesState, opts?: pulumi.CustomResourceOptions): OrganizationPreferences;
    /**
     * Returns true if the given object is an instance of OrganizationPreferences.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is OrganizationPreferences;
    /**
     * The Organization home dashboard UID. This is only available in Grafana 9.0+.
     */
    readonly homeDashboardUid: pulumi.Output<string | undefined>;
    /**
     * The Organization ID. If not set, the Org ID defined in the provider block will be used.
     */
    readonly orgId: pulumi.Output<string | undefined>;
    /**
     * The Organization theme. Available values are `light`, `dark`, `system`, or an empty string for the default.
     */
    readonly theme: pulumi.Output<string | undefined>;
    /**
     * The Organization timezone. Available values are `utc`, `browser`, or an empty string for the default.
     */
    readonly timezone: pulumi.Output<string | undefined>;
    /**
     * The Organization week start day. Available values are `sunday`, `monday`, `saturday`, or an empty string for the default. Defaults to ``.
     */
    readonly weekStart: pulumi.Output<string | undefined>;
    /**
     * Create a OrganizationPreferences resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args?: OrganizationPreferencesArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering OrganizationPreferences resources.
 */
export interface OrganizationPreferencesState {
    /**
     * The Organization home dashboard UID. This is only available in Grafana 9.0+.
     */
    homeDashboardUid?: pulumi.Input<string>;
    /**
     * The Organization ID. If not set, the Org ID defined in the provider block will be used.
     */
    orgId?: pulumi.Input<string>;
    /**
     * The Organization theme. Available values are `light`, `dark`, `system`, or an empty string for the default.
     */
    theme?: pulumi.Input<string>;
    /**
     * The Organization timezone. Available values are `utc`, `browser`, or an empty string for the default.
     */
    timezone?: pulumi.Input<string>;
    /**
     * The Organization week start day. Available values are `sunday`, `monday`, `saturday`, or an empty string for the default. Defaults to ``.
     */
    weekStart?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a OrganizationPreferences resource.
 */
export interface OrganizationPreferencesArgs {
    /**
     * The Organization home dashboard UID. This is only available in Grafana 9.0+.
     */
    homeDashboardUid?: pulumi.Input<string>;
    /**
     * The Organization ID. If not set, the Org ID defined in the provider block will be used.
     */
    orgId?: pulumi.Input<string>;
    /**
     * The Organization theme. Available values are `light`, `dark`, `system`, or an empty string for the default.
     */
    theme?: pulumi.Input<string>;
    /**
     * The Organization timezone. Available values are `utc`, `browser`, or an empty string for the default.
     */
    timezone?: pulumi.Input<string>;
    /**
     * The Organization week start day. Available values are `sunday`, `monday`, `saturday`, or an empty string for the default. Defaults to ``.
     */
    weekStart?: pulumi.Input<string>;
}