Docs Packages
  1. Pulumi Registry
  2. Grafana Cloud
  3. API Docs
  4. Provider
grafana logo
Grafana v0.0.10, May 21 23

grafana.Provider

Explore with Pulumi AI

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 for more information.

Create Provider Resource

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             auth: Optional[str] = None,
             ca_cert: Optional[str] = None,
             cloud_api_key: Optional[str] = None,
             cloud_api_url: Optional[str] = None,
             insecure_skip_verify: Optional[bool] = None,
             oncall_access_token: Optional[str] = None,
             oncall_url: Optional[str] = None,
             org_id: Optional[int] = None,
             retries: Optional[int] = None,
             sm_access_token: Optional[str] = None,
             sm_url: Optional[str] = None,
             store_dashboard_sha256: Optional[bool] = None,
             tls_cert: Optional[str] = None,
             tls_key: Optional[str] = None,
             url: Optional[str] = None)
@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:grafana
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Provider resource accepts the following input properties:

Auth string

API token, basic auth in the username:password format or anonymous (string literal). May alternatively be set via the GRAFANA_AUTH environment variable. It can also be sourced from the following environment variable: GRAFANA_AUTH

CaCert string

Certificate CA bundle to use to verify the Grafana server's certificate. May alternatively be set via the GRAFANA_CA_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_CA_CERT

CloudApiKey string

API key for Grafana Cloud. May alternatively be set via the GRAFANA_CLOUD_API_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_KEY

CloudApiUrl string

Grafana Cloud's API URL. May alternatively be set via the GRAFANA_CLOUD_API_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_URL

InsecureSkipVerify bool

Skip TLS certificate verification. May alternatively be set via the GRAFANA_INSECURE_SKIP_VERIFY environment variable. It can also be sourced from the following environment variable: GRAFANA_INSECURE_SKIP_VERIFY

OncallAccessToken string

A Grafana OnCall access token. May alternatively be set via the GRAFANA_ONCALL_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_ACCESS_TOKEN

OncallUrl string

An Grafana OnCall backend address. May alternatively be set via the GRAFANA_ONCALL_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_URL

OrgId int

The default organization id to operate on within grafana. For resources that have an org_id attribute, the resource-level attribute has priority. May alternatively be set via the GRAFANA_ORG_ID environment variable. It can also be sourced from the following environment variable: GRAFANA_ORG_ID

Retries int

The amount of retries to use for Grafana API and Grafana Cloud API calls. May alternatively be set via the GRAFANA_RETRIES environment variable. It can also be sourced from the following environment variable: GRAFANA_RETRIES

SmAccessToken string

A Synthetic Monitoring access token. May alternatively be set via the GRAFANA_SM_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_SM_ACCESS_TOKEN

SmUrl 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. 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. It can also be sourced from the following environment variable: GRAFANA_SM_URL

StoreDashboardSha256 bool

Set to true if you want to save only the sha256sum instead of complete dashboard model JSON in the tfstate. It can also be sourced from the following environment variable: GRAFANA_STORE_DASHBOARD_SHA256

TlsCert string

Client TLS certificate file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_CERT

TlsKey string

Client TLS key file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_KEY

Url string

The root URL of a Grafana server. May alternatively be set via the GRAFANA_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_URL

Auth string

API token, basic auth in the username:password format or anonymous (string literal). May alternatively be set via the GRAFANA_AUTH environment variable. It can also be sourced from the following environment variable: GRAFANA_AUTH

CaCert string

Certificate CA bundle to use to verify the Grafana server's certificate. May alternatively be set via the GRAFANA_CA_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_CA_CERT

CloudApiKey string

API key for Grafana Cloud. May alternatively be set via the GRAFANA_CLOUD_API_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_KEY

CloudApiUrl string

Grafana Cloud's API URL. May alternatively be set via the GRAFANA_CLOUD_API_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_URL

InsecureSkipVerify bool

Skip TLS certificate verification. May alternatively be set via the GRAFANA_INSECURE_SKIP_VERIFY environment variable. It can also be sourced from the following environment variable: GRAFANA_INSECURE_SKIP_VERIFY

OncallAccessToken string

A Grafana OnCall access token. May alternatively be set via the GRAFANA_ONCALL_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_ACCESS_TOKEN

OncallUrl string

An Grafana OnCall backend address. May alternatively be set via the GRAFANA_ONCALL_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_URL

OrgId int

The default organization id to operate on within grafana. For resources that have an org_id attribute, the resource-level attribute has priority. May alternatively be set via the GRAFANA_ORG_ID environment variable. It can also be sourced from the following environment variable: GRAFANA_ORG_ID

Retries int

The amount of retries to use for Grafana API and Grafana Cloud API calls. May alternatively be set via the GRAFANA_RETRIES environment variable. It can also be sourced from the following environment variable: GRAFANA_RETRIES

SmAccessToken string

