Aiven v6.27.0 published on Monday, Oct 28, 2024 by Pulumi
aiven.getGrafana
Explore with Pulumi AI
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",
});
import pulumi
import pulumi_aiven as aiven
example_grafana = aiven.get_grafana(project=example_project["project"],
service_name="example-grafana-service")
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
})
}
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",
});
});
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());
}
}
variables:
exampleGrafana:
fn::invoke:
Function: aiven:getGrafana
Arguments:
project: ${exampleProject.project}
serviceName: example-grafana-service
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>
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]
func LookupGrafana(ctx *Context, args *LookupGrafanaArgs, opts ...InvokeOption) (*LookupGrafanaResult, error)
func LookupGrafanaOutput(ctx *Context, args *LookupGrafanaOutputArgs, opts ...InvokeOption) LookupGrafanaResultOutput
> 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)
}
public static CompletableFuture<GetGrafanaResult> getGrafana(GetGrafanaArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aiven:index/getGrafana:getGrafana
arguments:
# arguments dictionary
The following arguments are supported:
- 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.
- Service
Name 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 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.
- Service
Name 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 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.
- service
Name 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 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.
- service
Name 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 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 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 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.
- service
Name 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:
- Additional
Disk stringSpace - 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 with no HA capabilities.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Components
List<Get
Grafana Component> - Service component information objects
- Disk
Space 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.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Grafana
User List<GetConfigs Grafana Grafana User Config> - Grafana user configurable settings
- Grafanas
List<Get
Grafana Grafana> - Values provided by the Grafana server.
- Id string
- The provider-assigned unique ID for this managed resource.
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - 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
andpremium-x
wherex
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.
- Project
Vpc stringId - 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 string - The hostname of the service.
- Service
Integrations List<GetGrafana Service Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips 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
- List<Get
Grafana Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<GetGrafana Tech Email> - 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.
- Additional
Disk stringSpace - 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 with no HA capabilities.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Components
[]Get
Grafana Component - Service component information objects
- Disk
Space 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.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Grafana
User []GetConfigs Grafana Grafana User Config - Grafana user configurable settings
- Grafanas
[]Get
Grafana Grafana - Values provided by the Grafana server.
- Id string
- The provider-assigned unique ID for this managed resource.
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - 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
andpremium-x
wherex
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.
- Project
Vpc stringId - 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 string - The hostname of the service.
- Service
Integrations []GetGrafana Service Integration - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips []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
- []Get
Grafana Tag - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []GetGrafana Tech Email - 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.
- additional
Disk StringSpace - 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 with no HA capabilities.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
List<Get
Grafana Component> - Service component information objects
- disk
Space 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.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- grafana
User List<GetConfigs Grafana Grafana User Config> - Grafana user configurable settings
- grafanas
List<Get
Grafana Grafana> - Values provided by the Grafana server.
- id String
- The provider-assigned unique ID for this managed resource.
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - 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
andpremium-x
wherex
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.
- project
Vpc StringId - 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 String - The hostname of the service.
- service
Integrations List<GetGrafana Service Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Get
Grafana Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<GetGrafana Tech Email> - 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 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 stringSpace - 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 with no HA capabilities.
- cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
Get
Grafana Component[] - Service component information objects
- disk
Space 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.
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- grafana
User GetConfigs Grafana Grafana User Config[] - Grafana user configurable settings
- grafanas
Get
Grafana Grafana[] - Values provided by the Grafana server.
- id string
- The provider-assigned unique ID for this managed resource.
- maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - 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
andpremium-x
wherex
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.
- project
Vpc stringId - 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 string - The hostname of the service.
- service
Integrations GetGrafana Service Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- Get
Grafana Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails GetGrafana Tech Email[] - 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 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_ strspace - 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 with no HA capabilities.
- cloud_
name str - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
Sequence[Get
Grafana Component] - 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_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - 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 fromdisk_space_default
by increments of this size. - disk_
space_ strused - Disk space that service is currently using
- grafana_
user_ Sequence[Getconfigs Grafana Grafana User Config] - Grafana user configurable settings
- grafanas
Sequence[Get
Grafana Grafana] - Values provided by the Grafana server.
- id str
- The provider-assigned unique ID for this managed resource.
- maintenance_
window_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - 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
andpremium-x
wherex
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_ strid - 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[GetGrafana Service Integration] - 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
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- 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
- Sequence[Get
Grafana Tag] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[GetGrafana Tech Email] - 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.
- additional
Disk StringSpace - 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 with no HA capabilities.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components List<Property Map>
- Service component information objects
- disk
Space 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.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- grafana
User List<Property Map>Configs - Grafana user configurable settings
- grafanas List<Property Map>
- Values provided by the Grafana server.
- id String
- The provider-assigned unique ID for this managed resource.
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - 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
andpremium-x
wherex
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.
- project
Vpc StringId - 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 String - The hostname of the service.
- service
Integrations List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection 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 string
- Service component name
- Connection
Uri string - Connection info for connecting to the service component. This is a combination of host and port.
- Host string
- Host name for connecting to the service component
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- Port int
- Port number for connecting to the service component
- Route string
- Network access route
- Ssl 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 string
- DNS usage name
- Component string
- Service component name
- Connection
Uri string - Connection info for connecting to the service component. This is a combination of host and port.
- Host string
- Host name for connecting to the service component
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- Port int
- Port number for connecting to the service component
- Route string
- Network access route
- Ssl 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 string
- DNS usage name
- component String
- Service component name
- connection
Uri String - Connection info for connecting to the service component. This is a combination of host and port.
- host String
- Host name for connecting to the service component
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- port Integer
- Port number for connecting to the service component
- route String
- Network access route
- ssl 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 String
- DNS usage name
- component string
- Service component name
- connection
Uri string - Connection info for connecting to the service component. This is a combination of host and port.
- host string
- Host name for connecting to the service component
- kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- port number
- Port number for connecting to the service component
- route string
- Network access route
- ssl 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 string
- DNS usage name
- component str
- Service component name
- connection_
uri str - Connection info for connecting to the service component. This is a combination of host and port.
- host str
- Host name for connecting to the service component
- kafka_
authentication_ strmethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- port int
- Port number for connecting to the service component
- route str
- Network access route
- ssl 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 str
- DNS usage name
- component String
- Service component name
- connection
Uri String - Connection info for connecting to the service component. This is a combination of host and port.
- host String
- Host name for connecting to the service component
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- port Number
- Port number for connecting to the service component
- route String
- Network access route
- ssl 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 String
- DNS usage name
GetGrafanaGrafana
- Uris List<string>
- Grafana server URIs.
- Uris []string
- Grafana server URIs.
- uris List<String>
- Grafana server URIs.
- uris string[]
- Grafana server URIs.
- uris Sequence[str]
- Grafana server URIs.
- uris List<String>
- Grafana server URIs.
GetGrafanaGrafanaUserConfig
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- Alerting
Enabled bool - Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
- Alerting
Error stringOr Timeout - Enum:
alerting
,keep_state
. Default error or timeout setting for new alerting rules. - Alerting
Max intAnnotations To Keep - Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example:
0
. - Alerting
Nodata stringOr Nullvalues - Enum:
alerting
,no_data
,keep_state
,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 GetGrafana Grafana User Config Auth Azuread - Azure AD OAuth integration
- Auth
Basic boolEnabled - Enable or disable basic authentication form, used by Grafana built-in login.
- Auth
Generic GetOauth Grafana Grafana User Config Auth Generic Oauth - Generic OAuth integration
- Auth
Github GetGrafana Grafana User Config Auth Github - Github Auth integration
- Auth
Gitlab GetGrafana Grafana User Config Auth Gitlab - GitLab Auth integration
- Auth
Google GetGrafana Grafana User Config Auth Google - Google Auth integration
- string
- Enum:
lax
,strict
,none
. 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 string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org
. - Dashboard
Previews boolEnabled - 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.
- Dashboards
Min stringRefresh Interval - Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example:
5s
. - Dashboards
Versions intTo Keep - Dashboard versions to keep per dashboard. Example:
20
. - Dataproxy
Send boolUser Header - Send
X-Grafana-User
header to data source. - Dataproxy
Timeout int - Timeout for data proxy requests in seconds. Example:
30
. - Date
Formats GetGrafana Grafana User Config Date Formats - Grafana date format specifications
- Disable
Gravatar bool - Set to true to disable gravatar. Defaults to false (gravatar is enabled).
- Editors
Can boolAdmin - Editors can manage folders, teams and dashboards created by them.
- External
Image GetStorage Grafana Grafana User Config External Image Storage - External image store settings
- Google
Analytics stringUa Id - Google Analytics ID. Example:
UA-123456-4
. - Ip
Filter List<GetObjects Grafana Grafana User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Ip
Filter List<string>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Ip
Filters List<string> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Metrics
Enabled bool - Enable Grafana /metrics endpoint.
- Oauth
Allow boolInsecure Email Lookup - Enforce user lookup based on email instead of the unique ID provided by the IdP.
- Private
Access GetGrafana Grafana User Config Private Access - Allow access to selected service ports from private networks
- Privatelink
Access GetGrafana Grafana User Config Privatelink Access - Allow access to selected service components through Privatelink
- Project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - Public
Access GetGrafana Grafana User Config Public Access - Allow access to selected service ports from the public Internet
- Recovery
Basebackup stringName - 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 stringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - Smtp
Server GetGrafana Grafana User Config Smtp Server - SMTP server settings
- Static
Ips bool - Use static public IP addresses.
- Unified
Alerting boolEnabled - 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/set-up/migrating-alerts/ for more details.
- User
Auto boolAssign Org - Auto-assign new users on signup to main organization. Defaults to false.
- User
Auto stringAssign Org Role - Enum:
Viewer
,Admin
,Editor
. Set role for new signups. Defaults to Viewer. - Viewers
Can boolEdit - 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).
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- Alerting
Enabled bool - Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
- Alerting
Error stringOr Timeout - Enum:
alerting
,keep_state
. Default error or timeout setting for new alerting rules. - Alerting
Max intAnnotations To Keep - Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example:
0
. - Alerting
Nodata stringOr Nullvalues - Enum:
alerting
,no_data
,keep_state
,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 GetGrafana Grafana User Config Auth Azuread - Azure AD OAuth integration
- Auth
Basic boolEnabled - Enable or disable basic authentication form, used by Grafana built-in login.
- Auth
Generic GetOauth Grafana Grafana User Config Auth Generic Oauth - Generic OAuth integration
- Auth
Github GetGrafana Grafana User Config Auth Github - Github Auth integration
- Auth
Gitlab GetGrafana Grafana User Config Auth Gitlab - GitLab Auth integration
- Auth
Google GetGrafana Grafana User Config Auth Google - Google Auth integration
- string
- Enum:
lax
,strict
,none
. 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 string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org
. - Dashboard
Previews boolEnabled - 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.
- Dashboards
Min stringRefresh Interval - Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example:
5s
. - Dashboards
Versions intTo Keep - Dashboard versions to keep per dashboard. Example:
20
. - Dataproxy
Send boolUser Header - Send
X-Grafana-User
header to data source. - Dataproxy
Timeout int - Timeout for data proxy requests in seconds. Example:
30
. - Date
Formats GetGrafana Grafana User Config Date Formats - Grafana date format specifications
- Disable
Gravatar bool - Set to true to disable gravatar. Defaults to false (gravatar is enabled).
- Editors
Can boolAdmin - Editors can manage folders, teams and dashboards created by them.
- External
Image GetStorage Grafana Grafana User Config External Image Storage - External image store settings
- Google
Analytics stringUa Id - Google Analytics ID. Example:
UA-123456-4
. - Ip
Filter []GetObjects Grafana Grafana User Config Ip Filter Object - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Ip
Filter []stringStrings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Ip
Filters []string - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Metrics
Enabled bool - Enable Grafana /metrics endpoint.
- Oauth
Allow boolInsecure Email Lookup - Enforce user lookup based on email instead of the unique ID provided by the IdP.
- Private
Access GetGrafana Grafana User Config Private Access - Allow access to selected service ports from private networks
- Privatelink
Access GetGrafana Grafana User Config Privatelink Access - Allow access to selected service components through Privatelink
- Project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - Public
Access GetGrafana Grafana User Config Public Access - Allow access to selected service ports from the public Internet
- Recovery
Basebackup stringName - 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 stringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - Smtp
Server GetGrafana Grafana User Config Smtp Server - SMTP server settings
- Static
Ips bool - Use static public IP addresses.
- Unified
Alerting boolEnabled - 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/set-up/migrating-alerts/ for more details.
- User
Auto boolAssign Org - Auto-assign new users on signup to main organization. Defaults to false.
- User
Auto stringAssign Org Role - Enum:
Viewer
,Admin
,Editor
. Set role for new signups. Defaults to Viewer. - Viewers
Can boolEdit - 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).
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- alerting
Enabled Boolean - Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
- alerting
Error StringOr Timeout - Enum:
alerting
,keep_state
. Default error or timeout setting for new alerting rules. - alerting
Max IntegerAnnotations To Keep - Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example:
0
. - alerting
Nodata StringOr Nullvalues - Enum:
alerting
,no_data
,keep_state
,ok
. Default value for 'no data or null values' for new alerting rules. - allow
Embedding Boolean - Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking.
- auth
Azuread GetGrafana Grafana User Config Auth Azuread - Azure AD OAuth integration
- auth
Basic BooleanEnabled - Enable or disable basic authentication form, used by Grafana built-in login.
- auth
Generic GetOauth Grafana Grafana User Config Auth Generic Oauth - Generic OAuth integration
- auth
Github GetGrafana Grafana User Config Auth Github - Github Auth integration
- auth
Gitlab GetGrafana Grafana User Config Auth Gitlab - GitLab Auth integration
- auth
Google GetGrafana Grafana User Config Auth Google - Google Auth integration
- String
- Enum:
lax
,strict
,none
. 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 String - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org
. - dashboard
Previews BooleanEnabled - 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.
- dashboards
Min StringRefresh Interval - Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example:
5s
. - dashboards
Versions IntegerTo Keep - Dashboard versions to keep per dashboard. Example:
20
. - dataproxy
Send BooleanUser Header - Send
X-Grafana-User
header to data source. - dataproxy
Timeout Integer - Timeout for data proxy requests in seconds. Example:
30
. - date
Formats GetGrafana Grafana User Config Date Formats - Grafana date format specifications
- disable
Gravatar Boolean - Set to true to disable gravatar. Defaults to false (gravatar is enabled).
- editors
Can BooleanAdmin - Editors can manage folders, teams and dashboards created by them.
- external
Image GetStorage Grafana Grafana User Config External Image Storage - External image store settings
- google
Analytics StringUa Id - Google Analytics ID. Example:
UA-123456-4
. - ip
Filter List<GetObjects Grafana Grafana User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - metrics
Enabled Boolean - Enable Grafana /metrics endpoint.
- oauth
Allow BooleanInsecure Email Lookup - Enforce user lookup based on email instead of the unique ID provided by the IdP.
- private
Access GetGrafana Grafana User Config Private Access - Allow access to selected service ports from private networks
- privatelink
Access GetGrafana Grafana User Config Privatelink Access - Allow access to selected service components through Privatelink
- project
To StringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access GetGrafana Grafana User Config Public Access - Allow access to selected service ports from the public Internet
- recovery
Basebackup StringName - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z
. - service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To StringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - smtp
Server GetGrafana Grafana User Config Smtp Server - SMTP server settings
- static
Ips Boolean - Use static public IP addresses.
- unified
Alerting BooleanEnabled - 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/set-up/migrating-alerts/ for more details.
- user
Auto BooleanAssign Org - Auto-assign new users on signup to main organization. Defaults to false.
- user
Auto StringAssign Org Role - Enum:
Viewer
,Admin
,Editor
. Set role for new signups. Defaults to Viewer. - viewers
Can BooleanEdit - 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 stringRegions - Additional Cloud Regions for Backup Replication.
- alerting
Enabled boolean - Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
- alerting
Error stringOr Timeout - Enum:
alerting
,keep_state
. Default error or timeout setting for new alerting rules. - alerting
Max numberAnnotations To Keep - Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example:
0
. - alerting
Nodata stringOr Nullvalues - Enum:
alerting
,no_data
,keep_state
,ok
. Default value for 'no data or null values' for new alerting rules. - allow
Embedding boolean - Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking.
- auth
Azuread GetGrafana Grafana User Config Auth Azuread - Azure AD OAuth integration
- auth
Basic booleanEnabled - Enable or disable basic authentication form, used by Grafana built-in login.
- auth
Generic GetOauth Grafana Grafana User Config Auth Generic Oauth - Generic OAuth integration
- auth
Github GetGrafana Grafana User Config Auth Github - Github Auth integration
- auth
Gitlab GetGrafana Grafana User Config Auth Gitlab - GitLab Auth integration
- auth
Google GetGrafana Grafana User Config Auth Google - Google Auth integration
- string
- Enum:
lax
,strict
,none
. 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 string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org
. - dashboard
Previews booleanEnabled - 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.
- dashboards
Min stringRefresh Interval - Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example:
5s
. - dashboards
Versions numberTo Keep - Dashboard versions to keep per dashboard. Example:
20
. - dataproxy
Send booleanUser Header - Send
X-Grafana-User
header to data source. - dataproxy
Timeout number - Timeout for data proxy requests in seconds. Example:
30
. - date
Formats GetGrafana Grafana User Config Date Formats - Grafana date format specifications
- disable
Gravatar boolean - Set to true to disable gravatar. Defaults to false (gravatar is enabled).
- editors
Can booleanAdmin - Editors can manage folders, teams and dashboards created by them.
- external
Image GetStorage Grafana Grafana User Config External Image Storage - External image store settings
- google
Analytics stringUa Id - Google Analytics ID. Example:
UA-123456-4
. - ip
Filter GetObjects Grafana Grafana User Config Ip Filter Object[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter string[]Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters string[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - metrics
Enabled boolean - Enable Grafana /metrics endpoint.
- oauth
Allow booleanInsecure Email Lookup - Enforce user lookup based on email instead of the unique ID provided by the IdP.
- private
Access GetGrafana Grafana User Config Private Access - Allow access to selected service ports from private networks
- privatelink
Access GetGrafana Grafana User Config Privatelink Access - Allow access to selected service components through Privatelink
- project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access GetGrafana Grafana User Config Public Access - Allow access to selected service ports from the public Internet
- recovery
Basebackup stringName - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z
. - service
Log boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To stringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - smtp
Server GetGrafana Grafana User Config Smtp Server - SMTP server settings
- static
Ips boolean - Use static public IP addresses.
- unified
Alerting booleanEnabled - 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/set-up/migrating-alerts/ for more details.
- user
Auto booleanAssign Org - Auto-assign new users on signup to main organization. Defaults to false.
- user
Auto stringAssign Org Role - Enum:
Viewer
,Admin
,Editor
. Set role for new signups. Defaults to Viewer. - viewers
Can booleanEdit - 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_ strregions - Additional Cloud Regions for Backup Replication.
- alerting_
enabled bool - Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
- alerting_
error_ stror_ timeout - Enum:
alerting
,keep_state
. Default error or timeout setting for new alerting rules. - alerting_
max_ intannotations_ to_ keep - Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example:
0
. - alerting_
nodata_ stror_ nullvalues - Enum:
alerting
,no_data
,keep_state
,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 GetGrafana Grafana User Config Auth Azuread - Azure AD OAuth integration
- auth_
basic_ boolenabled - Enable or disable basic authentication form, used by Grafana built-in login.
- auth_
generic_ Getoauth Grafana Grafana User Config Auth Generic Oauth - Generic OAuth integration
- auth_
github GetGrafana Grafana User Config Auth Github - Github Auth integration
- auth_
gitlab GetGrafana Grafana User Config Auth Gitlab - GitLab Auth integration
- auth_
google GetGrafana Grafana User Config Auth Google - Google Auth integration
- str
- Enum:
lax
,strict
,none
. 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_ boolenabled - 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.
- dashboards_
min_ strrefresh_ interval - Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example:
5s
. - dashboards_
versions_ intto_ keep - Dashboard versions to keep per dashboard. Example:
20
. - dataproxy_
send_ booluser_ header - Send
X-Grafana-User
header to data source. - dataproxy_
timeout int - Timeout for data proxy requests in seconds. Example:
30
. - date_
formats GetGrafana Grafana User Config Date Formats - Grafana date format specifications
- disable_
gravatar bool - Set to true to disable gravatar. Defaults to false (gravatar is enabled).
- editors_
can_ booladmin - Editors can manage folders, teams and dashboards created by them.
- external_
image_ Getstorage Grafana Grafana User Config External Image Storage - External image store settings
- google_
analytics_ strua_ id - Google Analytics ID. Example:
UA-123456-4
. - ip_
filter_ Sequence[Getobjects Grafana Grafana User Config Ip Filter Object] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip_
filter_ Sequence[str]strings - 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
. - metrics_
enabled bool - Enable Grafana /metrics endpoint.
- oauth_
allow_ boolinsecure_ email_ lookup - Enforce user lookup based on email instead of the unique ID provided by the IdP.
- private_
access GetGrafana Grafana User Config Private Access - Allow access to selected service ports from private networks
- privatelink_
access GetGrafana Grafana User Config Privatelink Access - Allow access to selected service components through Privatelink
- project_
to_ strfork_ from - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public_
access GetGrafana Grafana User Config Public Access - Allow access to selected service ports from the public Internet
- recovery_
basebackup_ strname - 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_ strfork_ from - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - smtp_
server GetGrafana Grafana User Config Smtp Server - SMTP server settings
- static_
ips bool - Use static public IP addresses.
- unified_
alerting_ boolenabled - 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/set-up/migrating-alerts/ for more details.
- user_
auto_ boolassign_ org - Auto-assign new users on signup to main organization. Defaults to false.
- user_
auto_ strassign_ org_ role - Enum:
Viewer
,Admin
,Editor
. Set role for new signups. Defaults to Viewer. - viewers_
can_ booledit - 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).
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- alerting
Enabled Boolean - Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
- alerting
Error StringOr Timeout - Enum:
alerting
,keep_state
. Default error or timeout setting for new alerting rules. - alerting
Max NumberAnnotations To Keep - Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations. Example:
0
. - alerting
Nodata StringOr Nullvalues - Enum:
alerting
,no_data
,keep_state
,ok
. Default value for 'no data or null values' for new alerting rules. - allow
Embedding Boolean - Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking.
- auth
Azuread Property Map - Azure AD OAuth integration
- auth
Basic BooleanEnabled - Enable or disable basic authentication form, used by Grafana built-in login.
- auth
Generic Property MapOauth - Generic OAuth integration
- auth
Github Property Map - Github Auth integration
- auth
Gitlab Property Map - GitLab Auth integration
- auth
Google Property Map - Google Auth integration
- String
- Enum:
lax
,strict
,none
. 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 String - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org
. - dashboard
Previews BooleanEnabled - 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.
- dashboards
Min StringRefresh Interval - Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h. Example:
5s
. - dashboards
Versions NumberTo Keep - Dashboard versions to keep per dashboard. Example:
20
. - dataproxy
Send BooleanUser Header - Send
X-Grafana-User
header to data source. - dataproxy
Timeout Number - Timeout for data proxy requests in seconds. Example:
30
. - date
Formats Property Map - Grafana date format specifications
- disable
Gravatar Boolean - Set to true to disable gravatar. Defaults to false (gravatar is enabled).
- editors
Can BooleanAdmin - Editors can manage folders, teams and dashboards created by them.
- external
Image Property MapStorage - External image store settings
- google
Analytics StringUa Id - Google Analytics ID. Example:
UA-123456-4
. - ip
Filter List<Property Map>Objects - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - metrics
Enabled Boolean - Enable Grafana /metrics endpoint.
- oauth
Allow BooleanInsecure Email Lookup - Enforce user lookup based on email instead of the unique ID provided by the IdP.
- private
Access Property Map - Allow access to selected service ports from private networks
- privatelink
Access Property Map - Allow access to selected service components through Privatelink
- project
To StringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access Property Map - Allow access to selected service ports from the public Internet
- recovery
Basebackup StringName - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z
. - service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To StringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - smtp
Server Property Map - SMTP server settings
- static
Ips Boolean - Use static public IP addresses.
- unified
Alerting BooleanEnabled - 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/set-up/migrating-alerts/ for more details.
- user
Auto BooleanAssign Org - Auto-assign new users on signup to main organization. Defaults to false.
- user
Auto StringAssign Org Role - Enum:
Viewer
,Admin
,Editor
. Set role for new signups. Defaults to Viewer. - viewers
Can BooleanEdit - 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
- Auth
Url string - Authorization URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize
. - Client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - Client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - Token
Url string - Token URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token
. - Allow
Sign boolUp - Automatically sign-up users on successful sign-in.
- Allowed
Domains List<string> - Allowed domains.
- Allowed
Groups List<string> - Require users to belong to one of given groups.
- Auth
Url string - Authorization URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize
. - Client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - Client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - Token
Url string - Token URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token
. - Allow
Sign boolUp - Automatically sign-up users on successful sign-in.
- Allowed
Domains []string - Allowed domains.
- Allowed
Groups []string - Require users to belong to one of given groups.
- auth
Url String - Authorization URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize
. - client
Id String - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret String - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - token
Url String - Token URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token
. - allow
Sign BooleanUp - Automatically sign-up users on successful sign-in.
- allowed
Domains List<String> - Allowed domains.
- allowed
Groups List<String> - Require users to belong to one of given groups.
- auth
Url string - Authorization URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize
. - client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - token
Url string - Token URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token
. - allow
Sign booleanUp - Automatically sign-up users on successful sign-in.
- allowed
Domains string[] - Allowed domains.
- allowed
Groups string[] - Require users to belong to one of given groups.
- auth_
url str - Authorization URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize
. - client_
id str - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client_
secret str - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - token_
url str - Token URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token
. - allow_
sign_ boolup - 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.
- auth
Url String - Authorization URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize
. - client
Id String - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret String - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - token
Url String - Token URL. Example:
https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token
. - allow
Sign BooleanUp - Automatically sign-up users on successful sign-in.
- allowed
Domains List<String> - Allowed domains.
- allowed
Groups List<String> - Require users to belong to one of given groups.
GetGrafanaGrafanaUserConfigAuthGenericOauth
- Api
Url string - API URL. Example:
https://yourprovider.com/api
. - Auth
Url string - Authorization URL. Example:
https://yourprovider.com/oauth/authorize
. - Client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - Client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - Token
Url string - Token URL. Example:
https://yourprovider.com/oauth/token
. - Allow
Sign boolUp - Automatically sign-up users on successful sign-in.
- Allowed
Domains List<string> - Allowed domains.
- Allowed
Organizations List<string> - 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 string
- Name of the OAuth integration. Example:
My authentication
. - Scopes List<string>
- OAuth scopes.
- Use
Refresh boolToken - Set to true to use refresh token and check access token expiration.
- Api
Url string - API URL. Example:
https://yourprovider.com/api
. - Auth
Url string - Authorization URL. Example:
https://yourprovider.com/oauth/authorize
. - Client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - Client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - Token
Url string - Token URL. Example:
https://yourprovider.com/oauth/token
. - Allow
Sign boolUp - Automatically sign-up users on successful sign-in.
- Allowed
Domains []string - Allowed domains.
- Allowed
Organizations []string - 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 string
- Name of the OAuth integration. Example:
My authentication
. - Scopes []string
- OAuth scopes.
- Use
Refresh boolToken - Set to true to use refresh token and check access token expiration.
- api
Url String - API URL. Example:
https://yourprovider.com/api
. - auth
Url String - Authorization URL. Example:
https://yourprovider.com/oauth/authorize
. - client
Id String - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret String - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - token
Url String - Token URL. Example:
https://yourprovider.com/oauth/token
. - allow
Sign BooleanUp - Automatically sign-up users on successful sign-in.
- allowed
Domains List<String> - Allowed domains.
- allowed
Organizations List<String> - Require user to be member of one of the listed organizations.
- auto
Login 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.
- use
Refresh BooleanToken - Set to true to use refresh token and check access token expiration.
- api
Url string - API URL. Example:
https://yourprovider.com/api
. - auth
Url string - Authorization URL. Example:
https://yourprovider.com/oauth/authorize
. - client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - token
Url string - Token URL. Example:
https://yourprovider.com/oauth/token
. - allow
Sign booleanUp - Automatically sign-up users on successful sign-in.
- allowed
Domains string[] - Allowed domains.
- allowed
Organizations string[] - Require user to be member of one of the listed organizations.
- auto
Login 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.
- use
Refresh booleanToken - Set to true to use refresh token and check access token expiration.
- api_
url str - API URL. Example:
https://yourprovider.com/api
. - auth_
url str - Authorization URL. Example:
https://yourprovider.com/oauth/authorize
. - client_
id str - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client_
secret str - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - token_
url str - Token URL. Example:
https://yourprovider.com/oauth/token
. - allow_
sign_ boolup - 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_ booltoken - Set to true to use refresh token and check access token expiration.
- api
Url String - API URL. Example:
https://yourprovider.com/api
. - auth
Url String - Authorization URL. Example:
https://yourprovider.com/oauth/authorize
. - client
Id String - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret String - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - token
Url String - Token URL. Example:
https://yourprovider.com/oauth/token
. - allow
Sign BooleanUp - Automatically sign-up users on successful sign-in.
- allowed
Domains List<String> - Allowed domains.
- allowed
Organizations List<String> - Require user to be member of one of the listed organizations.
- auto
Login 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.
- use
Refresh BooleanToken - Set to true to use refresh token and check access token expiration.
GetGrafanaGrafanaUserConfigAuthGithub
- Client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - Client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - Allow
Sign boolUp - Automatically sign-up users on successful sign-in.
- Allowed
Organizations List<string> - 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 boolRole Sync - Stop automatically syncing user roles.
- Team
Ids List<int> - Require users to belong to one of given team IDs.
- Client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - Client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - Allow
Sign boolUp - Automatically sign-up users on successful sign-in.
- Allowed
Organizations []string - 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 boolRole Sync - Stop automatically syncing user roles.
- Team
Ids []int - Require users to belong to one of given team IDs.
- client
Id String - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret String - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow
Sign BooleanUp - Automatically sign-up users on successful sign-in.
- allowed
Organizations List<String> - Require users to belong to one of given organizations.
- auto
Login Boolean - Allow users to bypass the login screen and automatically log in.
- skip
Org BooleanRole Sync - Stop automatically syncing user roles.
- team
Ids List<Integer> - Require users to belong to one of given team IDs.
- client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow
Sign booleanUp - Automatically sign-up users on successful sign-in.
- allowed
Organizations string[] - Require users to belong to one of given organizations.
- auto
Login boolean - Allow users to bypass the login screen and automatically log in.
- skip
Org booleanRole Sync - Stop automatically syncing user roles.
- team
Ids number[] - Require users to belong to one of given team IDs.
- client_
id str - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client_
secret str - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow_
sign_ boolup - 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_ boolrole_ sync - Stop automatically syncing user roles.
- team_
ids Sequence[int] - Require users to belong to one of given team IDs.
- client
Id String - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret String - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow
Sign BooleanUp - Automatically sign-up users on successful sign-in.
- allowed
Organizations List<String> - Require users to belong to one of given organizations.
- auto
Login Boolean - Allow users to bypass the login screen and automatically log in.
- skip
Org BooleanRole Sync - Stop automatically syncing user roles.
- team
Ids List<Number> - Require users to belong to one of given team IDs.
GetGrafanaGrafanaUserConfigAuthGitlab
- Allowed
Groups List<string> - Require users to belong to one of given groups.
- Client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - Client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - Allow
Sign boolUp - Automatically sign-up users on successful sign-in.
- Api
Url string - API URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/api/v4
. - Auth
Url string - Authorization URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/authorize
. - Token
Url string - Token URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/token
.
- Allowed
Groups []string - Require users to belong to one of given groups.
- Client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - Client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - Allow
Sign boolUp - Automatically sign-up users on successful sign-in.
- Api
Url string - API URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/api/v4
. - Auth
Url string - Authorization URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/authorize
. - Token
Url string - Token URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/token
.
- allowed
Groups List<String> - Require users to belong to one of given groups.
- client
Id String - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret String - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow
Sign BooleanUp - Automatically sign-up users on successful sign-in.
- api
Url String - API URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/api/v4
. - auth
Url String - Authorization URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/authorize
. - token
Url String - Token URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/token
.
- allowed
Groups string[] - Require users to belong to one of given groups.
- client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow
Sign booleanUp - Automatically sign-up users on successful sign-in.
- api
Url string - API URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/api/v4
. - auth
Url string - Authorization URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/authorize
. - token
Url string - Token URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/token
.
- allowed_
groups Sequence[str] - Require users to belong to one of given groups.
- client_
id str - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client_
secret str - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow_
sign_ boolup - Automatically sign-up users on successful sign-in.
- api_
url str - API URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/api/v4
. - auth_
url str - Authorization URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/authorize
. - token_
url str - Token URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/token
.
- allowed
Groups List<String> - Require users to belong to one of given groups.
- client
Id String - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret String - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow
Sign BooleanUp - Automatically sign-up users on successful sign-in.
- api
Url String - API URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/api/v4
. - auth
Url String - Authorization URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/authorize
. - token
Url String - Token URL. This only needs to be set when using self hosted GitLab. Example:
https://gitlab.com/oauth/token
.
GetGrafanaGrafanaUserConfigAuthGoogle
- Allowed
Domains List<string> - Domains allowed to sign-in to this Grafana.
- Client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - Client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - Allow
Sign boolUp - Automatically sign-up users on successful sign-in.
- Allowed
Domains []string - Domains allowed to sign-in to this Grafana.
- Client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - Client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - Allow
Sign boolUp - Automatically sign-up users on successful sign-in.
- allowed
Domains List<String> - Domains allowed to sign-in to this Grafana.
- client
Id String - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret String - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow
Sign BooleanUp - Automatically sign-up users on successful sign-in.
- allowed
Domains string[] - Domains allowed to sign-in to this Grafana.
- client
Id string - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret string - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow
Sign booleanUp - Automatically sign-up users on successful sign-in.
- allowed_
domains Sequence[str] - Domains allowed to sign-in to this Grafana.
- client_
id str - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client_
secret str - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow_
sign_ boolup - Automatically sign-up users on successful sign-in.
- allowed
Domains List<String> - Domains allowed to sign-in to this Grafana.
- client
Id String - Client ID from provider. Example:
b1ba0bf54a4c2c0a1c29
. - client
Secret String - Client secret from provider. Example:
bfa6gea4f129076761dcba8ce5e1e406bd83af7b
. - allow
Sign BooleanUp - Automatically sign-up users on successful sign-in.
GetGrafanaGrafanaUserConfigDateFormats
- Default
Timezone string - Default time zone for user preferences. Value
browser
uses browser local time zone. Example:Europe/Helsinki
. - Full
Date string - Moment.js style format string for cases where full date is shown. Example:
YYYY MM DD
. - Interval
Day string - Moment.js style format string used when a time requiring day accuracy is shown. Example:
MM/DD
. - Interval
Hour string - Moment.js style format string used when a time requiring hour accuracy is shown. Example:
MM/DD HH:mm
. - Interval
Minute string - Moment.js style format string used when a time requiring minute accuracy is shown. Example:
HH:mm
. - Interval
Month string - Moment.js style format string used when a time requiring month accuracy is shown. Example:
YYYY-MM
. - Interval
Second string - Moment.js style format string used when a time requiring second accuracy is shown. Example:
HH:mm:ss
. - Interval
Year string - Moment.js style format string used when a time requiring year accuracy is shown. Example:
YYYY
.
- Default
Timezone string - Default time zone for user preferences. Value
browser
uses browser local time zone. Example:Europe/Helsinki
. - Full
Date string - Moment.js style format string for cases where full date is shown. Example:
YYYY MM DD
. - Interval
Day string - Moment.js style format string used when a time requiring day accuracy is shown. Example:
MM/DD
. - Interval
Hour string - Moment.js style format string used when a time requiring hour accuracy is shown. Example:
MM/DD HH:mm
. - Interval
Minute string - Moment.js style format string used when a time requiring minute accuracy is shown. Example:
HH:mm
. - Interval
Month string - Moment.js style format string used when a time requiring month accuracy is shown. Example:
YYYY-MM
. - Interval
Second string - Moment.js style format string used when a time requiring second accuracy is shown. Example:
HH:mm:ss
. - Interval
Year string - Moment.js style format string used when a time requiring year accuracy is shown. Example:
YYYY
.
- default
Timezone String - Default time zone for user preferences. Value
browser
uses browser local time zone. Example:Europe/Helsinki
. - full
Date String - Moment.js style format string for cases where full date is shown. Example:
YYYY MM DD
. - interval
Day String - Moment.js style format string used when a time requiring day accuracy is shown. Example:
MM/DD
. - interval
Hour String - Moment.js style format string used when a time requiring hour accuracy is shown. Example:
MM/DD HH:mm
. - interval
Minute String - Moment.js style format string used when a time requiring minute accuracy is shown. Example:
HH:mm
. - interval
Month String - Moment.js style format string used when a time requiring month accuracy is shown. Example:
YYYY-MM
. - interval
Second String - Moment.js style format string used when a time requiring second accuracy is shown. Example:
HH:mm:ss
. - interval
Year String - Moment.js style format string used when a time requiring year accuracy is shown. Example:
YYYY
.
- default
Timezone string - Default time zone for user preferences. Value
browser
uses browser local time zone. Example:Europe/Helsinki
. - full
Date string - Moment.js style format string for cases where full date is shown. Example:
YYYY MM DD
. - interval
Day string - Moment.js style format string used when a time requiring day accuracy is shown. Example:
MM/DD
. - interval
Hour string - Moment.js style format string used when a time requiring hour accuracy is shown. Example:
MM/DD HH:mm
. - interval
Minute string - Moment.js style format string used when a time requiring minute accuracy is shown. Example:
HH:mm
. - interval
Month string - Moment.js style format string used when a time requiring month accuracy is shown. Example:
YYYY-MM
. - interval
Second string - Moment.js style format string used when a time requiring second accuracy is shown. Example:
HH:mm:ss
. - interval
Year 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
.
- default
Timezone String - Default time zone for user preferences. Value
browser
uses browser local time zone. Example:Europe/Helsinki
. - full
Date String - Moment.js style format string for cases where full date is shown. Example:
YYYY MM DD
. - interval
Day String - Moment.js style format string used when a time requiring day accuracy is shown. Example:
MM/DD
. - interval
Hour String - Moment.js style format string used when a time requiring hour accuracy is shown. Example:
MM/DD HH:mm
. - interval
Minute String - Moment.js style format string used when a time requiring minute accuracy is shown. Example:
HH:mm
. - interval
Month String - Moment.js style format string used when a time requiring month accuracy is shown. Example:
YYYY-MM
. - interval
Second String - Moment.js style format string used when a time requiring second accuracy is shown. Example:
HH:mm:ss
. - interval
Year String - Moment.js style format string used when a time requiring year accuracy is shown. Example:
YYYY
.
GetGrafanaGrafanaUserConfigExternalImageStorage
- Access
Key string - S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example:
AAAAAAAAAAAAAAAAAAA
. - Bucket
Url string - Bucket URL for S3. Example:
https://grafana.s3-ap-southeast-2.amazonaws.com/
. - Provider string
- Enum:
s3
. Provider type. - Secret
Key string - S3 secret key. Example:
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
.
- Access
Key string - S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example:
AAAAAAAAAAAAAAAAAAA
. - Bucket
Url string - Bucket URL for S3. Example:
https://grafana.s3-ap-southeast-2.amazonaws.com/
. - Provider string
- Enum:
s3
. Provider type. - Secret
Key string - S3 secret key. Example:
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
.
- access
Key String - S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example:
AAAAAAAAAAAAAAAAAAA
. - bucket
Url String - Bucket URL for S3. Example:
https://grafana.s3-ap-southeast-2.amazonaws.com/
. - provider String
- Enum:
s3
. Provider type. - secret
Key String - S3 secret key. Example:
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
.
- access
Key string - S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example:
AAAAAAAAAAAAAAAAAAA
. - bucket
Url string - Bucket URL for S3. Example:
https://grafana.s3-ap-southeast-2.amazonaws.com/
. - provider string
- Enum:
s3
. Provider type. - secret
Key string - S3 secret key. Example:
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
.
- access_
key str - S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example:
AAAAAAAAAAAAAAAAAAA
. - bucket_
url str - Bucket URL for S3. Example:
https://grafana.s3-ap-southeast-2.amazonaws.com/
. - provider str
- Enum:
s3
. Provider type. - secret_
key str - S3 secret key. Example:
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
.
- access
Key String - S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions. Example:
AAAAAAAAAAAAAAAAAAA
. - bucket
Url String - Bucket URL for S3. Example:
https://grafana.s3-ap-southeast-2.amazonaws.com/
. - provider String
- Enum:
s3
. Provider type. - secret
Key String - S3 secret key. Example:
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
.
GetGrafanaGrafanaUserConfigIpFilterObject
- Network string
- CIDR address block. Example:
10.20.0.0/16
. - Description string
- Description for IP filter list entry. Example:
Production service IP range
.
- Network string
- CIDR address block. Example:
10.20.0.0/16
. - Description string
- Description for IP filter list entry. Example:
Production service IP range
.
- network String
- CIDR address block. Example:
10.20.0.0/16
. - description String
- Description for IP filter list entry. Example:
Production service IP range
.
- network string
- CIDR address block. Example:
10.20.0.0/16
. - description string
- Description for IP filter list entry. Example:
Production service IP range
.
- network str
- CIDR address block. Example:
10.20.0.0/16
. - description str
- Description for IP filter list entry. Example:
Production service IP range
.
- network 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
- From
Address string - Address used for sending emails. Example:
yourgrafanauser@yourdomain.example.com
. - Host string
- Server hostname or IP. Example:
smtp.example.com
. - Port int
- SMTP server port. Example:
25
. - From
Name string - Name used in outgoing emails, defaults to Grafana.
- Password string
- Password for SMTP authentication. Example:
ein0eemeev5eeth3Ahfu
. - Skip
Verify bool - Skip verifying server certificate. Defaults to false.
- Starttls
Policy string - Enum:
OpportunisticStartTLS
,MandatoryStartTLS
,NoStartTLS
. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS. - Username string
- Username for SMTP authentication. Example:
smtpuser
.
- From
Address string - Address used for sending emails. Example:
yourgrafanauser@yourdomain.example.com
. - Host string
- Server hostname or IP. Example:
smtp.example.com
. - Port int
- SMTP server port. Example:
25
. - From
Name string - Name used in outgoing emails, defaults to Grafana.
- Password string
- Password for SMTP authentication. Example:
ein0eemeev5eeth3Ahfu
. - Skip
Verify bool - Skip verifying server certificate. Defaults to false.
- Starttls
Policy string - Enum:
OpportunisticStartTLS
,MandatoryStartTLS
,NoStartTLS
. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS. - Username string
- Username for SMTP authentication. Example:
smtpuser
.
- from
Address String - Address used for sending emails. Example:
yourgrafanauser@yourdomain.example.com
. - host String
- Server hostname or IP. Example:
smtp.example.com
. - port Integer
- SMTP server port. Example:
25
. - from
Name String - Name used in outgoing emails, defaults to Grafana.
- password String
- Password for SMTP authentication. Example:
ein0eemeev5eeth3Ahfu
. - skip
Verify Boolean - Skip verifying server certificate. Defaults to false.
- starttls
Policy String - Enum:
OpportunisticStartTLS
,MandatoryStartTLS
,NoStartTLS
. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS. - username String
- Username for SMTP authentication. Example:
smtpuser
.
- from
Address string - Address used for sending emails. Example:
yourgrafanauser@yourdomain.example.com
. - host string
- Server hostname or IP. Example:
smtp.example.com
. - port number
- SMTP server port. Example:
25
. - from
Name string - Name used in outgoing emails, defaults to Grafana.
- password string
- Password for SMTP authentication. Example:
ein0eemeev5eeth3Ahfu
. - skip
Verify boolean - Skip verifying server certificate. Defaults to false.
- starttls
Policy string - Enum:
OpportunisticStartTLS
,MandatoryStartTLS
,NoStartTLS
. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS. - username string
- Username for SMTP authentication. Example:
smtpuser
.
- from_
address str - Address used for sending emails. Example:
yourgrafanauser@yourdomain.example.com
. - host str
- Server hostname or IP. Example:
smtp.example.com
. - port 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:
OpportunisticStartTLS
,MandatoryStartTLS
,NoStartTLS
. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS. - username str
- Username for SMTP authentication. Example:
smtpuser
.
- from
Address String - Address used for sending emails. Example:
yourgrafanauser@yourdomain.example.com
. - host String
- Server hostname or IP. Example:
smtp.example.com
. - port Number
- SMTP server port. Example:
25
. - from
Name String - Name used in outgoing emails, defaults to Grafana.
- password String
- Password for SMTP authentication. Example:
ein0eemeev5eeth3Ahfu
. - skip
Verify Boolean - Skip verifying server certificate. Defaults to false.
- starttls
Policy String - Enum:
OpportunisticStartTLS
,MandatoryStartTLS
,NoStartTLS
. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS. - username String
- Username for SMTP authentication. Example:
smtpuser
.
GetGrafanaServiceIntegration
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- Source
Service stringName - Name of the source service
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- Source
Service stringName - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service StringName - Name of the source service
- integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service stringName - Name of the source service
- integration_
type str - Type of the service integration. The only supported value at the moment is
read_replica
- source_
service_ strname - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service StringName - Name of the source service
GetGrafanaTag
GetGrafanaTechEmail
- Email string
- An email address to contact for technical issues
- Email string
- An email address to contact for technical issues
- email String
- An email address to contact for technical issues
- email string
- An email address to contact for technical issues
- email str
- An email address to contact for technical issues
- email 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.