@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
99 lines (98 loc) • 2.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* * [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/manage-dashboards/)
* * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/folder/)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumi/grafana";
* import * as grafana from "@pulumiverse/grafana";
*
* const test = new grafana.oss.Folder("test", {
* title: "test-folder",
* uid: "test-ds-folder-uid",
* });
* const fromTitle = grafana.oss.getFolderOutput({
* title: test.title,
* });
* ```
*/
export declare function getFolder(args: GetFolderArgs, opts?: pulumi.InvokeOptions): Promise<GetFolderResult>;
/**
* A collection of arguments for invoking getFolder.
*/
export interface GetFolderArgs {
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
orgId?: string;
/**
* The title of the folder.
*/
title: string;
}
/**
* A collection of values returned by getFolder.
*/
export interface GetFolderResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
readonly orgId?: string;
/**
* The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
*/
readonly parentFolderUid: string;
/**
* The title of the folder.
*/
readonly title: string;
/**
* Unique identifier.
*/
readonly uid: string;
/**
* The full URL of the folder.
*/
readonly url: string;
}
/**
* * [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/manage-dashboards/)
* * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/folder/)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumi/grafana";
* import * as grafana from "@pulumiverse/grafana";
*
* const test = new grafana.oss.Folder("test", {
* title: "test-folder",
* uid: "test-ds-folder-uid",
* });
* const fromTitle = grafana.oss.getFolderOutput({
* title: test.title,
* });
* ```
*/
export declare function getFolderOutput(args: GetFolderOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetFolderResult>;
/**
* A collection of arguments for invoking getFolder.
*/
export interface GetFolderOutputArgs {
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
orgId?: pulumi.Input<string>;
/**
* The title of the folder.
*/
title: pulumi.Input<string>;
}