A Synthetic Monitoring access token. May alternatively be set via the GRAFANA_SM_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_SM_ACCESS_TOKEN

SmUrl 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. 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. It can also be sourced from the following environment variable: GRAFANA_SM_URL

StoreDashboardSha256 bool

Set to true if you want to save only the sha256sum instead of complete dashboard model JSON in the tfstate. It can also be sourced from the following environment variable: GRAFANA_STORE_DASHBOARD_SHA256

TlsCert string

Client TLS certificate file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_CERT

TlsKey string

Client TLS key file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_KEY

Url string

The root URL of a Grafana server. May alternatively be set via the GRAFANA_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_URL

auth String

API token, basic auth in the username:password format or anonymous (string literal). May alternatively be set via the GRAFANA_AUTH environment variable. It can also be sourced from the following environment variable: GRAFANA_AUTH

caCert String

Certificate CA bundle to use to verify the Grafana server's certificate. May alternatively be set via the GRAFANA_CA_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_CA_CERT

cloudApiKey String

API key for Grafana Cloud. May alternatively be set via the GRAFANA_CLOUD_API_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_KEY

cloudApiUrl String

Grafana Cloud's API URL. May alternatively be set via the GRAFANA_CLOUD_API_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_URL

insecureSkipVerify Boolean

Skip TLS certificate verification. May alternatively be set via the GRAFANA_INSECURE_SKIP_VERIFY environment variable. It can also be sourced from the following environment variable: GRAFANA_INSECURE_SKIP_VERIFY

oncallAccessToken String

A Grafana OnCall access token. May alternatively be set via the GRAFANA_ONCALL_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_ACCESS_TOKEN

oncallUrl String

An Grafana OnCall backend address. May alternatively be set via the GRAFANA_ONCALL_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_URL

orgId Integer

The default organization id to operate on within grafana. For resources that have an org_id attribute, the resource-level attribute has priority. May alternatively be set via the GRAFANA_ORG_ID environment variable. It can also be sourced from the following environment variable: GRAFANA_ORG_ID

retries Integer

The amount of retries to use for Grafana API and Grafana Cloud API calls. May alternatively be set via the GRAFANA_RETRIES environment variable. It can also be sourced from the following environment variable: GRAFANA_RETRIES

smAccessToken String

A Synthetic Monitoring access token. May alternatively be set via the GRAFANA_SM_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_SM_ACCESS_TOKEN

smUrl 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. 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. It can also be sourced from the following environment variable: GRAFANA_SM_URL

storeDashboardSha256 Boolean

Set to true if you want to save only the sha256sum instead of complete dashboard model JSON in the tfstate. It can also be sourced from the following environment variable: GRAFANA_STORE_DASHBOARD_SHA256

tlsCert String

Client TLS certificate file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_CERT

tlsKey String

Client TLS key file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_KEY

url String

The root URL of a Grafana server. May alternatively be set via the GRAFANA_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_URL

auth string

API token, basic auth in the username:password format or anonymous (string literal). May alternatively be set via the GRAFANA_AUTH environment variable. It can also be sourced from the following environment variable: GRAFANA_AUTH

caCert string

Certificate CA bundle to use to verify the Grafana server's certificate. May alternatively be set via the GRAFANA_CA_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_CA_CERT

cloudApiKey string

API key for Grafana Cloud. May alternatively be set via the GRAFANA_CLOUD_API_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_KEY

cloudApiUrl string

Grafana Cloud's API URL. May alternatively be set via the GRAFANA_CLOUD_API_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_URL

insecureSkipVerify boolean

Skip TLS certificate verification. May alternatively be set via the GRAFANA_INSECURE_SKIP_VERIFY environment variable. It can also be sourced from the following environment variable: GRAFANA_INSECURE_SKIP_VERIFY

oncallAccessToken string

A Grafana OnCall access token. May alternatively be set via the GRAFANA_ONCALL_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_ACCESS_TOKEN

oncallUrl string

An Grafana OnCall backend address. May alternatively be set via the GRAFANA_ONCALL_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_URL

orgId number

The default organization id to operate on within grafana. For resources that have an org_id attribute, the resource-level attribute has priority. May alternatively be set via the GRAFANA_ORG_ID environment variable. It can also be sourced from the following environment variable: GRAFANA_ORG_ID

retries 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. It can also be sourced from the following environment variable: GRAFANA_RETRIES

smAccessToken string

A Synthetic Monitoring access token. May alternatively be set via the GRAFANA_SM_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_SM_ACCESS_TOKEN

smUrl 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. 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. It can also be sourced from the following environment variable: GRAFANA_SM_URL

storeDashboardSha256 boolean

Set to true if you want to save only the sha256sum instead of complete dashboard model JSON in the tfstate. It can also be sourced from the following environment variable: GRAFANA_STORE_DASHBOARD_SHA256

tlsCert string

Client TLS certificate file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_CERT

tlsKey string

Client TLS key file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_KEY

url string

