Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Grafana

# Grafana Resource

The Grafana resource allows the creation and management of Aiven Grafana services.

Example Usage

using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var gr1 = new Aiven.Grafana("gr1", new Aiven.GrafanaArgs
        {
            Project = data.Aiven_project.Ps1.Project,
            CloudName = "google-europe-west1",
            Plan = "startup-1",
            ServiceName = "my-gr1",
            MaintenanceWindowDow = "monday",
            MaintenanceWindowTime = "10:00:00",
            GrafanaUserConfig = new Aiven.Inputs.GrafanaGrafanaUserConfigArgs
            {
                AlertingEnabled = "true",
                PublicAccess = new Aiven.Inputs.GrafanaGrafanaUserConfigPublicAccessArgs
                {
                    Grafana = "true",
                },
            },
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := aiven.NewGrafana(ctx, "gr1", &aiven.GrafanaArgs{
            Project:               pulumi.Any(data.Aiven_project.Ps1.Project),
            CloudName:             pulumi.String("google-europe-west1"),
            Plan:                  pulumi.String("startup-1"),
            ServiceName:           pulumi.String("my-gr1"),
            MaintenanceWindowDow:  pulumi.String("monday"),
            MaintenanceWindowTime: pulumi.String("10:00:00"),
            GrafanaUserConfig: &aiven.GrafanaGrafanaUserConfigArgs{
                AlertingEnabled: pulumi.String("true"),
                PublicAccess: &aiven.GrafanaGrafanaUserConfigPublicAccessArgs{
                    Grafana: pulumi.String("true"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aiven as aiven

gr1 = aiven.Grafana("gr1",
    project=data["aiven_project"]["ps1"]["project"],
    cloud_name="google-europe-west1",
    plan="startup-1",
    service_name="my-gr1",
    maintenance_window_dow="monday",
    maintenance_window_time="10:00:00",
    grafana_user_config=aiven.GrafanaGrafanaUserConfigArgs(
        alerting_enabled="true",
        public_access=aiven.GrafanaGrafanaUserConfigPublicAccessArgs(
            grafana="true",
        ),
    ))
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const gr1 = new aiven.Grafana("gr1", {
    project: data.aiven_project.ps1.project,
    cloudName: "google-europe-west1",
    plan: "startup-1",
    serviceName: "my-gr1",
    maintenanceWindowDow: "monday",
    maintenanceWindowTime: "10:00:00",
    grafanaUserConfig: {
        alertingEnabled: true,
        publicAccess: {
            grafana: true,
        },
    },
});

Create a Grafana Resource

new Grafana(name: string, args: GrafanaArgs, opts?: CustomResourceOptions);
def Grafana(resource_name: str, opts: Optional[ResourceOptions] = None, cloud_name: Optional[str] = None, grafana: Optional[GrafanaGrafanaArgs] = None, grafana_user_config: Optional[GrafanaGrafanaUserConfigArgs] = None, maintenance_window_dow: Optional[str] = None, maintenance_window_time: Optional[str] = None, plan: Optional[str] = None, project: Optional[str] = None, project_vpc_id: Optional[str] = None, service_integrations: Optional[Sequence[GrafanaServiceIntegrationArgs]] = None, service_name: Optional[str] = None, termination_protection: Optional[bool] = None)
func NewGrafana(ctx *Context, name string, args GrafanaArgs, opts ...ResourceOption) (*Grafana, error)
public Grafana(string name, GrafanaArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GrafanaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args GrafanaArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GrafanaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Grafana Resource Properties

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

Inputs

The Grafana resource accepts the following input properties:

Project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

ServiceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

CloudName 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.

GrafanaServer GrafanaGrafanaArgs

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.

GrafanaUserConfig GrafanaGrafanaUserConfigArgs

defines Grafana specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

ProjectVpcId string

optionally 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 as shown above 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.

ServiceIntegrations List<GrafanaServiceIntegrationArgs>

Service integrations to specify when creating a service. Not applied after initial service creation

TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

ServiceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

CloudName 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.

Grafana GrafanaGrafana

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.

GrafanaUserConfig GrafanaGrafanaUserConfig

defines Grafana specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

ProjectVpcId string

optionally 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 as shown above 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.

ServiceIntegrations []GrafanaServiceIntegration

Service integrations to specify when creating a service. Not applied after initial service creation

TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

serviceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

cloudName 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.

grafana GrafanaGrafana

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.

grafanaUserConfig GrafanaGrafanaUserConfig

defines Grafana specific additional configuration options. The following configuration options available:

maintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

projectVpcId string

optionally 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 as shown above 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.

serviceIntegrations GrafanaServiceIntegration[]

Service integrations to specify when creating a service. Not applied after initial service creation

terminationProtection boolean

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

project str

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

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.

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.

grafana GrafanaGrafanaArgs

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_user_config GrafanaGrafanaUserConfigArgs

defines Grafana specific additional configuration options. The following configuration options available:

maintenance_window_dow str

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenance_window_time str

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan str

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

project_vpc_id str

optionally 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 as shown above 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_integrations Sequence[GrafanaServiceIntegrationArgs]

Service integrations to specify when creating a service. Not applied after initial service creation

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.

Outputs

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

Components List<GrafanaComponent>

Service component information objects

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string

Grafana hostname.

ServicePassword string

Password used for connecting to the Grafana service, if applicable.

ServicePort int

Grafana port.

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the Grafana service.

ServiceUsername string

Username used for connecting to the Grafana service, if applicable.

State string

Service state.

Components []GrafanaComponent

Service component information objects

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string

Grafana hostname.

ServicePassword string

Password used for connecting to the Grafana service, if applicable.

ServicePort int

Grafana port.

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the Grafana service.

ServiceUsername string

Username used for connecting to the Grafana service, if applicable.

State string

Service state.

components GrafanaComponent[]

Service component information objects

id string
The provider-assigned unique ID for this managed resource.
serviceHost string

Grafana hostname.

servicePassword string

Password used for connecting to the Grafana service, if applicable.

servicePort number

Grafana port.

serviceType string

Aiven internal service type code

serviceUri string

URI for connecting to the Grafana service.

serviceUsername string

Username used for connecting to the Grafana service, if applicable.

state string

Service state.

components Sequence[GrafanaComponent]

Service component information objects

id str
The provider-assigned unique ID for this managed resource.
service_host str

Grafana hostname.

service_password str

Password used for connecting to the Grafana service, if applicable.

service_port int

Grafana port.

service_type str

Aiven internal service type code

service_uri str

URI for connecting to the Grafana service.

service_username str

Username used for connecting to the Grafana service, if applicable.

state str

Service state.

Look up an Existing Grafana Resource

Get an existing Grafana resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GrafanaState, opts?: CustomResourceOptions): Grafana
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, cloud_name: Optional[str] = None, components: Optional[Sequence[GrafanaComponentArgs]] = None, grafana: Optional[GrafanaGrafanaArgs] = None, grafana_user_config: Optional[GrafanaGrafanaUserConfigArgs] = None, maintenance_window_dow: Optional[str] = None, maintenance_window_time: Optional[str] = None, plan: Optional[str] = None, project: Optional[str] = None, project_vpc_id: Optional[str] = None, service_host: Optional[str] = None, service_integrations: Optional[Sequence[GrafanaServiceIntegrationArgs]] = None, service_name: Optional[str] = None, service_password: Optional[str] = None, service_port: Optional[int] = None, service_type: Optional[str] = None, service_uri: Optional[str] = None, service_username: Optional[str] = None, state: Optional[str] = None, termination_protection: Optional[bool] = None) -> Grafana
func GetGrafana(ctx *Context, name string, id IDInput, state *GrafanaState, opts ...ResourceOption) (*Grafana, error)
public static Grafana Get(string name, Input<string> id, GrafanaState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

CloudName 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<GrafanaComponentArgs>

Service component information objects

GrafanaServer GrafanaGrafanaArgs

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.

GrafanaUserConfig GrafanaGrafanaUserConfigArgs

defines Grafana specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

Project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

ProjectVpcId string

optionally 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 as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceHost string

Grafana hostname.

ServiceIntegrations List<GrafanaServiceIntegrationArgs>

Service integrations to specify when creating a service. Not applied after initial service creation

ServiceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

ServicePassword string

Password used for connecting to the Grafana service, if applicable.

ServicePort int

Grafana port.

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the Grafana service.

ServiceUsername string

Username used for connecting to the Grafana service, if applicable.

State string

Service state.

TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

CloudName 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 []GrafanaComponent

Service component information objects

Grafana GrafanaGrafana

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.

GrafanaUserConfig GrafanaGrafanaUserConfig

defines Grafana specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

Project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

ProjectVpcId string

optionally 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 as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceHost string

Grafana hostname.

ServiceIntegrations []GrafanaServiceIntegration

Service integrations to specify when creating a service. Not applied after initial service creation

ServiceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

ServicePassword string

Password used for connecting to the Grafana service, if applicable.

ServicePort int

Grafana port.

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the Grafana service.

ServiceUsername string

Username used for connecting to the Grafana service, if applicable.

State string

Service state.

TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

cloudName 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 GrafanaComponent[]

Service component information objects

grafana GrafanaGrafana

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.

grafanaUserConfig GrafanaGrafanaUserConfig

defines Grafana specific additional configuration options. The following configuration options available:

maintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

projectVpcId string

optionally 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 as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

serviceHost string

Grafana hostname.

serviceIntegrations GrafanaServiceIntegration[]

Service integrations to specify when creating a service. Not applied after initial service creation

serviceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

servicePassword string

Password used for connecting to the Grafana service, if applicable.

servicePort number

Grafana port.

serviceType string

Aiven internal service type code

serviceUri string

URI for connecting to the Grafana service.

serviceUsername string

Username used for connecting to the Grafana service, if applicable.

state string

Service state.

terminationProtection boolean

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

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[GrafanaComponentArgs]

Service component information objects

grafana GrafanaGrafanaArgs

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_user_config GrafanaGrafanaUserConfigArgs

defines Grafana specific additional configuration options. The following configuration options available:

maintenance_window_dow str

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenance_window_time str

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan str

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

project str

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

project_vpc_id str

optionally 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 as shown above 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

Grafana hostname.

service_integrations Sequence[GrafanaServiceIntegrationArgs]

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 Grafana service, if applicable.

service_port int

Grafana port.

service_type str

Aiven internal service type code

service_uri str

URI for connecting to the Grafana service.

service_username str

Username used for connecting to the Grafana service, if applicable.

state str

Service state.

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.

Supporting Types

GrafanaComponent

Component string
Host string

Server hostname or IP

KafkaAuthenticationMethod string
Port int

SMTP server port

Route string
Ssl bool
Usage string
Component string
Host string

Server hostname or IP

KafkaAuthenticationMethod string
Port int

SMTP server port

Route string
Ssl bool
Usage string
component string
host string

Server hostname or IP

kafkaAuthenticationMethod string
port number

SMTP server port

route string
ssl boolean
usage string
component str
host str

Server hostname or IP

kafka_authentication_method str
port int

SMTP server port

route str
ssl bool
usage str

GrafanaGrafanaUserConfig

AlertingEnabled string

Enable or disable Grafana alerting functionality

AlertingErrorOrTimeout string

Default error or timeout setting for new alerting rules

AlertingNodataOrNullvalues string

Default value for ‘no data or null values’ for new alerting rules

AllowEmbedding string

Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking

AuthBasicEnabled string

Enable or disable basic authentication form, used by Grafana built-in login.

AuthGenericOauth GrafanaGrafanaUserConfigAuthGenericOauthArgs

Generic OAuth integration.

AuthGithub GrafanaGrafanaUserConfigAuthGithubArgs

Automatically sign-up users on successful sign-in

AuthGitlab GrafanaGrafanaUserConfigAuthGitlabArgs

GitLab Auth integration.

AuthGoogle GrafanaGrafanaUserConfigAuthGoogleArgs

Google Auth integration

CookieSamesite string

Cookie SameSite attribute: ‘strict’ prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. ‘lax’ is the default value.

CustomDomain string

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

DashboardsVersionsToKeep string

Dashboard versions to keep per dashboard.

DataproxySendUserHeader string

Send ‘X-Grafana-User’ header to data source.

DataproxyTimeout string

Timeout for data proxy requests in seconds.

DisableGravatar string

Set to true to disable gravatar. Defaults to false (gravatar is enabled).

EditorsCanAdmin string

Editors can manage folders, teams and dashboards created by them.

ExternalImageStorage GrafanaGrafanaUserConfigExternalImageStorageArgs

External image store settings

GoogleAnalyticsUaId string

Google Analytics Universal Analytics ID for tracking Grafana usage

IpFilters List<string>

Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’

MetricsEnabled string

Enable Grafana /metrics endpoint

PrivateAccess GrafanaGrafanaUserConfigPrivateAccessArgs
ProjectToForkFrom string

Name of another project to fork a service from. This has effect only when a new service is being created.

PublicAccess GrafanaGrafanaUserConfigPublicAccessArgs

Allow access to selected service ports from the public Internet.

RecoveryBasebackupName string

Name of the basebackup to restore in forked service.

ServiceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created.

SmtpServer GrafanaGrafanaUserConfigSmtpServerArgs

SMTP server settings.

UserAutoAssignOrg string

Auto-assign new users on signup to main organization. Defaults to false.

UserAutoAssignOrgRole string

Set role for new signups. Defaults to Viewer.

ViewersCanEdit string

Users with view-only permission can edit but not save dashboards.

AlertingEnabled string

Enable or disable Grafana alerting functionality

AlertingErrorOrTimeout string

Default error or timeout setting for new alerting rules

AlertingNodataOrNullvalues string

Default value for ‘no data or null values’ for new alerting rules

AllowEmbedding string

Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking

AuthBasicEnabled string

Enable or disable basic authentication form, used by Grafana built-in login.

AuthGenericOauth GrafanaGrafanaUserConfigAuthGenericOauth

Generic OAuth integration.

AuthGithub GrafanaGrafanaUserConfigAuthGithub

Automatically sign-up users on successful sign-in

AuthGitlab GrafanaGrafanaUserConfigAuthGitlab

GitLab Auth integration.

AuthGoogle GrafanaGrafanaUserConfigAuthGoogle

Google Auth integration

CookieSamesite string

Cookie SameSite attribute: ‘strict’ prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. ‘lax’ is the default value.

CustomDomain string

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

DashboardsVersionsToKeep string

Dashboard versions to keep per dashboard.

DataproxySendUserHeader string

Send ‘X-Grafana-User’ header to data source.

DataproxyTimeout string

Timeout for data proxy requests in seconds.

DisableGravatar string

Set to true to disable gravatar. Defaults to false (gravatar is enabled).

EditorsCanAdmin string

Editors can manage folders, teams and dashboards created by them.

ExternalImageStorage GrafanaGrafanaUserConfigExternalImageStorage

External image store settings

GoogleAnalyticsUaId string

Google Analytics Universal Analytics ID for tracking Grafana usage

IpFilters []string

Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’

MetricsEnabled string

Enable Grafana /metrics endpoint

PrivateAccess GrafanaGrafanaUserConfigPrivateAccess
ProjectToForkFrom string

Name of another project to fork a service from. This has effect only when a new service is being created.

PublicAccess GrafanaGrafanaUserConfigPublicAccess

Allow access to selected service ports from the public Internet.

RecoveryBasebackupName string

Name of the basebackup to restore in forked service.

ServiceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created.

SmtpServer GrafanaGrafanaUserConfigSmtpServer

SMTP server settings.

UserAutoAssignOrg string

Auto-assign new users on signup to main organization. Defaults to false.

UserAutoAssignOrgRole string

Set role for new signups. Defaults to Viewer.

ViewersCanEdit string

Users with view-only permission can edit but not save dashboards.

alertingEnabled string

Enable or disable Grafana alerting functionality

alertingErrorOrTimeout string

Default error or timeout setting for new alerting rules

alertingNodataOrNullvalues string

Default value for ‘no data or null values’ for new alerting rules

allowEmbedding string

Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking

authBasicEnabled string

Enable or disable basic authentication form, used by Grafana built-in login.

authGenericOauth GrafanaGrafanaUserConfigAuthGenericOauth

Generic OAuth integration.

authGithub GrafanaGrafanaUserConfigAuthGithub

Automatically sign-up users on successful sign-in

authGitlab GrafanaGrafanaUserConfigAuthGitlab

GitLab Auth integration.

authGoogle GrafanaGrafanaUserConfigAuthGoogle

Google Auth integration

cookieSamesite string

Cookie SameSite attribute: ‘strict’ prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. ‘lax’ is the default value.

customDomain string

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

dashboardsVersionsToKeep string

Dashboard versions to keep per dashboard.

dataproxySendUserHeader string

Send ‘X-Grafana-User’ header to data source.

dataproxyTimeout string

Timeout for data proxy requests in seconds.

disableGravatar string

Set to true to disable gravatar. Defaults to false (gravatar is enabled).

editorsCanAdmin string

Editors can manage folders, teams and dashboards created by them.

externalImageStorage GrafanaGrafanaUserConfigExternalImageStorage

External image store settings

googleAnalyticsUaId string

Google Analytics Universal Analytics ID for tracking Grafana usage

ipFilters string[]

Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’

metricsEnabled string

Enable Grafana /metrics endpoint

privateAccess GrafanaGrafanaUserConfigPrivateAccess
projectToForkFrom string

Name of another project to fork a service from. This has effect only when a new service is being created.

publicAccess GrafanaGrafanaUserConfigPublicAccess

Allow access to selected service ports from the public Internet.

recoveryBasebackupName string

Name of the basebackup to restore in forked service.

serviceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created.

smtpServer GrafanaGrafanaUserConfigSmtpServer

SMTP server settings.

userAutoAssignOrg string

Auto-assign new users on signup to main organization. Defaults to false.

userAutoAssignOrgRole string

Set role for new signups. Defaults to Viewer.

viewersCanEdit string

Users with view-only permission can edit but not save dashboards.

alerting_enabled str

Enable or disable Grafana alerting functionality

alerting_error_or_timeout str

Default error or timeout setting for new alerting rules

alerting_nodata_or_nullvalues str

Default value for ‘no data or null values’ for new alerting rules

allow_embedding str

Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking

auth_basic_enabled str

Enable or disable basic authentication form, used by Grafana built-in login.

auth_generic_oauth GrafanaGrafanaUserConfigAuthGenericOauthArgs

Generic OAuth integration.

auth_github GrafanaGrafanaUserConfigAuthGithubArgs

Automatically sign-up users on successful sign-in

auth_gitlab GrafanaGrafanaUserConfigAuthGitlabArgs

GitLab Auth integration.

auth_google GrafanaGrafanaUserConfigAuthGoogleArgs

Google Auth integration

cookie_samesite str

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.

dashboards_versions_to_keep str

Dashboard versions to keep per dashboard.

dataproxy_send_user_header str

Send ‘X-Grafana-User’ header to data source.

dataproxy_timeout str

Timeout for data proxy requests in seconds.

disable_gravatar str

Set to true to disable gravatar. Defaults to false (gravatar is enabled).

editors_can_admin str

Editors can manage folders, teams and dashboards created by them.

external_image_storage GrafanaGrafanaUserConfigExternalImageStorageArgs

External image store settings

google_analytics_ua_id str

Google Analytics Universal Analytics ID for tracking Grafana usage

ip_filters Sequence[str]

Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’

metrics_enabled str

Enable Grafana /metrics endpoint

private_access GrafanaGrafanaUserConfigPrivateAccessArgs
project_to_fork_from str

Name of another project to fork a service from. This has effect only when a new service is being created.

public_access GrafanaGrafanaUserConfigPublicAccessArgs

Allow access to selected service ports from the public Internet.

recovery_basebackup_name str

Name of the basebackup to restore in forked service.

service_to_fork_from str

Name of another service to fork from. This has effect only when a new service is being created.

smtp_server GrafanaGrafanaUserConfigSmtpServerArgs

SMTP server settings.

user_auto_assign_org str

Auto-assign new users on signup to main organization. Defaults to false.

user_auto_assign_org_role str

Set role for new signups. Defaults to Viewer.

viewers_can_edit str

Users with view-only permission can edit but not save dashboards.

GrafanaGrafanaUserConfigAuthGenericOauth

AllowSignUp string

Automatically sign-up users on successful sign-in

AllowedDomains List<string>

Allowed domain

AllowedOrganizations List<string>

Must consist of alpha-numeric characters and dashes”

ApiUrl string

API URL. This only needs to be set when using self hosted GitLab

AuthUrl string

Authorization URL. This only needs to be set when using self hosted GitLab

ClientId string

Client ID from provider

ClientSecret string

Client secret from provider

Name string

Name of the OAuth integration

Scopes List<string>

Scope must be non-empty string without whitespace

TokenUrl string

Token URL. This only needs to be set when using self hosted GitLab

AllowSignUp string

Automatically sign-up users on successful sign-in

AllowedDomains []string

Allowed domain

AllowedOrganizations []string

Must consist of alpha-numeric characters and dashes”

ApiUrl string

API URL. This only needs to be set when using self hosted GitLab

AuthUrl string

Authorization URL. This only needs to be set when using self hosted GitLab

ClientId string

Client ID from provider

ClientSecret string

Client secret from provider

Name string

Name of the OAuth integration

Scopes []string

Scope must be non-empty string without whitespace

TokenUrl string

Token URL. This only needs to be set when using self hosted GitLab

allowSignUp string

Automatically sign-up users on successful sign-in

allowedDomains string[]

Allowed domain

allowedOrganizations string[]

Must consist of alpha-numeric characters and dashes”

apiUrl string

API URL. This only needs to be set when using self hosted GitLab

authUrl string

Authorization URL. This only needs to be set when using self hosted GitLab

clientId string

Client ID from provider

clientSecret string

Client secret from provider

name string

Name of the OAuth integration

scopes string[]

Scope must be non-empty string without whitespace

tokenUrl string

Token URL. This only needs to be set when using self hosted GitLab

allow_sign_up str

Automatically sign-up users on successful sign-in

allowed_domains Sequence[str]

Allowed domain

allowed_organizations Sequence[str]

Must consist of alpha-numeric characters and dashes”

api_url str

API URL. This only needs to be set when using self hosted GitLab

auth_url str

Authorization URL. This only needs to be set when using self hosted GitLab

client_id str

Client ID from provider

client_secret str

Client secret from provider

name str

Name of the OAuth integration

scopes Sequence[str]

Scope must be non-empty string without whitespace

token_url str

Token URL. This only needs to be set when using self hosted GitLab

GrafanaGrafanaUserConfigAuthGithub

AllowSignUp string

Automatically sign-up users on successful sign-in

AllowedOrganizations List<string>

Must consist of alpha-numeric characters and dashes”

ClientId string

Client ID from provider

ClientSecret string

Client secret from provider

TeamIds List<string>

Require users to belong to one of given team IDs

AllowSignUp string

Automatically sign-up users on successful sign-in

AllowedOrganizations []string

Must consist of alpha-numeric characters and dashes”

ClientId string

Client ID from provider

ClientSecret string

Client secret from provider

TeamIds []string

Require users to belong to one of given team IDs

allowSignUp string

Automatically sign-up users on successful sign-in

allowedOrganizations string[]

Must consist of alpha-numeric characters and dashes”

clientId string

Client ID from provider

clientSecret string

Client secret from provider

teamIds string[]

Require users to belong to one of given team IDs

allow_sign_up str

Automatically sign-up users on successful sign-in

allowed_organizations Sequence[str]

Must consist of alpha-numeric characters and dashes”

client_id str

Client ID from provider

client_secret str

Client secret from provider

team_ids Sequence[str]

Require users to belong to one of given team IDs

GrafanaGrafanaUserConfigAuthGitlab

AllowSignUp string

Automatically sign-up users on successful sign-in

AllowedGroups List<string>

Require users to belong to one of given groups

ApiUrl string

API URL. This only needs to be set when using self hosted GitLab

AuthUrl string

Authorization URL. This only needs to be set when using self hosted GitLab

ClientId string

Client ID from provider

ClientSecret string

Client secret from provider

TokenUrl string

Token URL. This only needs to be set when using self hosted GitLab

AllowSignUp string

Automatically sign-up users on successful sign-in

AllowedGroups []string

Require users to belong to one of given groups

ApiUrl string

API URL. This only needs to be set when using self hosted GitLab

AuthUrl string

Authorization URL. This only needs to be set when using self hosted GitLab

ClientId string

Client ID from provider

ClientSecret string

Client secret from provider

TokenUrl string

Token URL. This only needs to be set when using self hosted GitLab

allowSignUp string

Automatically sign-up users on successful sign-in

allowedGroups string[]

Require users to belong to one of given groups

apiUrl string

API URL. This only needs to be set when using self hosted GitLab

authUrl string

Authorization URL. This only needs to be set when using self hosted GitLab

clientId string

Client ID from provider

clientSecret string

Client secret from provider

tokenUrl string

Token URL. This only needs to be set when using self hosted GitLab

allow_sign_up str

Automatically sign-up users on successful sign-in

allowed_groups Sequence[str]

Require users to belong to one of given groups

api_url str

API URL. This only needs to be set when using self hosted GitLab

auth_url str

Authorization URL. This only needs to be set when using self hosted GitLab

client_id str

Client ID from provider

client_secret str

Client secret from provider

token_url str

Token URL. This only needs to be set when using self hosted GitLab

GrafanaGrafanaUserConfigAuthGoogle

AllowSignUp string

Automatically sign-up users on successful sign-in

AllowedDomains List<string>

Allowed domain

ClientId string

Client ID from provider

ClientSecret string

Client secret from provider

AllowSignUp string

Automatically sign-up users on successful sign-in

AllowedDomains []string

Allowed domain

ClientId string

Client ID from provider

ClientSecret string

Client secret from provider

allowSignUp string

Automatically sign-up users on successful sign-in

allowedDomains string[]

Allowed domain

clientId string

Client ID from provider

clientSecret string

Client secret from provider

allow_sign_up str

Automatically sign-up users on successful sign-in

allowed_domains Sequence[str]

Allowed domain

client_id str

Client ID from provider

client_secret str

Client secret from provider

GrafanaGrafanaUserConfigExternalImageStorage

AccessKey string

S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions

BucketUrl string

Bucket URL for S3

Provider string

Provider type

SecretKey string

S3 secret key

AccessKey string

S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions

BucketUrl string

Bucket URL for S3

Provider string

Provider type

SecretKey string

S3 secret key

accessKey string

S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions

bucketUrl string

Bucket URL for S3

provider string

Provider type

secretKey string

S3 secret key

access_key str

S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions

bucket_url str

Bucket URL for S3

provider str

Provider type

secret_key str

S3 secret key

GrafanaGrafanaUserConfigPrivateAccess

Grafana string

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 string

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 string

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 str

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.

GrafanaGrafanaUserConfigPublicAccess

Grafana string

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 string

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 string

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 str

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.

GrafanaGrafanaUserConfigSmtpServer

FromAddress string

Address used for sending emails

FromName string

Name used in outgoing emails, defaults to Grafana

Host string

Server hostname or IP

Password string

Password for SMTP authentication

Port string

SMTP server port

SkipVerify string

Skip verifying server certificate. Defaults to false

StarttlsPolicy string

Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.

Username string

Username for SMTP authentication

FromAddress string

Address used for sending emails

FromName string

Name used in outgoing emails, defaults to Grafana

Host string

Server hostname or IP

Password string

Password for SMTP authentication

Port string

SMTP server port

SkipVerify string

Skip verifying server certificate. Defaults to false

StarttlsPolicy string

Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.

Username string

Username for SMTP authentication

fromAddress string

Address used for sending emails

fromName string

Name used in outgoing emails, defaults to Grafana

host string

Server hostname or IP

password string

Password for SMTP authentication

port string

SMTP server port

skipVerify string

Skip verifying server certificate. Defaults to false

starttlsPolicy string

Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.

username string

Username for SMTP authentication

from_address str

Address used for sending emails

from_name str

Name used in outgoing emails, defaults to Grafana

host str

Server hostname or IP

password str

Password for SMTP authentication

port str

SMTP server port

skip_verify str

Skip verifying server certificate. Defaults to false

starttls_policy str

Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.

username str

Username for SMTP authentication

GrafanaServiceIntegration

Package Details

Repository
https://github.com/pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.