@pulumiverse/grafana

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 for Grafana Cloud. May alternatively be set via the `GRAFANA_CLOUD_ACCESS_POLICY_TOKEN` environment variable. */ readonly cloudAccessPolicyToken: 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 Cloud Provider access token. May alternatively be set via the `GRAFANA_CLOUD_PROVIDER_ACCESS_TOKEN` environment variable. */ readonly cloudProviderAccessToken: pulumi.Output<string | undefined>; /** * A Grafana Cloud Provider backend address. May alternatively be set via the `GRAFANA_CLOUD_PROVIDER_URL` environment variable. */ readonly cloudProviderUrl: pulumi.Output<string | undefined>; /** * A Grafana Connections API access token. May alternatively be set via the `GRAFANA_CONNECTIONS_API_ACCESS_TOKEN` environment variable. */ readonly connectionsApiAccessToken: pulumi.Output<string | undefined>; /** * A Grafana Connections API address. May alternatively be set via the `GRAFANA_CONNECTIONS_API_URL` environment variable. */ readonly connectionsApiUrl: pulumi.Output<string | undefined>; /** * A Grafana Fleet Management basic auth in the `username:password` format. May alternatively be set via the `GRAFANA_FLEET_MANAGEMENT_AUTH` environment variable. */ readonly fleetManagementAuth: pulumi.Output<string | undefined>; /** * A Grafana Fleet Management API address. May alternatively be set via the `GRAFANA_FLEET_MANAGEMENT_URL` environment variable. */ readonly fleetManagementUrl: pulumi.Output<string | undefined>; /** * A Grafana Frontend Observability API access token. May alternatively be set via the `GRAFANA_FRONTEND_O11Y_API_ACCESS_TOKEN` environment variable. */ readonly frontendO11yApiAccessToken: pulumi.Output<string | undefined>; /** * The Grafana Frontend Observability API URL. This is optional, and should only be set to override the default API. May alternatively be set via the `GRAFANA_FRONTEND_O11Y_API_URL` environment variable. */ readonly frontendO11yApiUrl: pulumi.Output<string | undefined>; /** * The k6 Cloud API token. May alternatively be set via the `GRAFANA_K6_ACCESS_TOKEN` environment variable. */ readonly k6AccessToken: pulumi.Output<string | undefined>; /** * The k6 Cloud API url. May alternatively be set via the `GRAFANA_K6_URL` environment variable. */ readonly k6Url: pulumi.Output<string | undefined>; /** * A Grafana OnCall access token. May alternatively be set via the `GRAFANA_ONCALL_ACCESS_TOKEN` environment variable. This is only required when using a dedicated OnCall API token. When using Grafana Cloud, OnCall can be accessed through the `auth` and `url` provider attributes instead. */ readonly oncallAccessToken: pulumi.Output<string | undefined>; /** * A Grafana OnCall backend address. May alternatively be set via the `GRAFANA_ONCALL_URL` environment variable. This is only required when using Grafana OnCall OSS. In Grafana Cloud, the OnCall URL is automatically inferred from the Grafana instance URL. */ 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/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url). Note the `smUrl` value is optional, but it must correspond with the value specified as the `regionSlug` 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 `smUrl` 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); /** * This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider. */ terraformConfig(): pulumi.Output<Provider.TerraformConfigResult>; } /** * 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 for Grafana Cloud. May alternatively be set via the `GRAFANA_CLOUD_ACCESS_POLICY_TOKEN` environment variable. */ cloudAccessPolicyToken?: pulumi.Input<string>; /** * Grafana Cloud's API URL. May alternatively be set via the `GRAFANA_CLOUD_API_URL` environment variable. */ cloudApiUrl?: pulumi.Input<string>; /** * A Grafana Cloud Provider access token. May alternatively be set via the `GRAFANA_CLOUD_PROVIDER_ACCESS_TOKEN` environment variable. */ cloudProviderAccessToken?: pulumi.Input<string>; /** * A Grafana Cloud Provider backend address. May alternatively be set via the `GRAFANA_CLOUD_PROVIDER_URL` environment variable. */ cloudProviderUrl?: pulumi.Input<string>; /** * A Grafana Connections API access token. May alternatively be set via the `GRAFANA_CONNECTIONS_API_ACCESS_TOKEN` environment variable. */ connectionsApiAccessToken?: pulumi.Input<string>; /** * A Grafana Connections API address. May alternatively be set via the `GRAFANA_CONNECTIONS_API_URL` environment variable. */ connectionsApiUrl?: pulumi.Input<string>; /** * A Grafana Fleet Management basic auth in the `username:password` format. May alternatively be set via the `GRAFANA_FLEET_MANAGEMENT_AUTH` environment variable. */ fleetManagementAuth?: pulumi.Input<string>; /** * A Grafana Fleet Management API address. May alternatively be set via the `GRAFANA_FLEET_MANAGEMENT_URL` environment variable. */ fleetManagementUrl?: pulumi.Input<string>; /** * A Grafana Frontend Observability API access token. May alternatively be set via the `GRAFANA_FRONTEND_O11Y_API_ACCESS_TOKEN` environment variable. */ frontendO11yApiAccessToken?: pulumi.Input<string>; /** * The Grafana Frontend Observability API URL. This is optional, and should only be set to override the default API. May alternatively be set via the `GRAFANA_FRONTEND_O11Y_API_URL` environment variable. */ frontendO11yApiUrl?: pulumi.Input<string>; /** * Optional. HTTP headers mapping keys to values used for accessing the Grafana and Grafana Cloud APIs. May alternatively be set via the `GRAFANA_HTTP_HEADERS` environment variable in JSON format. */ httpHeaders?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * Skip TLS certificate verification. May alternatively be set via the `GRAFANA_INSECURE_SKIP_VERIFY` environment variable. */ insecureSkipVerify?: pulumi.Input<boolean>; /** * The k6 Cloud API token. May alternatively be set via the `GRAFANA_K6_ACCESS_TOKEN` environment variable. */ k6AccessToken?: pulumi.Input<string>; /** * The k6 Cloud API url. May alternatively be set via the `GRAFANA_K6_URL` environment variable. */ k6Url?: pulumi.Input<string>; /** * A Grafana OnCall access token. May alternatively be set via the `GRAFANA_ONCALL_ACCESS_TOKEN` environment variable. This is only required when using a dedicated OnCall API token. When using Grafana Cloud, OnCall can be accessed through the `auth` and `url` provider attributes instead. */ oncallAccessToken?: pulumi.Input<string>; /** * A Grafana OnCall backend address. May alternatively be set via the `GRAFANA_ONCALL_URL` environment variable. This is only required when using Grafana OnCall OSS. In Grafana Cloud, the OnCall URL is automatically inferred from the Grafana instance URL. */ oncallUrl?: pulumi.Input<string>; /** * The Grafana org ID, if you are using a self-hosted OSS or enterprise Grafana instance. May alternatively be set via the `GRAFANA_ORG_ID` environment variable. */ 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/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url). Note the `smUrl` value is optional, but it must correspond with the value specified as the `regionSlug` 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 `smUrl` set to the same value for each provider ensures all providers interact with the same SM API. */ smUrl?: pulumi.Input<string>; /** * The Grafana stack ID, if you are using a Grafana Cloud stack. May alternatively be set via the `GRAFANA_STACK_ID` environment variable. */ stackId?: pulumi.Input<number>; /** * 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>; } export declare namespace Provider { /** * The results of the Provider.terraformConfig method. */ interface TerraformConfigResult { readonly result: { [key: string]: any; }; } }