UNPKG

@lbrlabs/pulumi-grafana

Version:

A Pulumi package for creating and managing grafana.

167 lines (166 loc) 8.46 kB
import * as pulumi from "@pulumi/pulumi"; /** * The provider type for the grafana package. By default, resources use package-wide configuration * settings, however an explicit `Provider` instance may be created and passed during resource * construction to achieve fine-grained programmatic control over provider settings. See the * [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information. */ export declare class Provider extends pulumi.ProviderResource { /** * Returns true if the given object is an instance of Provider. 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 Provider; /** * API token, basic auth in the `username:password` format or `anonymous` (string literal). May alternatively be set via * the `GRAFANA_AUTH` environment variable. */ readonly auth: pulumi.Output<string | undefined>; /** * Certificate CA bundle (file path or literal value) to use to verify the Grafana server's certificate. May alternatively * be set via the `GRAFANA_CA_CERT` environment variable. */ readonly caCert: pulumi.Output<string | undefined>; /** * Access Policy Token (or API key) for Grafana Cloud. May alternatively be set via the `GRAFANA_CLOUD_API_KEY` environment * variable. */ readonly cloudApiKey: pulumi.Output<string | undefined>; /** * Grafana Cloud's API URL. May alternatively be set via the `GRAFANA_CLOUD_API_URL` environment variable. */ readonly cloudApiUrl: pulumi.Output<string | undefined>; /** * A Grafana OnCall access token. May alternatively be set via the `GRAFANA_ONCALL_ACCESS_TOKEN` environment variable. */ readonly oncallAccessToken: pulumi.Output<string | undefined>; /** * An Grafana OnCall backend address. May alternatively be set via the `GRAFANA_ONCALL_URL` environment variable. */ readonly oncallUrl: pulumi.Output<string | undefined>; /** * A Synthetic Monitoring access token. May alternatively be set via the `GRAFANA_SM_ACCESS_TOKEN` environment variable. */ readonly smAccessToken: pulumi.Output<string | undefined>; /** * Synthetic monitoring backend address. May alternatively be set via the `GRAFANA_SM_URL` environment variable. The * correct value for each service region is cited in the [Synthetic Monitoring * documentation](https://grafana.com/docs/grafana-cloud/monitor-public-endpoints/private-probes/#probe-api-server-url). * Note the `sm_url` value is optional, but it must correspond with the value specified as the `region_slug` in the * `grafana_cloud_stack` resource. Also note that when a Terraform configuration contains multiple provider instances * managing SM resources associated with the same Grafana stack, specifying an explicit `sm_url` set to the same value for * each provider ensures all providers interact with the same SM API. */ readonly smUrl: pulumi.Output<string | undefined>; /** * Client TLS certificate (file path or literal value) to use to authenticate to the Grafana server. May alternatively be * set via the `GRAFANA_TLS_CERT` environment variable. */ readonly tlsCert: pulumi.Output<string | undefined>; /** * Client TLS key (file path or literal value) to use to authenticate to the Grafana server. May alternatively be set via * the `GRAFANA_TLS_KEY` environment variable. */ readonly tlsKey: pulumi.Output<string | undefined>; /** * The root URL of a Grafana server. May alternatively be set via the `GRAFANA_URL` environment variable. */ readonly url: pulumi.Output<string | undefined>; /** * Create a Provider 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?: ProviderArgs, opts?: pulumi.ResourceOptions); } /** * The set of arguments for constructing a Provider resource. */ export interface ProviderArgs { /** * API token, basic auth in the `username:password` format or `anonymous` (string literal). May alternatively be set via * the `GRAFANA_AUTH` environment variable. */ auth?: pulumi.Input<string>; /** * Certificate CA bundle (file path or literal value) to use to verify the Grafana server's certificate. May alternatively * be set via the `GRAFANA_CA_CERT` environment variable. */ caCert?: pulumi.Input<string>; /** * Access Policy Token (or API key) for Grafana Cloud. May alternatively be set via the `GRAFANA_CLOUD_API_KEY` environment * variable. */ cloudApiKey?: pulumi.Input<string>; /** * Grafana Cloud's API URL. May alternatively be set via the `GRAFANA_CLOUD_API_URL` environment variable. */ cloudApiUrl?: pulumi.Input<string>; /** * Skip TLS certificate verification. May alternatively be set via the `GRAFANA_INSECURE_SKIP_VERIFY` environment variable. */ insecureSkipVerify?: pulumi.Input<boolean>; /** * A Grafana OnCall access token. May alternatively be set via the `GRAFANA_ONCALL_ACCESS_TOKEN` environment variable. */ oncallAccessToken?: pulumi.Input<string>; /** * An Grafana OnCall backend address. May alternatively be set via the `GRAFANA_ONCALL_URL` environment variable. */ oncallUrl?: pulumi.Input<string>; /** * Deprecated: Use the `org_id` attributes on resources instead. * * @deprecated Use the `org_id` attributes on resources instead. */ orgId?: pulumi.Input<number>; /** * The amount of retries to use for Grafana API and Grafana Cloud API calls. May alternatively be set via the * `GRAFANA_RETRIES` environment variable. */ retries?: pulumi.Input<number>; /** * The status codes to retry on for Grafana API and Grafana Cloud API calls. Use `x` as a digit wildcard. Defaults to 429 * and 5xx. May alternatively be set via the `GRAFANA_RETRY_STATUS_CODES` environment variable. */ retryStatusCodes?: pulumi.Input<pulumi.Input<string>[]>; /** * The amount of time in seconds to wait between retries for Grafana API and Grafana Cloud API calls. May alternatively be * set via the `GRAFANA_RETRY_WAIT` environment variable. */ retryWait?: pulumi.Input<number>; /** * A Synthetic Monitoring access token. May alternatively be set via the `GRAFANA_SM_ACCESS_TOKEN` environment variable. */ smAccessToken?: pulumi.Input<string>; /** * Synthetic monitoring backend address. May alternatively be set via the `GRAFANA_SM_URL` environment variable. The * correct value for each service region is cited in the [Synthetic Monitoring * documentation](https://grafana.com/docs/grafana-cloud/monitor-public-endpoints/private-probes/#probe-api-server-url). * Note the `sm_url` value is optional, but it must correspond with the value specified as the `region_slug` in the * `grafana_cloud_stack` resource. Also note that when a Terraform configuration contains multiple provider instances * managing SM resources associated with the same Grafana stack, specifying an explicit `sm_url` set to the same value for * each provider ensures all providers interact with the same SM API. */ smUrl?: pulumi.Input<string>; /** * Set to true if you want to save only the sha256sum instead of complete dashboard model JSON in the tfstate. */ storeDashboardSha256?: pulumi.Input<boolean>; /** * Client TLS certificate (file path or literal value) to use to authenticate to the Grafana server. May alternatively be * set via the `GRAFANA_TLS_CERT` environment variable. */ tlsCert?: pulumi.Input<string>; /** * Client TLS key (file path or literal value) to use to authenticate to the Grafana server. May alternatively be set via * the `GRAFANA_TLS_KEY` environment variable. */ tlsKey?: pulumi.Input<string>; /** * The root URL of a Grafana server. May alternatively be set via the `GRAFANA_URL` environment variable. */ url?: pulumi.Input<string>; }