The root URL of a Grafana server. May alternatively be set via the GRAFANA_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_URL

auth str

API token, basic auth in the username:password format or anonymous (string literal). May alternatively be set via the GRAFANA_AUTH environment variable. It can also be sourced from the following environment variable: GRAFANA_AUTH

ca_cert str

Certificate CA bundle to use to verify the Grafana server's certificate. May alternatively be set via the GRAFANA_CA_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_CA_CERT

cloud_api_key str

API key for Grafana Cloud. May alternatively be set via the GRAFANA_CLOUD_API_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_KEY

cloud_api_url str

Grafana Cloud's API URL. May alternatively be set via the GRAFANA_CLOUD_API_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_URL

insecure_skip_verify bool

Skip TLS certificate verification. May alternatively be set via the GRAFANA_INSECURE_SKIP_VERIFY environment variable. It can also be sourced from the following environment variable: GRAFANA_INSECURE_SKIP_VERIFY

oncall_access_token str

A Grafana OnCall access token. May alternatively be set via the GRAFANA_ONCALL_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_ACCESS_TOKEN

oncall_url str

An Grafana OnCall backend address. May alternatively be set via the GRAFANA_ONCALL_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_URL

org_id int

The default organization id to operate on within grafana. For resources that have an org_id attribute, the resource-level attribute has priority. May alternatively be set via the GRAFANA_ORG_ID environment variable. It can also be sourced from the following environment variable: GRAFANA_ORG_ID

retries int

The amount of retries to use for Grafana API and Grafana Cloud API calls. May alternatively be set via the GRAFANA_RETRIES environment variable. It can also be sourced from the following environment variable: GRAFANA_RETRIES

sm_access_token str

A Synthetic Monitoring access token. May alternatively be set via the GRAFANA_SM_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_SM_ACCESS_TOKEN

sm_url str

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. 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. It can also be sourced from the following environment variable: GRAFANA_SM_URL

store_dashboard_sha256 bool

Set to true if you want to save only the sha256sum instead of complete dashboard model JSON in the tfstate. It can also be sourced from the following environment variable: GRAFANA_STORE_DASHBOARD_SHA256

tls_cert str

Client TLS certificate file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_CERT

tls_key str

Client TLS key file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_KEY

url str

The root URL of a Grafana server. May alternatively be set via the GRAFANA_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_URL

auth String

API token, basic auth in the username:password format or anonymous (string literal). May alternatively be set via the GRAFANA_AUTH environment variable. It can also be sourced from the following environment variable: GRAFANA_AUTH

caCert String

Certificate CA bundle to use to verify the Grafana server's certificate. May alternatively be set via the GRAFANA_CA_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_CA_CERT

cloudApiKey String

API key for Grafana Cloud. May alternatively be set via the GRAFANA_CLOUD_API_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_KEY

cloudApiUrl String

Grafana Cloud's API URL. May alternatively be set via the GRAFANA_CLOUD_API_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_CLOUD_API_URL

insecureSkipVerify Boolean

Skip TLS certificate verification. May alternatively be set via the GRAFANA_INSECURE_SKIP_VERIFY environment variable. It can also be sourced from the following environment variable: GRAFANA_INSECURE_SKIP_VERIFY

oncallAccessToken String

A Grafana OnCall access token. May alternatively be set via the GRAFANA_ONCALL_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_ACCESS_TOKEN

oncallUrl String

An Grafana OnCall backend address. May alternatively be set via the GRAFANA_ONCALL_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_ONCALL_URL

orgId Number

The default organization id to operate on within grafana. For resources that have an org_id attribute, the resource-level attribute has priority. May alternatively be set via the GRAFANA_ORG_ID environment variable. It can also be sourced from the following environment variable: GRAFANA_ORG_ID

retries 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. It can also be sourced from the following environment variable: GRAFANA_RETRIES

smAccessToken String

A Synthetic Monitoring access token. May alternatively be set via the GRAFANA_SM_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: GRAFANA_SM_ACCESS_TOKEN

smUrl 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. 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. It can also be sourced from the following environment variable: GRAFANA_SM_URL

storeDashboardSha256 Boolean

Set to true if you want to save only the sha256sum instead of complete dashboard model JSON in the tfstate. It can also be sourced from the following environment variable: GRAFANA_STORE_DASHBOARD_SHA256

tlsCert String

Client TLS certificate file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_CERT environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_CERT

tlsKey String

Client TLS key file to use to authenticate to the Grafana server. May alternatively be set via the GRAFANA_TLS_KEY environment variable. It can also be sourced from the following environment variable: GRAFANA_TLS_KEY

url String

The root URL of a Grafana server. May alternatively be set via the GRAFANA_URL environment variable. It can also be sourced from the following environment variable: GRAFANA_URL

Outputs

All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Package Details

Repository
grafana lbrlabs/pulumi-grafana
License
Apache-2.0
Notes

This Pulumi package is based on the grafana Terraform Provider.