1. Packages
  2. Aiven Provider
  3. API Docs
  4. getGrafana
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

aiven.getGrafana

Explore with Pulumi AI

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

Gets information about an Aiven for Grafana® service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const exampleGrafana = aiven.getGrafana({
    project: exampleProject.project,
    serviceName: "example-grafana-service",
});
Copy
import pulumi
import pulumi_aiven as aiven

example_grafana = aiven.get_grafana(project=example_project["project"],
    service_name="example-grafana-service")
Copy
package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupGrafana(ctx, &aiven.LookupGrafanaArgs{
			Project:     exampleProject.Project,
			ServiceName: "example-grafana-service",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var exampleGrafana = Aiven.GetGrafana.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = "example-grafana-service",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetGrafanaArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleGrafana = AivenFunctions.getGrafana(GetGrafanaArgs.builder()
            .project(exampleProject.project())
            .serviceName("example-grafana-service")
            .build());

    }
}
Copy
variables:
  exampleGrafana:
    fn::invoke:
      function: aiven:getGrafana
      arguments:
        project: ${exampleProject.project}
        serviceName: example-grafana-service
Copy

Using getGrafana

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGrafana(args: GetGrafanaArgs, opts?: InvokeOptions): Promise<GetGrafanaResult>
function getGrafanaOutput(args: GetGrafanaOutputArgs, opts?: InvokeOptions): Output<GetGrafanaResult>
Copy
def get_grafana(project: Optional[str] = None,
                service_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGrafanaResult
def get_grafana_output(project: Optional[pulumi.Input[str]] = None,
                service_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGrafanaResult]
Copy
func LookupGrafana(ctx *Context, args *LookupGrafanaArgs, opts ...InvokeOption) (*LookupGrafanaResult, error)
func LookupGrafanaOutput(ctx *Context, args *LookupGrafanaOutputArgs, opts ...InvokeOption) LookupGrafanaResultOutput
Copy

> Note: This function is named LookupGrafana in the Go SDK.

public static class GetGrafana 
{
    public static Task<GetGrafanaResult> InvokeAsync(GetGrafanaArgs args, InvokeOptions? opts = null)
    public static Output<GetGrafanaResult> Invoke(GetGrafanaInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGrafanaResult> getGrafana(GetGrafanaArgs args, InvokeOptions options)
public static Output<GetGrafanaResult> getGrafana(GetGrafanaArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aiven:index/getGrafana:getGrafana
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName This property is required. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
Project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName This property is required. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
project This property is required. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
project This property is required. str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name This property is required. str
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
project This property is required. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

getGrafana Result

The following output properties are available:

AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components List<GetGrafanaComponent>
Service component information objects
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using
GrafanaUserConfigs List<GetGrafanaGrafanaUserConfig>
Grafana user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Grafanas List<GetGrafanaGrafana>
Values provided by the Grafana server.
Id string
The provider-assigned unique ID for this managed resource.
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string
The hostname of the service.
ServiceIntegrations List<GetGrafanaServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps List<string>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags List<GetGrafanaTag>
Tags are key-value pairs that allow you to categorize services.
TechEmails List<GetGrafanaTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components []GetGrafanaComponent
Service component information objects
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using
GrafanaUserConfigs []GetGrafanaGrafanaUserConfig
Grafana user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Grafanas []GetGrafanaGrafana
Values provided by the Grafana server.
Id string
The provider-assigned unique ID for this managed resource.
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string
The hostname of the service.
ServiceIntegrations []GetGrafanaServiceIntegration
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps []string
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags []GetGrafanaTag
Tags are key-value pairs that allow you to categorize services.
TechEmails []GetGrafanaTechEmail
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<GetGrafanaComponent>
Service component information objects
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using
grafanaUserConfigs List<GetGrafanaGrafanaUserConfig>
Grafana user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
grafanas List<GetGrafanaGrafana>
Values provided by the Grafana server.
id String
The provider-assigned unique ID for this managed resource.
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String
The hostname of the service.
serviceIntegrations List<GetGrafanaServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Integer
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<GetGrafanaTag>
Tags are key-value pairs that allow you to categorize services.
techEmails List<GetGrafanaTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components GetGrafanaComponent[]
Service component information objects
diskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
diskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string
Disk space that service is currently using
grafanaUserConfigs GetGrafanaGrafanaUserConfig[]
Grafana user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
grafanas GetGrafanaGrafana[]
Values provided by the Grafana server.
id string
The provider-assigned unique ID for this managed resource.
maintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost string
The hostname of the service.
serviceIntegrations GetGrafanaServiceIntegration[]
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword string
Password used for connecting to the service, if applicable
servicePort number
The port of the service
serviceType string
Aiven internal service type code
serviceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string
Username used for connecting to the service, if applicable
state string
staticIps string[]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags GetGrafanaTag[]
Tags are key-value pairs that allow you to categorize services.
techEmails GetGrafanaTechEmail[]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additional_disk_space str
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloud_name str
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components Sequence[GetGrafanaComponent]
Service component information objects
disk_space str
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
disk_space_cap str
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
disk_space_step str
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str
Disk space that service is currently using
grafana_user_configs Sequence[GetGrafanaGrafanaUserConfig]
Grafana user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
grafanas Sequence[GetGrafanaGrafana]
Values provided by the Grafana server.
id str
The provider-assigned unique ID for this managed resource.
maintenance_window_dow str
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project_vpc_id str
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_host str
The hostname of the service.
service_integrations Sequence[GetGrafanaServiceIntegration]
Service integrations to specify when creating a service. Not applied after initial service creation
service_name str
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
service_password str
Password used for connecting to the service, if applicable
service_port int
The port of the service
service_type str
Aiven internal service type code
service_uri str
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
service_username str
Username used for connecting to the service, if applicable
state str
static_ips Sequence[str]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags Sequence[GetGrafanaTag]
Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[GetGrafanaTechEmail]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
termination_protection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<Property Map>
Service component information objects
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using
grafanaUserConfigs List<Property Map>
Grafana user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
grafanas List<Property Map>
Values provided by the Grafana server.
id String
The provider-assigned unique ID for this managed resource.
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String
The hostname of the service.
serviceIntegrations List<Property Map>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Number
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<Property Map>
Tags are key-value pairs that allow you to categorize services.
techEmails List<Property Map>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Supporting Types

GetGrafanaComponent

Component This property is required. string
Service component name
ConnectionUri This property is required. string
Connection info for connecting to the service component. This is a combination of host and port.
Host This property is required. string
Host name for connecting to the service component
KafkaAuthenticationMethod This property is required. string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa This property is required. string
Kafka certificate used. The possible values are letsencrypt and project_ca.
Port This property is required. int
Port number for connecting to the service component
Route This property is required. string
Network access route
Ssl This property is required. bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage This property is required. string
DNS usage name
Component This property is required. string
Service component name
ConnectionUri This property is required. string
Connection info for connecting to the service component. This is a combination of host and port.
Host This property is required. string
Host name for connecting to the service component
KafkaAuthenticationMethod This property is required. string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa This property is required. string
Kafka certificate used. The possible values are letsencrypt and project_ca.
Port This property is required. int
Port number for connecting to the service component
Route This property is required. string
Network access route
Ssl This property is required. bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage This property is required. string
DNS usage name
component This property is required. String
Service component name
connectionUri This property is required. String
Connection info for connecting to the service component. This is a combination of host and port.
host This property is required. String
Host name for connecting to the service component
kafkaAuthenticationMethod This property is required. String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa This property is required. String
Kafka certificate used. The possible values are letsencrypt and project_ca.
port This property is required. Integer
Port number for connecting to the service component
route This property is required. String
Network access route
ssl This property is required. Boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage This property is required. String
DNS usage name
component This property is required. string
Service component name
connectionUri This property is required. string
Connection info for connecting to the service component. This is a combination of host and port.
host This property is required. string
Host name for connecting to the service component
kafkaAuthenticationMethod This property is required. string
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa This property is required. string
Kafka certificate used. The possible values are letsencrypt and project_ca.
port This property is required. number
Port number for connecting to the service component
route This property is required. string
Network access route
ssl This property is required. boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage This property is required. string
DNS usage name
component This property is required. str
Service component name
connection_uri This property is required. str
Connection info for connecting to the service component. This is a combination of host and port.
host This property is required. str
Host name for connecting to the service component
kafka_authentication_method This property is required. str
Kafka authentication method. This is a value specific to the 'kafka' service component
kafka_ssl_ca This property is required. str
Kafka certificate used. The possible values are letsencrypt and project_ca.
port This property is required. int
Port number for connecting to the service component
route This property is required. str
Network access route
ssl This property is required. bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage This property is required. str
DNS usage name
component This property is required. String
Service component name
connectionUri This property is required. String
Connection info for connecting to the service component. This is a combination of host and port.
host This property is required. String
Host name for connecting to the service component
kafkaAuthenticationMethod This property is required. String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa This property is required. String
Kafka certificate used. The possible values are letsencrypt and project_ca.
port This property is required. Number
Port number for connecting to the service component
route This property is required. String
Network access route
ssl This property is required. Boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage This property is required. String
DNS usage name

GetGrafanaGrafana

Uris This property is required. List<string>
Grafana server URIs.
Uris This property is required. []string
Grafana server URIs.
uris This property is required. List<String>
Grafana server URIs.
uris This property is required. string[]
Grafana server URIs.
uris This property is required. Sequence[str]
Grafana server URIs.
uris This property is required. List<String>
Grafana server URIs.

GetGrafanaGrafanaUserConfig

AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.
AlertingEnabled bool
Setting has no effect with Grafana 11 and onward. Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
AlertingErrorOrTimeout string
Enum: alerting, keep_state. Default error or timeout setting for new alerting rules.
AlertingMaxAnnotationsToKeep int
Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example: 0.
AlertingNodataOrNullvalues string
Enum: alerting, keep_state, no_data, ok. Default value for 'no data or null values' for new alerting rules.
AllowEmbedding bool
Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking.
AuthAzuread GetGrafanaGrafanaUserConfigAuthAzuread
Azure AD OAuth integration
AuthBasicEnabled bool
Enable or disable basic authentication form, used by Grafana built-in login.
AuthGenericOauth GetGrafanaGrafanaUserConfigAuthGenericOauth
Generic OAuth integration
AuthGithub GetGrafanaGrafanaUserConfigAuthGithub
Github Auth integration
AuthGitlab GetGrafanaGrafanaUserConfigAuthGitlab
GitLab Auth integration
AuthGoogle GetGrafanaGrafanaUserConfigAuthGoogle
Google Auth integration
CookieSamesite string
Enum: lax, none, strict. Cookie SameSite attribute: strict prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. lax is the default value.
CustomDomain string
Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
DashboardPreviewsEnabled bool
Enable browsing of dashboards in grid (pictures) mode. This feature is new in Grafana 9 and is quite resource intensive. It may cause low-end plans to work more slowly while the dashboard previews are rendering.
DashboardScenesEnabled bool
Enable use of the Grafana Scenes Library as the dashboard engine. i.e. the dashboardScene feature flag. Upstream blog post at https://grafana.com/blog/2024/10/31/grafana-dashboards-are-now-powered-by-scenes-big-changes-same-ui/.
DashboardsMinRefreshInterval string
Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example: 5s.
DashboardsVersionsToKeep int
Dashboard versions to keep per dashboard. Example: 20.
DataproxySendUserHeader bool
Send X-Grafana-User header to data source.
DataproxyTimeout int
Timeout for data proxy requests in seconds. Example: 30.
DateFormats GetGrafanaGrafanaUserConfigDateFormats
Grafana date format specifications
DisableGravatar bool
Set to true to disable gravatar. Defaults to false (gravatar is enabled).
EditorsCanAdmin bool
Editors can manage folders, teams and dashboards created by them.
ExternalImageStorage GetGrafanaGrafanaUserConfigExternalImageStorage
External image store settings
GoogleAnalyticsUaId string
Google Analytics ID. Example: UA-123456-4.
IpFilterObjects List<GetGrafanaGrafanaUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

MetricsEnabled bool
Enable Grafana's /metrics endpoint.
OauthAllowInsecureEmailLookup bool
Enforce user lookup based on email instead of the unique ID provided by the IdP.
PrivateAccess GetGrafanaGrafanaUserConfigPrivateAccess
Allow access to selected service ports from private networks
PrivatelinkAccess GetGrafanaGrafanaUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
ProjectToForkFrom string
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess GetGrafanaGrafanaUserConfigPublicAccess
Allow access to selected service ports from the public Internet
RecoveryBasebackupName string
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
ServiceToForkFrom string
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
SmtpServer GetGrafanaGrafanaUserConfigSmtpServer
SMTP server settings
StaticIps bool
Use static public IP addresses.
UnifiedAlertingEnabled bool
Enable or disable Grafana unified alerting functionality. By default this is enabled and any legacy alerts will be migrated on upgrade to Grafana 9+. To stay on legacy alerting, set unified_alerting_enabled to false and alerting_enabled to true. See https://grafana.com/docs/grafana/latest/alerting/ for more details.
UserAutoAssignOrg bool
Auto-assign new users on signup to main organization. Defaults to false.
UserAutoAssignOrgRole string
Enum: Admin, Editor, Viewer. Set role for new signups. Defaults to Viewer.
ViewersCanEdit bool
Users with view-only permission can edit but not save dashboards.
Wal bool
Setting to enable/disable Write-Ahead Logging. The default value is false (disabled).
AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.
AlertingEnabled bool
Setting has no effect with Grafana 11 and onward. Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
AlertingErrorOrTimeout string
Enum: alerting, keep_state. Default error or timeout setting for new alerting rules.
AlertingMaxAnnotationsToKeep int
Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example: 0.
AlertingNodataOrNullvalues string
Enum: alerting, keep_state, no_data, ok. Default value for 'no data or null values' for new alerting rules.
AllowEmbedding bool
Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking.
AuthAzuread GetGrafanaGrafanaUserConfigAuthAzuread
Azure AD OAuth integration
AuthBasicEnabled bool
Enable or disable basic authentication form, used by Grafana built-in login.
AuthGenericOauth GetGrafanaGrafanaUserConfigAuthGenericOauth
Generic OAuth integration
AuthGithub GetGrafanaGrafanaUserConfigAuthGithub
Github Auth integration
AuthGitlab GetGrafanaGrafanaUserConfigAuthGitlab
GitLab Auth integration
AuthGoogle GetGrafanaGrafanaUserConfigAuthGoogle
Google Auth integration
CookieSamesite string
Enum: lax, none, strict. Cookie SameSite attribute: strict prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. lax is the default value.
CustomDomain string
Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
DashboardPreviewsEnabled bool
Enable browsing of dashboards in grid (pictures) mode. This feature is new in Grafana 9 and is quite resource intensive. It may cause low-end plans to work more slowly while the dashboard previews are rendering.
DashboardScenesEnabled bool
Enable use of the Grafana Scenes Library as the dashboard engine. i.e. the dashboardScene feature flag. Upstream blog post at https://grafana.com/blog/2024/10/31/grafana-dashboards-are-now-powered-by-scenes-big-changes-same-ui/.
DashboardsMinRefreshInterval string
Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example: 5s.
DashboardsVersionsToKeep int
Dashboard versions to keep per dashboard. Example: 20.
DataproxySendUserHeader bool
Send X-Grafana-User header to data source.
DataproxyTimeout int
Timeout for data proxy requests in seconds. Example: 30.
DateFormats GetGrafanaGrafanaUserConfigDateFormats
Grafana date format specifications
DisableGravatar bool
Set to true to disable gravatar. Defaults to false (gravatar is enabled).
EditorsCanAdmin bool
Editors can manage folders, teams and dashboards created by them.
ExternalImageStorage GetGrafanaGrafanaUserConfigExternalImageStorage
External image store settings
GoogleAnalyticsUaId string
Google Analytics ID. Example: UA-123456-4.
IpFilterObjects []GetGrafanaGrafanaUserConfigIpFilterObject
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

MetricsEnabled bool
Enable Grafana's /metrics endpoint.
OauthAllowInsecureEmailLookup bool
Enforce user lookup based on email instead of the unique ID provided by the IdP.
PrivateAccess GetGrafanaGrafanaUserConfigPrivateAccess
Allow access to selected service ports from private networks
PrivatelinkAccess GetGrafanaGrafanaUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
ProjectToForkFrom string
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess GetGrafanaGrafanaUserConfigPublicAccess
Allow access to selected service ports from the public Internet
RecoveryBasebackupName string
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
ServiceToForkFrom string
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
SmtpServer GetGrafanaGrafanaUserConfigSmtpServer
SMTP server settings
StaticIps bool
Use static public IP addresses.
UnifiedAlertingEnabled bool
Enable or disable Grafana unified alerting functionality. By default this is enabled and any legacy alerts will be migrated on upgrade to Grafana 9+. To stay on legacy alerting, set unified_alerting_enabled to false and alerting_enabled to true. See https://grafana.com/docs/grafana/latest/alerting/ for more details.
UserAutoAssignOrg bool
Auto-assign new users on signup to main organization. Defaults to false.
UserAutoAssignOrgRole string
Enum: Admin, Editor, Viewer. Set role for new signups. Defaults to Viewer.
ViewersCanEdit bool
Users with view-only permission can edit but not save dashboards.
Wal bool
Setting to enable/disable Write-Ahead Logging. The default value is false (disabled).
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.
alertingEnabled Boolean
Setting has no effect with Grafana 11 and onward. Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
alertingErrorOrTimeout String
Enum: alerting, keep_state. Default error or timeout setting for new alerting rules.
alertingMaxAnnotationsToKeep Integer
Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example: 0.
alertingNodataOrNullvalues String
Enum: alerting, keep_state, no_data, ok. Default value for 'no data or null values' for new alerting rules.
allowEmbedding Boolean
Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking.
authAzuread GetGrafanaGrafanaUserConfigAuthAzuread
Azure AD OAuth integration
authBasicEnabled Boolean
Enable or disable basic authentication form, used by Grafana built-in login.
authGenericOauth GetGrafanaGrafanaUserConfigAuthGenericOauth
Generic OAuth integration
authGithub GetGrafanaGrafanaUserConfigAuthGithub
Github Auth integration
authGitlab GetGrafanaGrafanaUserConfigAuthGitlab
GitLab Auth integration
authGoogle GetGrafanaGrafanaUserConfigAuthGoogle
Google Auth integration
cookieSamesite String
Enum: lax, none, strict. Cookie SameSite attribute: strict prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. lax is the default value.
customDomain String
Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
dashboardPreviewsEnabled Boolean
Enable browsing of dashboards in grid (pictures) mode. This feature is new in Grafana 9 and is quite resource intensive. It may cause low-end plans to work more slowly while the dashboard previews are rendering.
dashboardScenesEnabled Boolean
Enable use of the Grafana Scenes Library as the dashboard engine. i.e. the dashboardScene feature flag. Upstream blog post at https://grafana.com/blog/2024/10/31/grafana-dashboards-are-now-powered-by-scenes-big-changes-same-ui/.
dashboardsMinRefreshInterval String
Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example: 5s.
dashboardsVersionsToKeep Integer
Dashboard versions to keep per dashboard. Example: 20.
dataproxySendUserHeader Boolean
Send X-Grafana-User header to data source.
dataproxyTimeout Integer
Timeout for data proxy requests in seconds. Example: 30.
dateFormats GetGrafanaGrafanaUserConfigDateFormats
Grafana date format specifications
disableGravatar Boolean
Set to true to disable gravatar. Defaults to false (gravatar is enabled).
editorsCanAdmin Boolean
Editors can manage folders, teams and dashboards created by them.
externalImageStorage GetGrafanaGrafanaUserConfigExternalImageStorage
External image store settings
googleAnalyticsUaId String
Google Analytics ID. Example: UA-123456-4.
ipFilterObjects List<GetGrafanaGrafanaUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

metricsEnabled Boolean
Enable Grafana's /metrics endpoint.
oauthAllowInsecureEmailLookup Boolean
Enforce user lookup based on email instead of the unique ID provided by the IdP.
privateAccess GetGrafanaGrafanaUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelinkAccess GetGrafanaGrafanaUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
projectToForkFrom String
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess GetGrafanaGrafanaUserConfigPublicAccess
Allow access to selected service ports from the public Internet
recoveryBasebackupName String
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom String
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
smtpServer GetGrafanaGrafanaUserConfigSmtpServer
SMTP server settings
staticIps Boolean
Use static public IP addresses.
unifiedAlertingEnabled Boolean
Enable or disable Grafana unified alerting functionality. By default this is enabled and any legacy alerts will be migrated on upgrade to Grafana 9+. To stay on legacy alerting, set unified_alerting_enabled to false and alerting_enabled to true. See https://grafana.com/docs/grafana/latest/alerting/ for more details.
userAutoAssignOrg Boolean
Auto-assign new users on signup to main organization. Defaults to false.
userAutoAssignOrgRole String
Enum: Admin, Editor, Viewer. Set role for new signups. Defaults to Viewer.
viewersCanEdit Boolean
Users with view-only permission can edit but not save dashboards.
wal Boolean
Setting to enable/disable Write-Ahead Logging. The default value is false (disabled).
additionalBackupRegions string
Additional Cloud Regions for Backup Replication.
alertingEnabled boolean
Setting has no effect with Grafana 11 and onward. Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
alertingErrorOrTimeout string
Enum: alerting, keep_state. Default error or timeout setting for new alerting rules.
alertingMaxAnnotationsToKeep number
Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example: 0.
alertingNodataOrNullvalues string
Enum: alerting, keep_state, no_data, ok. Default value for 'no data or null values' for new alerting rules.
allowEmbedding boolean
Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking.
authAzuread GetGrafanaGrafanaUserConfigAuthAzuread
Azure AD OAuth integration
authBasicEnabled boolean
Enable or disable basic authentication form, used by Grafana built-in login.
authGenericOauth GetGrafanaGrafanaUserConfigAuthGenericOauth
Generic OAuth integration
authGithub GetGrafanaGrafanaUserConfigAuthGithub
Github Auth integration
authGitlab GetGrafanaGrafanaUserConfigAuthGitlab
GitLab Auth integration
authGoogle GetGrafanaGrafanaUserConfigAuthGoogle
Google Auth integration
cookieSamesite string
Enum: lax, none, strict. Cookie SameSite attribute: strict prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. lax is the default value.
customDomain string
Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
dashboardPreviewsEnabled boolean
Enable browsing of dashboards in grid (pictures) mode. This feature is new in Grafana 9 and is quite resource intensive. It may cause low-end plans to work more slowly while the dashboard previews are rendering.
dashboardScenesEnabled boolean
Enable use of the Grafana Scenes Library as the dashboard engine. i.e. the dashboardScene feature flag. Upstream blog post at https://grafana.com/blog/2024/10/31/grafana-dashboards-are-now-powered-by-scenes-big-changes-same-ui/.
dashboardsMinRefreshInterval string
Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example: 5s.
dashboardsVersionsToKeep number
Dashboard versions to keep per dashboard. Example: 20.
dataproxySendUserHeader boolean
Send X-Grafana-User header to data source.
dataproxyTimeout number
Timeout for data proxy requests in seconds. Example: 30.
dateFormats GetGrafanaGrafanaUserConfigDateFormats
Grafana date format specifications
disableGravatar boolean
Set to true to disable gravatar. Defaults to false (gravatar is enabled).
editorsCanAdmin boolean
Editors can manage folders, teams and dashboards created by them.
externalImageStorage GetGrafanaGrafanaUserConfigExternalImageStorage
External image store settings
googleAnalyticsUaId string
Google Analytics ID. Example: UA-123456-4.
ipFilterObjects GetGrafanaGrafanaUserConfigIpFilterObject[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

metricsEnabled boolean
Enable Grafana's /metrics endpoint.
oauthAllowInsecureEmailLookup boolean
Enforce user lookup based on email instead of the unique ID provided by the IdP.
privateAccess GetGrafanaGrafanaUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelinkAccess GetGrafanaGrafanaUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
projectToForkFrom string
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess GetGrafanaGrafanaUserConfigPublicAccess
Allow access to selected service ports from the public Internet
recoveryBasebackupName string
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
serviceLog boolean
Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom string
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
smtpServer GetGrafanaGrafanaUserConfigSmtpServer
SMTP server settings
staticIps boolean
Use static public IP addresses.
unifiedAlertingEnabled boolean
Enable or disable Grafana unified alerting functionality. By default this is enabled and any legacy alerts will be migrated on upgrade to Grafana 9+. To stay on legacy alerting, set unified_alerting_enabled to false and alerting_enabled to true. See https://grafana.com/docs/grafana/latest/alerting/ for more details.
userAutoAssignOrg boolean
Auto-assign new users on signup to main organization. Defaults to false.
userAutoAssignOrgRole string
Enum: Admin, Editor, Viewer. Set role for new signups. Defaults to Viewer.
viewersCanEdit boolean
Users with view-only permission can edit but not save dashboards.
wal boolean
Setting to enable/disable Write-Ahead Logging. The default value is false (disabled).
additional_backup_regions str
Additional Cloud Regions for Backup Replication.
alerting_enabled bool
Setting has no effect with Grafana 11 and onward. Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
alerting_error_or_timeout str
Enum: alerting, keep_state. Default error or timeout setting for new alerting rules.
alerting_max_annotations_to_keep int
Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example: 0.
alerting_nodata_or_nullvalues str
Enum: alerting, keep_state, no_data, ok. Default value for 'no data or null values' for new alerting rules.
allow_embedding bool
Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking.
auth_azuread GetGrafanaGrafanaUserConfigAuthAzuread
Azure AD OAuth integration
auth_basic_enabled bool
Enable or disable basic authentication form, used by Grafana built-in login.
auth_generic_oauth GetGrafanaGrafanaUserConfigAuthGenericOauth
Generic OAuth integration
auth_github GetGrafanaGrafanaUserConfigAuthGithub
Github Auth integration
auth_gitlab GetGrafanaGrafanaUserConfigAuthGitlab
GitLab Auth integration
auth_google GetGrafanaGrafanaUserConfigAuthGoogle
Google Auth integration
cookie_samesite str
Enum: lax, none, strict. Cookie SameSite attribute: strict prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. lax is the default value.
custom_domain str
Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
dashboard_previews_enabled bool
Enable browsing of dashboards in grid (pictures) mode. This feature is new in Grafana 9 and is quite resource intensive. It may cause low-end plans to work more slowly while the dashboard previews are rendering.
dashboard_scenes_enabled bool
Enable use of the Grafana Scenes Library as the dashboard engine. i.e. the dashboardScene feature flag. Upstream blog post at https://grafana.com/blog/2024/10/31/grafana-dashboards-are-now-powered-by-scenes-big-changes-same-ui/.
dashboards_min_refresh_interval str
Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example: 5s.
dashboards_versions_to_keep int
Dashboard versions to keep per dashboard. Example: 20.
dataproxy_send_user_header bool
Send X-Grafana-User header to data source.
dataproxy_timeout int
Timeout for data proxy requests in seconds. Example: 30.
date_formats GetGrafanaGrafanaUserConfigDateFormats
Grafana date format specifications
disable_gravatar bool
Set to true to disable gravatar. Defaults to false (gravatar is enabled).
editors_can_admin bool
Editors can manage folders, teams and dashboards created by them.
external_image_storage GetGrafanaGrafanaUserConfigExternalImageStorage
External image store settings
google_analytics_ua_id str
Google Analytics ID. Example: UA-123456-4.
ip_filter_objects Sequence[GetGrafanaGrafanaUserConfigIpFilterObject]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ip_filter_strings Sequence[str]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ip_filters Sequence[str]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

metrics_enabled bool
Enable Grafana's /metrics endpoint.
oauth_allow_insecure_email_lookup bool
Enforce user lookup based on email instead of the unique ID provided by the IdP.
private_access GetGrafanaGrafanaUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelink_access GetGrafanaGrafanaUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
project_to_fork_from str
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
public_access GetGrafanaGrafanaUserConfigPublicAccess
Allow access to selected service ports from the public Internet
recovery_basebackup_name str
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
service_log bool
Store logs for the service so that they are available in the HTTP API and console.
service_to_fork_from str
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
smtp_server GetGrafanaGrafanaUserConfigSmtpServer
SMTP server settings
static_ips bool
Use static public IP addresses.
unified_alerting_enabled bool
Enable or disable Grafana unified alerting functionality. By default this is enabled and any legacy alerts will be migrated on upgrade to Grafana 9+. To stay on legacy alerting, set unified_alerting_enabled to false and alerting_enabled to true. See https://grafana.com/docs/grafana/latest/alerting/ for more details.
user_auto_assign_org bool
Auto-assign new users on signup to main organization. Defaults to false.
user_auto_assign_org_role str
Enum: Admin, Editor, Viewer. Set role for new signups. Defaults to Viewer.
viewers_can_edit bool
Users with view-only permission can edit but not save dashboards.
wal bool
Setting to enable/disable Write-Ahead Logging. The default value is false (disabled).
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.
alertingEnabled Boolean
Setting has no effect with Grafana 11 and onward. Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
alertingErrorOrTimeout String
Enum: alerting, keep_state. Default error or timeout setting for new alerting rules.
alertingMaxAnnotationsToKeep Number
Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example: 0.
alertingNodataOrNullvalues String
Enum: alerting, keep_state, no_data, ok. Default value for 'no data or null values' for new alerting rules.
allowEmbedding Boolean
Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking.
authAzuread Property Map
Azure AD OAuth integration
authBasicEnabled Boolean
Enable or disable basic authentication form, used by Grafana built-in login.
authGenericOauth Property Map
Generic OAuth integration
authGithub Property Map
Github Auth integration
authGitlab Property Map
GitLab Auth integration
authGoogle Property Map
Google Auth integration
cookieSamesite String
Enum: lax, none, strict. Cookie SameSite attribute: strict prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. lax is the default value.
customDomain String
Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
dashboardPreviewsEnabled Boolean
Enable browsing of dashboards in grid (pictures) mode. This feature is new in Grafana 9 and is quite resource intensive. It may cause low-end plans to work more slowly while the dashboard previews are rendering.
dashboardScenesEnabled Boolean
Enable use of the Grafana Scenes Library as the dashboard engine. i.e. the dashboardScene feature flag. Upstream blog post at https://grafana.com/blog/2024/10/31/grafana-dashboards-are-now-powered-by-scenes-big-changes-same-ui/.
dashboardsMinRefreshInterval String
Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example: 5s.
dashboardsVersionsToKeep Number
Dashboard versions to keep per dashboard. Example: 20.
dataproxySendUserHeader Boolean
Send X-Grafana-User header to data source.
dataproxyTimeout Number
Timeout for data proxy requests in seconds. Example: 30.
dateFormats Property Map
Grafana date format specifications
disableGravatar Boolean
Set to true to disable gravatar. Defaults to false (gravatar is enabled).
editorsCanAdmin Boolean
Editors can manage folders, teams and dashboards created by them.
externalImageStorage Property Map
External image store settings
googleAnalyticsUaId String
Google Analytics ID. Example: UA-123456-4.
ipFilterObjects List<Property Map>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

metricsEnabled Boolean
Enable Grafana's /metrics endpoint.
oauthAllowInsecureEmailLookup Boolean
Enforce user lookup based on email instead of the unique ID provided by the IdP.
privateAccess Property Map
Allow access to selected service ports from private networks
privatelinkAccess Property Map
Allow access to selected service components through Privatelink
projectToForkFrom String
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess Property Map
Allow access to selected service ports from the public Internet
recoveryBasebackupName String
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom String
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
smtpServer Property Map
SMTP server settings
staticIps Boolean
Use static public IP addresses.
unifiedAlertingEnabled Boolean
Enable or disable Grafana unified alerting functionality. By default this is enabled and any legacy alerts will be migrated on upgrade to Grafana 9+. To stay on legacy alerting, set unified_alerting_enabled to false and alerting_enabled to true. See https://grafana.com/docs/grafana/latest/alerting/ for more details.
userAutoAssignOrg Boolean
Auto-assign new users on signup to main organization. Defaults to false.
userAutoAssignOrgRole String
Enum: Admin, Editor, Viewer. Set role for new signups. Defaults to Viewer.
viewersCanEdit Boolean
Users with view-only permission can edit but not save dashboards.
wal Boolean
Setting to enable/disable Write-Ahead Logging. The default value is false (disabled).

GetGrafanaGrafanaUserConfigAuthAzuread

AuthUrl This property is required. string
Authorization URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize.
ClientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
ClientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
TokenUrl This property is required. string
Token URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token.
AllowSignUp bool
Automatically sign-up users on successful sign-in.
AllowedDomains List<string>
Allowed domains.
AllowedGroups List<string>
Require users to belong to one of given groups.
AuthUrl This property is required. string
Authorization URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize.
ClientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
ClientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
TokenUrl This property is required. string
Token URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token.
AllowSignUp bool
Automatically sign-up users on successful sign-in.
AllowedDomains []string
Allowed domains.
AllowedGroups []string
Require users to belong to one of given groups.
authUrl This property is required. String
Authorization URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize.
clientId This property is required. String
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. String
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
tokenUrl This property is required. String
Token URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token.
allowSignUp Boolean
Automatically sign-up users on successful sign-in.
allowedDomains List<String>
Allowed domains.
allowedGroups List<String>
Require users to belong to one of given groups.
authUrl This property is required. string
Authorization URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize.
clientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
tokenUrl This property is required. string
Token URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token.
allowSignUp boolean
Automatically sign-up users on successful sign-in.
allowedDomains string[]
Allowed domains.
allowedGroups string[]
Require users to belong to one of given groups.
auth_url This property is required. str
Authorization URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize.
client_id This property is required. str
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
client_secret This property is required. str
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
token_url This property is required. str
Token URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token.
allow_sign_up bool
Automatically sign-up users on successful sign-in.
allowed_domains Sequence[str]
Allowed domains.
allowed_groups Sequence[str]
Require users to belong to one of given groups.
authUrl This property is required. String
Authorization URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize.
clientId This property is required. String
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. String
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
tokenUrl This property is required. String
Token URL. Example: https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token.
allowSignUp Boolean
Automatically sign-up users on successful sign-in.
allowedDomains List<String>
Allowed domains.
allowedGroups List<String>
Require users to belong to one of given groups.

GetGrafanaGrafanaUserConfigAuthGenericOauth

ApiUrl This property is required. string
API URL. Example: https://yourprovider.com/api.
AuthUrl This property is required. string
Authorization URL. Example: https://yourprovider.com/oauth/authorize.
ClientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
ClientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
TokenUrl This property is required. string
Token URL. Example: https://yourprovider.com/oauth/token.
AllowSignUp bool
Automatically sign-up users on successful sign-in.
AllowedDomains List<string>
Allowed domains.
AllowedOrganizations List<string>
Require user to be member of one of the listed organizations.
AutoLogin bool
Allow users to bypass the login screen and automatically log in.
Name string
Name of the OAuth integration. Example: My authentication.
Scopes List<string>
OAuth scopes.
UseRefreshToken bool
Set to true to use refresh token and check access token expiration.
ApiUrl This property is required. string
API URL. Example: https://yourprovider.com/api.
AuthUrl This property is required. string
Authorization URL. Example: https://yourprovider.com/oauth/authorize.
ClientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
ClientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
TokenUrl This property is required. string
Token URL. Example: https://yourprovider.com/oauth/token.
AllowSignUp bool
Automatically sign-up users on successful sign-in.
AllowedDomains []string
Allowed domains.
AllowedOrganizations []string
Require user to be member of one of the listed organizations.
AutoLogin bool
Allow users to bypass the login screen and automatically log in.
Name string
Name of the OAuth integration. Example: My authentication.
Scopes []string
OAuth scopes.
UseRefreshToken bool
Set to true to use refresh token and check access token expiration.
apiUrl This property is required. String
API URL. Example: https://yourprovider.com/api.
authUrl This property is required. String
Authorization URL. Example: https://yourprovider.com/oauth/authorize.
clientId This property is required. String
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. String
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
tokenUrl This property is required. String
Token URL. Example: https://yourprovider.com/oauth/token.
allowSignUp Boolean
Automatically sign-up users on successful sign-in.
allowedDomains List<String>
Allowed domains.
allowedOrganizations List<String>
Require user to be member of one of the listed organizations.
autoLogin Boolean
Allow users to bypass the login screen and automatically log in.
name String
Name of the OAuth integration. Example: My authentication.
scopes List<String>
OAuth scopes.
useRefreshToken Boolean
Set to true to use refresh token and check access token expiration.
apiUrl This property is required. string
API URL. Example: https://yourprovider.com/api.
authUrl This property is required. string
Authorization URL. Example: https://yourprovider.com/oauth/authorize.
clientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
tokenUrl This property is required. string
Token URL. Example: https://yourprovider.com/oauth/token.
allowSignUp boolean
Automatically sign-up users on successful sign-in.
allowedDomains string[]
Allowed domains.
allowedOrganizations string[]
Require user to be member of one of the listed organizations.
autoLogin boolean
Allow users to bypass the login screen and automatically log in.
name string
Name of the OAuth integration. Example: My authentication.
scopes string[]
OAuth scopes.
useRefreshToken boolean
Set to true to use refresh token and check access token expiration.
api_url This property is required. str
API URL. Example: https://yourprovider.com/api.
auth_url This property is required. str
Authorization URL. Example: https://yourprovider.com/oauth/authorize.
client_id This property is required. str
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
client_secret This property is required. str
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
token_url This property is required. str
Token URL. Example: https://yourprovider.com/oauth/token.
allow_sign_up bool
Automatically sign-up users on successful sign-in.
allowed_domains Sequence[str]
Allowed domains.
allowed_organizations Sequence[str]
Require user to be member of one of the listed organizations.
auto_login bool
Allow users to bypass the login screen and automatically log in.
name str
Name of the OAuth integration. Example: My authentication.
scopes Sequence[str]
OAuth scopes.
use_refresh_token bool
Set to true to use refresh token and check access token expiration.
apiUrl This property is required. String
API URL. Example: https://yourprovider.com/api.
authUrl This property is required. String
Authorization URL. Example: https://yourprovider.com/oauth/authorize.
clientId This property is required. String
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. String
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
tokenUrl This property is required. String
Token URL. Example: https://yourprovider.com/oauth/token.
allowSignUp Boolean
Automatically sign-up users on successful sign-in.
allowedDomains List<String>
Allowed domains.
allowedOrganizations List<String>
Require user to be member of one of the listed organizations.
autoLogin Boolean
Allow users to bypass the login screen and automatically log in.
name String
Name of the OAuth integration. Example: My authentication.
scopes List<String>
OAuth scopes.
useRefreshToken Boolean
Set to true to use refresh token and check access token expiration.

GetGrafanaGrafanaUserConfigAuthGithub

ClientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
ClientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
AllowSignUp bool
Automatically sign-up users on successful sign-in.
AllowedOrganizations List<string>
Require users to belong to one of given organizations.
AutoLogin bool
Allow users to bypass the login screen and automatically log in.
SkipOrgRoleSync bool
Stop automatically syncing user roles.
TeamIds List<int>
Require users to belong to one of given team IDs.
ClientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
ClientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
AllowSignUp bool
Automatically sign-up users on successful sign-in.
AllowedOrganizations []string
Require users to belong to one of given organizations.
AutoLogin bool
Allow users to bypass the login screen and automatically log in.
SkipOrgRoleSync bool
Stop automatically syncing user roles.
TeamIds []int
Require users to belong to one of given team IDs.
clientId This property is required. String
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. String
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allowSignUp Boolean
Automatically sign-up users on successful sign-in.
allowedOrganizations List<String>
Require users to belong to one of given organizations.
autoLogin Boolean
Allow users to bypass the login screen and automatically log in.
skipOrgRoleSync Boolean
Stop automatically syncing user roles.
teamIds List<Integer>
Require users to belong to one of given team IDs.
clientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allowSignUp boolean
Automatically sign-up users on successful sign-in.
allowedOrganizations string[]
Require users to belong to one of given organizations.
autoLogin boolean
Allow users to bypass the login screen and automatically log in.
skipOrgRoleSync boolean
Stop automatically syncing user roles.
teamIds number[]
Require users to belong to one of given team IDs.
client_id This property is required. str
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
client_secret This property is required. str
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allow_sign_up bool
Automatically sign-up users on successful sign-in.
allowed_organizations Sequence[str]
Require users to belong to one of given organizations.
auto_login bool
Allow users to bypass the login screen and automatically log in.
skip_org_role_sync bool
Stop automatically syncing user roles.
team_ids Sequence[int]
Require users to belong to one of given team IDs.
clientId This property is required. String
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. String
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allowSignUp Boolean
Automatically sign-up users on successful sign-in.
allowedOrganizations List<String>
Require users to belong to one of given organizations.
autoLogin Boolean
Allow users to bypass the login screen and automatically log in.
skipOrgRoleSync Boolean
Stop automatically syncing user roles.
teamIds List<Number>
Require users to belong to one of given team IDs.

GetGrafanaGrafanaUserConfigAuthGitlab

AllowedGroups This property is required. List<string>
Require users to belong to one of given groups.
ClientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
ClientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
AllowSignUp bool
Automatically sign-up users on successful sign-in.
ApiUrl string
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/api/v4.
AuthUrl string
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/authorize.
TokenUrl string
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/token.
AllowedGroups This property is required. []string
Require users to belong to one of given groups.
ClientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
ClientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
AllowSignUp bool
Automatically sign-up users on successful sign-in.
ApiUrl string
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/api/v4.
AuthUrl string
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/authorize.
TokenUrl string
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/token.
allowedGroups This property is required. List<String>
Require users to belong to one of given groups.
clientId This property is required. String
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. String
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allowSignUp Boolean
Automatically sign-up users on successful sign-in.
apiUrl String
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/api/v4.
authUrl String
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/authorize.
tokenUrl String
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/token.
allowedGroups This property is required. string[]
Require users to belong to one of given groups.
clientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allowSignUp boolean
Automatically sign-up users on successful sign-in.
apiUrl string
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/api/v4.
authUrl string
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/authorize.
tokenUrl string
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/token.
allowed_groups This property is required. Sequence[str]
Require users to belong to one of given groups.
client_id This property is required. str
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
client_secret This property is required. str
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allow_sign_up bool
Automatically sign-up users on successful sign-in.
api_url str
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/api/v4.
auth_url str
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/authorize.
token_url str
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/token.
allowedGroups This property is required. List<String>
Require users to belong to one of given groups.
clientId This property is required. String
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. String
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allowSignUp Boolean
Automatically sign-up users on successful sign-in.
apiUrl String
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/api/v4.
authUrl String
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/authorize.
tokenUrl String
This only needs to be set when using self hosted GitLab. Example: https://gitlab.com/oauth/token.

GetGrafanaGrafanaUserConfigAuthGoogle

AllowedDomains This property is required. List<string>
Domains allowed to sign-in to this Grafana.
ClientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
ClientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
AllowSignUp bool
Automatically sign-up users on successful sign-in.
AllowedDomains This property is required. []string
Domains allowed to sign-in to this Grafana.
ClientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
ClientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
AllowSignUp bool
Automatically sign-up users on successful sign-in.
allowedDomains This property is required. List<String>
Domains allowed to sign-in to this Grafana.
clientId This property is required. String
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. String
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allowSignUp Boolean
Automatically sign-up users on successful sign-in.
allowedDomains This property is required. string[]
Domains allowed to sign-in to this Grafana.
clientId This property is required. string
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. string
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allowSignUp boolean
Automatically sign-up users on successful sign-in.
allowed_domains This property is required. Sequence[str]
Domains allowed to sign-in to this Grafana.
client_id This property is required. str
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
client_secret This property is required. str
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allow_sign_up bool
Automatically sign-up users on successful sign-in.
allowedDomains This property is required. List<String>
Domains allowed to sign-in to this Grafana.
clientId This property is required. String
Client ID from provider. Example: b1ba0bf54a4c2c0a1c29.
clientSecret This property is required. String
Client secret from provider. Example: bfa6gea4f129076761dcba8ce5e1e406bd83af7b.
allowSignUp Boolean
Automatically sign-up users on successful sign-in.

GetGrafanaGrafanaUserConfigDateFormats

DefaultTimezone string
Default time zone for user preferences. Value browser uses browser local time zone. Example: Europe/Helsinki.
FullDate string
Moment.js style format string for cases where full date is shown. Example: YYYY MM DD.
IntervalDay string
Moment.js style format string used when a time requiring day accuracy is shown. Example: MM/DD.
IntervalHour string
Moment.js style format string used when a time requiring hour accuracy is shown. Example: MM/DD HH:mm.
IntervalMinute string
Moment.js style format string used when a time requiring minute accuracy is shown. Example: HH:mm.
IntervalMonth string
Moment.js style format string used when a time requiring month accuracy is shown. Example: YYYY-MM.
IntervalSecond string
Moment.js style format string used when a time requiring second accuracy is shown. Example: HH:mm:ss.
IntervalYear string
Moment.js style format string used when a time requiring year accuracy is shown. Example: YYYY.
DefaultTimezone string
Default time zone for user preferences. Value browser uses browser local time zone. Example: Europe/Helsinki.
FullDate string
Moment.js style format string for cases where full date is shown. Example: YYYY MM DD.
IntervalDay string
Moment.js style format string used when a time requiring day accuracy is shown. Example: MM/DD.
IntervalHour string
Moment.js style format string used when a time requiring hour accuracy is shown. Example: MM/DD HH:mm.
IntervalMinute string
Moment.js style format string used when a time requiring minute accuracy is shown. Example: HH:mm.
IntervalMonth string
Moment.js style format string used when a time requiring month accuracy is shown. Example: YYYY-MM.
IntervalSecond string
Moment.js style format string used when a time requiring second accuracy is shown. Example: HH:mm:ss.
IntervalYear string
Moment.js style format string used when a time requiring year accuracy is shown. Example: YYYY.
defaultTimezone String
Default time zone for user preferences. Value browser uses browser local time zone. Example: Europe/Helsinki.
fullDate String
Moment.js style format string for cases where full date is shown. Example: YYYY MM DD.
intervalDay String
Moment.js style format string used when a time requiring day accuracy is shown. Example: MM/DD.
intervalHour String
Moment.js style format string used when a time requiring hour accuracy is shown. Example: MM/DD HH:mm.
intervalMinute String
Moment.js style format string used when a time requiring minute accuracy is shown. Example: HH:mm.
intervalMonth String
Moment.js style format string used when a time requiring month accuracy is shown. Example: YYYY-MM.
intervalSecond String
Moment.js style format string used when a time requiring second accuracy is shown. Example: HH:mm:ss.
intervalYear String
Moment.js style format string used when a time requiring year accuracy is shown. Example: YYYY.
defaultTimezone string
Default time zone for user preferences. Value browser uses browser local time zone. Example: Europe/Helsinki.
fullDate string
Moment.js style format string for cases where full date is shown. Example: YYYY MM DD.
intervalDay string
Moment.js style format string used when a time requiring day accuracy is shown. Example: MM/DD.
intervalHour string
Moment.js style format string used when a time requiring hour accuracy is shown. Example: MM/DD HH:mm.
intervalMinute string
Moment.js style format string used when a time requiring minute accuracy is shown. Example: HH:mm.
intervalMonth string
Moment.js style format string used when a time requiring month accuracy is shown. Example: YYYY-MM.
intervalSecond string
Moment.js style format string used when a time requiring second accuracy is shown. Example: HH:mm:ss.
intervalYear string
Moment.js style format string used when a time requiring year accuracy is shown. Example: YYYY.
default_timezone str
Default time zone for user preferences. Value browser uses browser local time zone. Example: Europe/Helsinki.
full_date str
Moment.js style format string for cases where full date is shown. Example: YYYY MM DD.
interval_day str
Moment.js style format string used when a time requiring day accuracy is shown. Example: MM/DD.
interval_hour str
Moment.js style format string used when a time requiring hour accuracy is shown. Example: MM/DD HH:mm.
interval_minute str
Moment.js style format string used when a time requiring minute accuracy is shown. Example: HH:mm.
interval_month str
Moment.js style format string used when a time requiring month accuracy is shown. Example: YYYY-MM.
interval_second str
Moment.js style format string used when a time requiring second accuracy is shown. Example: HH:mm:ss.
interval_year str
Moment.js style format string used when a time requiring year accuracy is shown. Example: YYYY.
defaultTimezone String
Default time zone for user preferences. Value browser uses browser local time zone. Example: Europe/Helsinki.
fullDate String
Moment.js style format string for cases where full date is shown. Example: YYYY MM DD.
intervalDay String
Moment.js style format string used when a time requiring day accuracy is shown. Example: MM/DD.
intervalHour String
Moment.js style format string used when a time requiring hour accuracy is shown. Example: MM/DD HH:mm.
intervalMinute String
Moment.js style format string used when a time requiring minute accuracy is shown. Example: HH:mm.
intervalMonth String
Moment.js style format string used when a time requiring month accuracy is shown. Example: YYYY-MM.
intervalSecond String
Moment.js style format string used when a time requiring second accuracy is shown. Example: HH:mm:ss.
intervalYear String
Moment.js style format string used when a time requiring year accuracy is shown. Example: YYYY.

GetGrafanaGrafanaUserConfigExternalImageStorage

AccessKey This property is required. string
S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example: AAAAAAAAAAAAAAAAAAA.
BucketUrl This property is required. string
Bucket URL for S3. Example: https://grafana.s3-ap-southeast-2.amazonaws.com/.
Provider This property is required. string
Enum: s3. External image store provider.
SecretKey This property is required. string
S3 secret key. Example: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.
AccessKey This property is required. string
S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example: AAAAAAAAAAAAAAAAAAA.
BucketUrl This property is required. string
Bucket URL for S3. Example: https://grafana.s3-ap-southeast-2.amazonaws.com/.
Provider This property is required. string
Enum: s3. External image store provider.
SecretKey This property is required. string
S3 secret key. Example: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.
accessKey This property is required. String
S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example: AAAAAAAAAAAAAAAAAAA.
bucketUrl This property is required. String
Bucket URL for S3. Example: https://grafana.s3-ap-southeast-2.amazonaws.com/.
provider This property is required. String
Enum: s3. External image store provider.
secretKey This property is required. String
S3 secret key. Example: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.
accessKey This property is required. string
S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example: AAAAAAAAAAAAAAAAAAA.
bucketUrl This property is required. string
Bucket URL for S3. Example: https://grafana.s3-ap-southeast-2.amazonaws.com/.
provider This property is required. string
Enum: s3. External image store provider.
secretKey This property is required. string
S3 secret key. Example: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.
access_key This property is required. str
S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example: AAAAAAAAAAAAAAAAAAA.
bucket_url This property is required. str
Bucket URL for S3. Example: https://grafana.s3-ap-southeast-2.amazonaws.com/.
provider This property is required. str
Enum: s3. External image store provider.
secret_key This property is required. str
S3 secret key. Example: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.
accessKey This property is required. String
S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example: AAAAAAAAAAAAAAAAAAA.
bucketUrl This property is required. String
Bucket URL for S3. Example: https://grafana.s3-ap-southeast-2.amazonaws.com/.
provider This property is required. String
Enum: s3. External image store provider.
secretKey This property is required. String
S3 secret key. Example: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.

GetGrafanaGrafanaUserConfigIpFilterObject

Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.
network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. str
CIDR address block. Example: 10.20.0.0/16.
description str
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.

GetGrafanaGrafanaUserConfigPrivateAccess

Grafana bool
Allow clients to connect to grafana with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Grafana bool
Allow clients to connect to grafana with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
grafana Boolean
Allow clients to connect to grafana with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
grafana boolean
Allow clients to connect to grafana with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
grafana bool
Allow clients to connect to grafana with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
grafana Boolean
Allow clients to connect to grafana with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

GetGrafanaGrafanaUserConfigPrivatelinkAccess

Grafana bool
Enable grafana.
Grafana bool
Enable grafana.
grafana Boolean
Enable grafana.
grafana boolean
Enable grafana.
grafana bool
Enable grafana.
grafana Boolean
Enable grafana.

GetGrafanaGrafanaUserConfigPublicAccess

Grafana bool
Allow clients to connect to grafana from the public internet for service nodes that are in a project VPC or another type of private network.
Grafana bool
Allow clients to connect to grafana from the public internet for service nodes that are in a project VPC or another type of private network.
grafana Boolean
Allow clients to connect to grafana from the public internet for service nodes that are in a project VPC or another type of private network.
grafana boolean
Allow clients to connect to grafana from the public internet for service nodes that are in a project VPC or another type of private network.
grafana bool
Allow clients to connect to grafana from the public internet for service nodes that are in a project VPC or another type of private network.
grafana Boolean
Allow clients to connect to grafana from the public internet for service nodes that are in a project VPC or another type of private network.

GetGrafanaGrafanaUserConfigSmtpServer

FromAddress This property is required. string
Address used for sending emails. Example: yourgrafanauser@yourdomain.example.com.
Host This property is required. string
Server hostname or IP. Example: smtp.example.com.
Port This property is required. int
SMTP server port. Example: 25.
FromName string
Name used in outgoing emails, defaults to Grafana.
Password string
Password for SMTP authentication. Example: ein0eemeev5eeth3Ahfu.
SkipVerify bool
Skip verifying server certificate. Defaults to false.
StarttlsPolicy string
Enum: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.
Username string
Username for SMTP authentication. Example: smtpuser.
FromAddress This property is required. string
Address used for sending emails. Example: yourgrafanauser@yourdomain.example.com.
Host This property is required. string
Server hostname or IP. Example: smtp.example.com.
Port This property is required. int
SMTP server port. Example: 25.
FromName string
Name used in outgoing emails, defaults to Grafana.
Password string
Password for SMTP authentication. Example: ein0eemeev5eeth3Ahfu.
SkipVerify bool
Skip verifying server certificate. Defaults to false.
StarttlsPolicy string
Enum: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.
Username string
Username for SMTP authentication. Example: smtpuser.
fromAddress This property is required. String
Address used for sending emails. Example: yourgrafanauser@yourdomain.example.com.
host This property is required. String
Server hostname or IP. Example: smtp.example.com.
port This property is required. Integer
SMTP server port. Example: 25.
fromName String
Name used in outgoing emails, defaults to Grafana.
password String
Password for SMTP authentication. Example: ein0eemeev5eeth3Ahfu.
skipVerify Boolean
Skip verifying server certificate. Defaults to false.
starttlsPolicy String
Enum: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.
username String
Username for SMTP authentication. Example: smtpuser.
fromAddress This property is required. string
Address used for sending emails. Example: yourgrafanauser@yourdomain.example.com.
host This property is required. string
Server hostname or IP. Example: smtp.example.com.
port This property is required. number
SMTP server port. Example: 25.
fromName string
Name used in outgoing emails, defaults to Grafana.
password string
Password for SMTP authentication. Example: ein0eemeev5eeth3Ahfu.
skipVerify boolean
Skip verifying server certificate. Defaults to false.
starttlsPolicy string
Enum: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.
username string
Username for SMTP authentication. Example: smtpuser.
from_address This property is required. str
Address used for sending emails. Example: yourgrafanauser@yourdomain.example.com.
host This property is required. str
Server hostname or IP. Example: smtp.example.com.
port This property is required. int
SMTP server port. Example: 25.
from_name str
Name used in outgoing emails, defaults to Grafana.
password str
Password for SMTP authentication. Example: ein0eemeev5eeth3Ahfu.
skip_verify bool
Skip verifying server certificate. Defaults to false.
starttls_policy str
Enum: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.
username str
Username for SMTP authentication. Example: smtpuser.
fromAddress This property is required. String
Address used for sending emails. Example: yourgrafanauser@yourdomain.example.com.
host This property is required. String
Server hostname or IP. Example: smtp.example.com.
port This property is required. Number
SMTP server port. Example: 25.
fromName String
Name used in outgoing emails, defaults to Grafana.
password String
Password for SMTP authentication. Example: ein0eemeev5eeth3Ahfu.
skipVerify Boolean
Skip verifying server certificate. Defaults to false.
starttlsPolicy String
Enum: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.
username String
Username for SMTP authentication. Example: smtpuser.

GetGrafanaServiceIntegration

IntegrationType This property is required. string
Type of the service integration
SourceServiceName This property is required. string
Name of the source service
IntegrationType This property is required. string
Type of the service integration
SourceServiceName This property is required. string
Name of the source service
integrationType This property is required. String
Type of the service integration
sourceServiceName This property is required. String
Name of the source service
integrationType This property is required. string
Type of the service integration
sourceServiceName This property is required. string
Name of the source service
integration_type This property is required. str
Type of the service integration
source_service_name This property is required. str
Name of the source service
integrationType This property is required. String
Type of the service integration
sourceServiceName This property is required. String
Name of the source service

GetGrafanaTag

Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value
key This property is required. string
Service tag key
value This property is required. string
Service tag value
key This property is required. str
Service tag key
value This property is required. str
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value

GetGrafanaTechEmail

Email This property is required. string
An email address to contact for technical issues
Email This property is required. string
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues
email This property is required. string
An email address to contact for technical issues
email This property is required. str
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues

Package Details

Repository
Aiven pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi