@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
202 lines (201 loc) • 8.98 kB
TypeScript
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/org/)
*
* This resource represents an instance-scoped resource and uses Grafana's admin APIs.
* It does not work with API tokens or service accounts which are org-scoped.
* You must use basic auth.
* This resource is also not compatible with Grafana Cloud, as it does not allow basic auth.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const test = new grafana.oss.Organization("test", {
* name: "Test Organization",
* adminUser: "admin",
* createUsers: true,
* admins: ["admin@example.com"],
* editors: [
* "editor-01@example.com",
* "editor-02@example.com",
* ],
* viewers: [
* "viewer-01@example.com",
* "viewer-02@example.com",
* ],
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import grafana:index/organization:Organization name "{{ id }}"
* ```
*
* @deprecated grafana.index/organization.Organization has been deprecated in favor of grafana.oss/organization.Organization
*/
export declare class Organization extends pulumi.CustomResource {
/**
* Get an existing Organization 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?: OrganizationState, opts?: pulumi.CustomResourceOptions): Organization;
/**
* Returns true if the given object is an instance of Organization. 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 Organization;
readonly adminUser: pulumi.Output<string | undefined>;
/**
* A list of email addresses corresponding to users who should be given admin
* access to the organization. Note: users specified here must already exist in
* Grafana unless 'create_users' is set to true.
*/
readonly admins: pulumi.Output<string[] | undefined>;
/**
* Whether or not to create Grafana users specified in the organization's
* membership if they don't already exist in Grafana. If unspecified, this
* parameter defaults to true, creating placeholder users with the name, login,
* and email set to the email of the user, and a random password. Setting this
* option to false will cause an error to be thrown for any users that do not
* already exist in Grafana.
* Defaults to `true`.
*/
readonly createUsers: pulumi.Output<boolean | undefined>;
/**
* A list of email addresses corresponding to users who should be given editor
* access to the organization. Note: users specified here must already exist in
* Grafana unless 'create_users' is set to true.
*/
readonly editors: pulumi.Output<string[] | undefined>;
/**
* The display name for the Grafana organization created.
*/
readonly name: pulumi.Output<string>;
/**
* The organization id assigned to this organization by Grafana.
*/
readonly orgId: pulumi.Output<number>;
/**
* A list of email addresses corresponding to users who should be given none access to the organization.
* Note: users specified here must already exist in Grafana, unless 'create_users' is
* set to true. This feature is only available in Grafana 10.2+.
*/
readonly usersWithoutAccesses: pulumi.Output<string[] | undefined>;
/**
* A list of email addresses corresponding to users who should be given viewer
* access to the organization. Note: users specified here must already exist in
* Grafana unless 'create_users' is set to true.
*/
readonly viewers: pulumi.Output<string[] | undefined>;
/**
* Create a Organization 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.
*/
/** @deprecated grafana.index/organization.Organization has been deprecated in favor of grafana.oss/organization.Organization */
constructor(name: string, args?: OrganizationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Organization resources.
*/
export interface OrganizationState {
adminUser?: pulumi.Input<string>;
/**
* A list of email addresses corresponding to users who should be given admin
* access to the organization. Note: users specified here must already exist in
* Grafana unless 'create_users' is set to true.
*/
admins?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Whether or not to create Grafana users specified in the organization's
* membership if they don't already exist in Grafana. If unspecified, this
* parameter defaults to true, creating placeholder users with the name, login,
* and email set to the email of the user, and a random password. Setting this
* option to false will cause an error to be thrown for any users that do not
* already exist in Grafana.
* Defaults to `true`.
*/
createUsers?: pulumi.Input<boolean>;
/**
* A list of email addresses corresponding to users who should be given editor
* access to the organization. Note: users specified here must already exist in
* Grafana unless 'create_users' is set to true.
*/
editors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The display name for the Grafana organization created.
*/
name?: pulumi.Input<string>;
/**
* The organization id assigned to this organization by Grafana.
*/
orgId?: pulumi.Input<number>;
/**
* A list of email addresses corresponding to users who should be given none access to the organization.
* Note: users specified here must already exist in Grafana, unless 'create_users' is
* set to true. This feature is only available in Grafana 10.2+.
*/
usersWithoutAccesses?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A list of email addresses corresponding to users who should be given viewer
* access to the organization. Note: users specified here must already exist in
* Grafana unless 'create_users' is set to true.
*/
viewers?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a Organization resource.
*/
export interface OrganizationArgs {
adminUser?: pulumi.Input<string>;
/**
* A list of email addresses corresponding to users who should be given admin
* access to the organization. Note: users specified here must already exist in
* Grafana unless 'create_users' is set to true.
*/
admins?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Whether or not to create Grafana users specified in the organization's
* membership if they don't already exist in Grafana. If unspecified, this
* parameter defaults to true, creating placeholder users with the name, login,
* and email set to the email of the user, and a random password. Setting this
* option to false will cause an error to be thrown for any users that do not
* already exist in Grafana.
* Defaults to `true`.
*/
createUsers?: pulumi.Input<boolean>;
/**
* A list of email addresses corresponding to users who should be given editor
* access to the organization. Note: users specified here must already exist in
* Grafana unless 'create_users' is set to true.
*/
editors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The display name for the Grafana organization created.
*/
name?: pulumi.Input<string>;
/**
* A list of email addresses corresponding to users who should be given none access to the organization.
* Note: users specified here must already exist in Grafana, unless 'create_users' is
* set to true. This feature is only available in Grafana 10.2+.
*/
usersWithoutAccesses?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A list of email addresses corresponding to users who should be given viewer
* access to the organization. Note: users specified here must already exist in
* Grafana unless 'create_users' is set to true.
*/
viewers?: pulumi.Input<pulumi.Input<string>[]>;
}