Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Grafana Cloud
  4. API Docs
  5. assistant
  6. Quickstart
Viewing docs for Grafana v2.32.0
published on Saturday, Jun 13, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-grafana

grafana.assistant.Quickstart

grafana logo
Viewing docs for Grafana v2.32.0
published on Saturday, Jun 13, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-grafana

    Manages a Grafana Assistant quickstart prompt shown to users.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@pulumiverse/grafana";

const example = new grafana.assistant.Quickstart("example", {
    scope: "tenant",
    title: "SLO health",
    prompt: "How healthy are my SLOs right now?",
});

    import pulumi
import pulumiverse_grafana as grafana

example = grafana.assistant.Quickstart("example",
    scope="tenant",
    title="SLO health",
    prompt="How healthy are my SLOs right now?")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-grafana/sdk/v2/go/grafana/assistant"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := assistant.NewQuickstart(ctx, "example", &assistant.QuickstartArgs{
			Scope:  pulumi.String("tenant"),
			Title:  pulumi.String("SLO health"),
			Prompt: pulumi.String("How healthy are my SLOs right now?"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Pulumiverse.Grafana;

return await Deployment.RunAsync(() => 
{
    var example = new Grafana.Assistant.Quickstart("example", new()
    {
        Scope = "tenant",
        Title = "SLO health",
        Prompt = "How healthy are my SLOs right now?",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.assistant.Quickstart;
import com.pulumi.grafana.assistant.QuickstartArgs;
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) {
        var example = new Quickstart("example", QuickstartArgs.builder()
            .scope("tenant")
            .title("SLO health")
            .prompt("How healthy are my SLOs right now?")
            .build());

    }
}

    resources:
  example:
    type: grafana:assistant:Quickstart
    properties:
      scope: tenant
      title: SLO health
      prompt: How healthy are my SLOs right now?

    Example coming soon!

    Create Quickstart Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Quickstart(name: string, args: QuickstartArgs, opts?: CustomResourceOptions);
    @overload
def Quickstart(resource_name: str,
               args: QuickstartArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Quickstart(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               prompt: Optional[str] = None,
               scope: Optional[str] = None,
               context_items: Optional[str] = None,
               enabled: Optional[bool] = None,
               title: Optional[str] = None)
    func NewQuickstart(ctx *Context, name string, args QuickstartArgs, opts ...ResourceOption) (*Quickstart, error)
    public Quickstart(string name, QuickstartArgs args, CustomResourceOptions? opts = null)
    public Quickstart(String name, QuickstartArgs args)
public Quickstart(String name, QuickstartArgs args, CustomResourceOptions options)

    type: grafana:assistant:Quickstart
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "grafana_assistant_quickstart" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args QuickstartArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args QuickstartArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args QuickstartArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QuickstartArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QuickstartArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var quickstartResource = new Grafana.Assistant.Quickstart("quickstartResource", new()
{
    Prompt = "string",
    Scope = "string",
    ContextItems = "string",
    Enabled = false,
    Title = "string",
});

    example, err := assistant.NewQuickstart(ctx, "quickstartResource", &assistant.QuickstartArgs{
	Prompt:       pulumi.String("string"),
	Scope:        pulumi.String("string"),
	ContextItems: pulumi.String("string"),
	Enabled:      pulumi.Bool(false),
	Title:        pulumi.String("string"),
})

    resource "grafana_assistant_quickstart" "quickstartResource" {
  prompt        = "string"
  scope         = "string"
  context_items = "string"
  enabled       = false
  title         = "string"
}

    var quickstartResource = new Quickstart("quickstartResource", QuickstartArgs.builder()
    .prompt("string")
    .scope("string")
    .contextItems("string")
    .enabled(false)
    .title("string")
    .build());

    quickstart_resource = grafana.assistant.Quickstart("quickstartResource",
    prompt="string",
    scope="string",
    context_items="string",
    enabled=False,
    title="string")

    const quickstartResource = new grafana.assistant.Quickstart("quickstartResource", {
    prompt: "string",
    scope: "string",
    contextItems: "string",
    enabled: false,
    title: "string",
});

    type: grafana:assistant:Quickstart
properties:
    contextItems: string
    enabled: false
    prompt: string
    scope: string
    title: string

    Quickstart Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Quickstart resource accepts the following input properties:

    Prompt string
    The quickstart question text.
    Scope string
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    ContextItems string
    Optional JSON array of context items for the quickstart.
    Enabled bool
    Whether the resource is enabled.
    Title string
    Optional title for the quickstart.
    Prompt string
    The quickstart question text.
    Scope string
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    ContextItems string
    Optional JSON array of context items for the quickstart.
    Enabled bool
    Whether the resource is enabled.
    Title string
    Optional title for the quickstart.
    prompt string
    The quickstart question text.
    scope string
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    context_items string
    Optional JSON array of context items for the quickstart.
    enabled bool
    Whether the resource is enabled.
    title string
    Optional title for the quickstart.
    prompt String
    The quickstart question text.
    scope String
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    contextItems String
    Optional JSON array of context items for the quickstart.
    enabled Boolean
    Whether the resource is enabled.
    title String
    Optional title for the quickstart.
    prompt string
    The quickstart question text.
    scope string
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    contextItems string
    Optional JSON array of context items for the quickstart.
    enabled boolean
    Whether the resource is enabled.
    title string
    Optional title for the quickstart.
    prompt str
    The quickstart question text.
    scope str
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    context_items str
    Optional JSON array of context items for the quickstart.
    enabled bool
    Whether the resource is enabled.
    title str
    Optional title for the quickstart.
    prompt String
    The quickstart question text.
    scope String
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    contextItems String
    Optional JSON array of context items for the quickstart.
    enabled Boolean
    Whether the resource is enabled.
    title String
    Optional title for the quickstart.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Quickstart Resource

    Get an existing Quickstart 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?: QuickstartState, opts?: CustomResourceOptions): Quickstart
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        context_items: Optional[str] = None,
        enabled: Optional[bool] = None,
        prompt: Optional[str] = None,
        scope: Optional[str] = None,
        title: Optional[str] = None) -> Quickstart
    func GetQuickstart(ctx *Context, name string, id IDInput, state *QuickstartState, opts ...ResourceOption) (*Quickstart, error)
    public static Quickstart Get(string name, Input<string> id, QuickstartState? state, CustomResourceOptions? opts = null)
    public static Quickstart get(String name, Output<String> id, QuickstartState state, CustomResourceOptions options)
    resources:  _:    type: grafana:assistant:Quickstart    get:      id: ${id}
    import {
  to = grafana_assistant_quickstart.example
  id = "${id}"
}
    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.
    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:
    ContextItems string
    Optional JSON array of context items for the quickstart.
    Enabled bool
    Whether the resource is enabled.
    Prompt string
    The quickstart question text.
    Scope string
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    Title string
    Optional title for the quickstart.
    ContextItems string
    Optional JSON array of context items for the quickstart.
    Enabled bool
    Whether the resource is enabled.
    Prompt string
    The quickstart question text.
    Scope string
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    Title string
    Optional title for the quickstart.
    context_items string
    Optional JSON array of context items for the quickstart.
    enabled bool
    Whether the resource is enabled.
    prompt string
    The quickstart question text.
    scope string
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    title string
    Optional title for the quickstart.
    contextItems String
    Optional JSON array of context items for the quickstart.
    enabled Boolean
    Whether the resource is enabled.
    prompt String
    The quickstart question text.
    scope String
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    title String
    Optional title for the quickstart.
    contextItems string
    Optional JSON array of context items for the quickstart.
    enabled boolean
    Whether the resource is enabled.
    prompt string
    The quickstart question text.
    scope string
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    title string
    Optional title for the quickstart.
    context_items str
    Optional JSON array of context items for the quickstart.
    enabled bool
    Whether the resource is enabled.
    prompt str
    The quickstart question text.
    scope str
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    title str
    Optional title for the quickstart.
    contextItems String
    Optional JSON array of context items for the quickstart.
    enabled Boolean
    Whether the resource is enabled.
    prompt String
    The quickstart question text.
    scope String
    Whether the resource is visible to the whole tenant (tenant) or only the creating user (user).
    title String
    Optional title for the quickstart.

    Import

    terraform import grafana_assistant_quickstart.name "{{ id }}"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Viewing docs for Grafana v2.32.0
    published on Saturday, Jun 13, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-grafana

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial