Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. Board
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

honeycombio.Board

Explore with Pulumi AI

honeycombio logo
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

    # Resource: honeycombio.Board

    Creates a board. For more information about boards, check out Collaborate with Boards.

    Example Usage

    Simple Board

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

const queryQuerySpecification = honeycombio.getQuerySpecification({
    calculations: [{
        op: "P99",
        column: "duration_ms",
    }],
    filters: [{
        column: "trace.parent_id",
        op: "does-not-exist",
    }],
    breakdowns: ["app.tenant"],
});
const queryQuery = new honeycombio.Query("queryQuery", {
    dataset: _var.dataset,
    queryJson: queryQuerySpecification.then(queryQuerySpecification => queryQuerySpecification.json),
});
const board = new honeycombio.Board("board", {queries: [{
    queryId: queryQuery.id,
}]});

    import pulumi
import pulumi_honeycombio as honeycombio

query_query_specification = honeycombio.get_query_specification(calculations=[{
        "op": "P99",
        "column": "duration_ms",
    }],
    filters=[{
        "column": "trace.parent_id",
        "op": "does-not-exist",
    }],
    breakdowns=["app.tenant"])
query_query = honeycombio.Query("queryQuery",
    dataset=var["dataset"],
    query_json=query_query_specification.json)
board = honeycombio.Board("board", queries=[{
    "query_id": query_query.id,
}])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		queryQuerySpecification, err := honeycombio.GetQuerySpecification(ctx, &honeycombio.GetQuerySpecificationArgs{
			Calculations: []honeycombio.GetQuerySpecificationCalculation{
				{
					Op:     "P99",
					Column: pulumi.StringRef("duration_ms"),
				},
			},
			Filters: []honeycombio.GetQuerySpecificationFilter{
				{
					Column: "trace.parent_id",
					Op:     "does-not-exist",
				},
			},
			Breakdowns: []string{
				"app.tenant",
			},
		}, nil)
		if err != nil {
			return err
		}
		queryQuery, err := honeycombio.NewQuery(ctx, "queryQuery", &honeycombio.QueryArgs{
			Dataset:   pulumi.Any(_var.Dataset),
			QueryJson: pulumi.String(queryQuerySpecification.Json),
		})
		if err != nil {
			return err
		}
		_, err = honeycombio.NewBoard(ctx, "board", &honeycombio.BoardArgs{
			Queries: honeycombio.BoardQueryArray{
				&honeycombio.BoardQueryArgs{
					QueryId: queryQuery.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    var queryQuerySpecification = Honeycombio.GetQuerySpecification.Invoke(new()
    {
        Calculations = new[]
        {
            new Honeycombio.Inputs.GetQuerySpecificationCalculationInputArgs
            {
                Op = "P99",
                Column = "duration_ms",
            },
        },
        Filters = new[]
        {
            new Honeycombio.Inputs.GetQuerySpecificationFilterInputArgs
            {
                Column = "trace.parent_id",
                Op = "does-not-exist",
            },
        },
        Breakdowns = new[]
        {
            "app.tenant",
        },
    });

    var queryQuery = new Honeycombio.Query("queryQuery", new()
    {
        Dataset = @var.Dataset,
        QueryJson = queryQuerySpecification.Apply(getQuerySpecificationResult => getQuerySpecificationResult.Json),
    });

    var board = new Honeycombio.Board("board", new()
    {
        Queries = new[]
        {
            new Honeycombio.Inputs.BoardQueryArgs
            {
                QueryId = queryQuery.Id,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetQuerySpecificationArgs;
import com.pulumi.honeycombio.Query;
import com.pulumi.honeycombio.QueryArgs;
import com.pulumi.honeycombio.Board;
import com.pulumi.honeycombio.BoardArgs;
import com.pulumi.honeycombio.inputs.BoardQueryArgs;
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 queryQuerySpecification = HoneycombioFunctions.getQuerySpecification(GetQuerySpecificationArgs.builder()
            .calculations(GetQuerySpecificationCalculationArgs.builder()
                .op("P99")
                .column("duration_ms")
                .build())
            .filters(GetQuerySpecificationFilterArgs.builder()
                .column("trace.parent_id")
                .op("does-not-exist")
                .build())
            .breakdowns("app.tenant")
            .build());

        var queryQuery = new Query("queryQuery", QueryArgs.builder()
            .dataset(var_.dataset())
            .queryJson(queryQuerySpecification.applyValue(getQuerySpecificationResult -> getQuerySpecificationResult.json()))
            .build());

        var board = new Board("board", BoardArgs.builder()
            .queries(BoardQueryArgs.builder()
                .queryId(queryQuery.id())
                .build())
            .build());

    }
}

    resources:
  queryQuery:
    type: honeycombio:Query
    properties:
      dataset: ${var.dataset}
      queryJson: ${queryQuerySpecification.json}
  board:
    type: honeycombio:Board
    properties:
      queries:
        - queryId: ${queryQuery.id}
variables:
  queryQuerySpecification:
    fn::invoke:
      function: honeycombio:getQuerySpecification
      arguments:
        calculations:
          - op: P99
            column: duration_ms
        filters:
          - column: trace.parent_id
            op: does-not-exist
        breakdowns:
          - app.tenant

    Annotated Board

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

const latencyByUseridQuerySpecification = honeycombio.getQuerySpecification({
    timeRange: 86400,
    breakdowns: ["app.user_id"],
    calculations: [
        {
            op: "HEATMAP",
            column: "duration_ms",
        },
        {
            op: "P99",
            column: "duration_ms",
        },
    ],
    filters: [{
        column: "trace.parent_id",
        op: "does-not-exist",
    }],
    orders: [{
        column: "duration_ms",
        op: "P99",
        order: "descending",
    }],
});
const latencyByUseridQuery = new honeycombio.Query("latencyByUseridQuery", {
    dataset: _var.dataset,
    queryJson: latencyByUseridQuerySpecification.then(latencyByUseridQuerySpecification => latencyByUseridQuerySpecification.json),
});
const latencyByUseridQueryAnnotation = new honeycombio.QueryAnnotation("latencyByUseridQueryAnnotation", {
    dataset: _var.dataset,
    queryId: latencyByUseridQuery.id,
    description: "A breakdown of trace latency by User over the last 24 hours",
});
const overview = new honeycombio.Board("overview", {
    queries: [{
        caption: "Latency by User",
        queryId: latencyByUseridQuery.id,
        queryAnnotationId: latencyByUseridQueryAnnotation.queryAnnotationId,
        graphSettings: {
            utcXaxis: true,
        },
    }],
    slos: [{
        id: _var.slo_id,
    }],
});

    import pulumi
import pulumi_honeycombio as honeycombio

latency_by_userid_query_specification = honeycombio.get_query_specification(time_range=86400,
    breakdowns=["app.user_id"],
    calculations=[
        {
            "op": "HEATMAP",
            "column": "duration_ms",
        },
        {
            "op": "P99",
            "column": "duration_ms",
        },
    ],
    filters=[{
        "column": "trace.parent_id",
        "op": "does-not-exist",
    }],
    orders=[{
        "column": "duration_ms",
        "op": "P99",
        "order": "descending",
    }])
latency_by_userid_query = honeycombio.Query("latencyByUseridQuery",
    dataset=var["dataset"],
    query_json=latency_by_userid_query_specification.json)
latency_by_userid_query_annotation = honeycombio.QueryAnnotation("latencyByUseridQueryAnnotation",
    dataset=var["dataset"],
    query_id=latency_by_userid_query.id,
    description="A breakdown of trace latency by User over the last 24 hours")
overview = honeycombio.Board("overview",
    queries=[{
        "caption": "Latency by User",
        "query_id": latency_by_userid_query.id,
        "query_annotation_id": latency_by_userid_query_annotation.query_annotation_id,
        "graph_settings": {
            "utc_xaxis": True,
        },
    }],
    slos=[{
        "id": var["slo_id"],
    }])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		latencyByUseridQuerySpecification, err := honeycombio.GetQuerySpecification(ctx, &honeycombio.GetQuerySpecificationArgs{
			TimeRange: pulumi.Float64Ref(86400),
			Breakdowns: []string{
				"app.user_id",
			},
			Calculations: []honeycombio.GetQuerySpecificationCalculation{
				{
					Op:     "HEATMAP",
					Column: pulumi.StringRef("duration_ms"),
				},
				{
					Op:     "P99",
					Column: pulumi.StringRef("duration_ms"),
				},
			},
			Filters: []honeycombio.GetQuerySpecificationFilter{
				{
					Column: "trace.parent_id",
					Op:     "does-not-exist",
				},
			},
			Orders: []honeycombio.GetQuerySpecificationOrder{
				{
					Column: pulumi.StringRef("duration_ms"),
					Op:     pulumi.StringRef("P99"),
					Order:  pulumi.StringRef("descending"),
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		latencyByUseridQuery, err := honeycombio.NewQuery(ctx, "latencyByUseridQuery", &honeycombio.QueryArgs{
			Dataset:   pulumi.Any(_var.Dataset),
			QueryJson: pulumi.String(latencyByUseridQuerySpecification.Json),
		})
		if err != nil {
			return err
		}
		latencyByUseridQueryAnnotation, err := honeycombio.NewQueryAnnotation(ctx, "latencyByUseridQueryAnnotation", &honeycombio.QueryAnnotationArgs{
			Dataset:     pulumi.Any(_var.Dataset),
			QueryId:     latencyByUseridQuery.ID(),
			Description: pulumi.String("A breakdown of trace latency by User over the last 24 hours"),
		})
		if err != nil {
			return err
		}
		_, err = honeycombio.NewBoard(ctx, "overview", &honeycombio.BoardArgs{
			Queries: honeycombio.BoardQueryArray{
				&honeycombio.BoardQueryArgs{
					Caption:           pulumi.String("Latency by User"),
					QueryId:           latencyByUseridQuery.ID(),
					QueryAnnotationId: latencyByUseridQueryAnnotation.QueryAnnotationId,
					GraphSettings: &honeycombio.BoardQueryGraphSettingsArgs{
						UtcXaxis: pulumi.Bool(true),
					},
				},
			},
			Slos: honeycombio.BoardSloArray{
				&honeycombio.BoardSloArgs{
					Id: pulumi.Any(_var.Slo_id),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    var latencyByUseridQuerySpecification = Honeycombio.GetQuerySpecification.Invoke(new()
    {
        TimeRange = 86400,
        Breakdowns = new[]
        {
            "app.user_id",
        },
        Calculations = new[]
        {
            new Honeycombio.Inputs.GetQuerySpecificationCalculationInputArgs
            {
                Op = "HEATMAP",
                Column = "duration_ms",
            },
            new Honeycombio.Inputs.GetQuerySpecificationCalculationInputArgs
            {
                Op = "P99",
                Column = "duration_ms",
            },
        },
        Filters = new[]
        {
            new Honeycombio.Inputs.GetQuerySpecificationFilterInputArgs
            {
                Column = "trace.parent_id",
                Op = "does-not-exist",
            },
        },
        Orders = new[]
        {
            new Honeycombio.Inputs.GetQuerySpecificationOrderInputArgs
            {
                Column = "duration_ms",
                Op = "P99",
                Order = "descending",
            },
        },
    });

    var latencyByUseridQuery = new Honeycombio.Query("latencyByUseridQuery", new()
    {
        Dataset = @var.Dataset,
        QueryJson = latencyByUseridQuerySpecification.Apply(getQuerySpecificationResult => getQuerySpecificationResult.Json),
    });

    var latencyByUseridQueryAnnotation = new Honeycombio.QueryAnnotation("latencyByUseridQueryAnnotation", new()
    {
        Dataset = @var.Dataset,
        QueryId = latencyByUseridQuery.Id,
        Description = "A breakdown of trace latency by User over the last 24 hours",
    });

    var overview = new Honeycombio.Board("overview", new()
    {
        Queries = new[]
        {
            new Honeycombio.Inputs.BoardQueryArgs
            {
                Caption = "Latency by User",
                QueryId = latencyByUseridQuery.Id,
                QueryAnnotationId = latencyByUseridQueryAnnotation.QueryAnnotationId,
                GraphSettings = new Honeycombio.Inputs.BoardQueryGraphSettingsArgs
                {
                    UtcXaxis = true,
                },
            },
        },
        Slos = new[]
        {
            new Honeycombio.Inputs.BoardSloArgs
            {
                Id = @var.Slo_id,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetQuerySpecificationArgs;
import com.pulumi.honeycombio.Query;
import com.pulumi.honeycombio.QueryArgs;
import com.pulumi.honeycombio.QueryAnnotation;
import com.pulumi.honeycombio.QueryAnnotationArgs;
import com.pulumi.honeycombio.Board;
import com.pulumi.honeycombio.BoardArgs;
import com.pulumi.honeycombio.inputs.BoardQueryArgs;
import com.pulumi.honeycombio.inputs.BoardQueryGraphSettingsArgs;
import com.pulumi.honeycombio.inputs.BoardSloArgs;
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 latencyByUseridQuerySpecification = HoneycombioFunctions.getQuerySpecification(GetQuerySpecificationArgs.builder()
            .timeRange(86400)
            .breakdowns("app.user_id")
            .calculations(            
                GetQuerySpecificationCalculationArgs.builder()
                    .op("HEATMAP")
                    .column("duration_ms")
                    .build(),
                GetQuerySpecificationCalculationArgs.builder()
                    .op("P99")
                    .column("duration_ms")
                    .build())
            .filters(GetQuerySpecificationFilterArgs.builder()
                .column("trace.parent_id")
                .op("does-not-exist")
                .build())
            .orders(GetQuerySpecificationOrderArgs.builder()
                .column("duration_ms")
                .op("P99")
                .order("descending")
                .build())
            .build());

        var latencyByUseridQuery = new Query("latencyByUseridQuery", QueryArgs.builder()
            .dataset(var_.dataset())
            .queryJson(latencyByUseridQuerySpecification.applyValue(getQuerySpecificationResult -> getQuerySpecificationResult.json()))
            .build());

        var latencyByUseridQueryAnnotation = new QueryAnnotation("latencyByUseridQueryAnnotation", QueryAnnotationArgs.builder()
            .dataset(var_.dataset())
            .queryId(latencyByUseridQuery.id())
            .description("A breakdown of trace latency by User over the last 24 hours")
            .build());

        var overview = new Board("overview", BoardArgs.builder()
            .queries(BoardQueryArgs.builder()
                .caption("Latency by User")
                .queryId(latencyByUseridQuery.id())
                .queryAnnotationId(latencyByUseridQueryAnnotation.queryAnnotationId())
                .graphSettings(BoardQueryGraphSettingsArgs.builder()
                    .utcXaxis(true)
                    .build())
                .build())
            .slos(BoardSloArgs.builder()
                .id(var_.slo_id())
                .build())
            .build());

    }
}

    resources:
  latencyByUseridQuery:
    type: honeycombio:Query
    properties:
      dataset: ${var.dataset}
      queryJson: ${latencyByUseridQuerySpecification.json}
  latencyByUseridQueryAnnotation:
    type: honeycombio:QueryAnnotation
    properties:
      dataset: ${var.dataset}
      queryId: ${latencyByUseridQuery.id}
      description: A breakdown of trace latency by User over the last 24 hours
  overview:
    type: honeycombio:Board
    properties:
      queries:
        - caption: Latency by User
          queryId: ${latencyByUseridQuery.id}
          queryAnnotationId: ${latencyByUseridQueryAnnotation.queryAnnotationId}
          graphSettings:
            utcXaxis: true
      slos:
        - id: ${var.slo_id}
variables:
  latencyByUseridQuerySpecification:
    fn::invoke:
      function: honeycombio:getQuerySpecification
      arguments:
        timeRange: 86400
        breakdowns:
          - app.user_id
        calculations:
          - op: HEATMAP
            column: duration_ms
          - op: P99
            column: duration_ms
        filters:
          - column: trace.parent_id
            op: does-not-exist
        orders:
          - column: duration_ms
            op: P99
            order: descending

    Create Board Resource

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

    Constructor syntax

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

@overload
def Board(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          board_id: Optional[str] = None,
          column_layout: Optional[str] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          queries: Optional[Sequence[BoardQueryArgs]] = None,
          slos: Optional[Sequence[BoardSloArgs]] = None,
          style: Optional[str] = None)
    func NewBoard(ctx *Context, name string, args *BoardArgs, opts ...ResourceOption) (*Board, error)
    public Board(string name, BoardArgs? args = null, CustomResourceOptions? opts = null)
    public Board(String name, BoardArgs args)
public Board(String name, BoardArgs args, CustomResourceOptions options)

    type: honeycombio:Board
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BoardArgs
    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 BoardArgs
    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 BoardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BoardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BoardArgs
    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 boardResource = new Honeycombio.Board("boardResource", new()
{
    BoardId = "string",
    ColumnLayout = "string",
    Description = "string",
    Name = "string",
    Queries = new[]
    {
        new Honeycombio.Inputs.BoardQueryArgs
        {
            QueryId = "string",
            Caption = "string",
            GraphSettings = new Honeycombio.Inputs.BoardQueryGraphSettingsArgs
            {
                HideMarkers = false,
                LogScale = false,
                OmitMissingValues = false,
                OverlaidCharts = false,
                StackedGraphs = false,
                UtcXaxis = false,
            },
            QueryAnnotationId = "string",
            QueryStyle = "string",
        },
    },
    Slos = new[]
    {
        new Honeycombio.Inputs.BoardSloArgs
        {
            Id = "string",
        },
    },
});

    example, err := honeycombio.NewBoard(ctx, "boardResource", &honeycombio.BoardArgs{
BoardId: pulumi.String("string"),
ColumnLayout: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Queries: .BoardQueryArray{
&.BoardQueryArgs{
QueryId: pulumi.String("string"),
Caption: pulumi.String("string"),
GraphSettings: &.BoardQueryGraphSettingsArgs{
HideMarkers: pulumi.Bool(false),
LogScale: pulumi.Bool(false),
OmitMissingValues: pulumi.Bool(false),
OverlaidCharts: pulumi.Bool(false),
StackedGraphs: pulumi.Bool(false),
UtcXaxis: pulumi.Bool(false),
},
QueryAnnotationId: pulumi.String("string"),
QueryStyle: pulumi.String("string"),
},
},
Slos: .BoardSloArray{
&.BoardSloArgs{
Id: pulumi.String("string"),
},
},
})

    var boardResource = new Board("boardResource", BoardArgs.builder()
    .boardId("string")
    .columnLayout("string")
    .description("string")
    .name("string")
    .queries(BoardQueryArgs.builder()
        .queryId("string")
        .caption("string")
        .graphSettings(BoardQueryGraphSettingsArgs.builder()
            .hideMarkers(false)
            .logScale(false)
            .omitMissingValues(false)
            .overlaidCharts(false)
            .stackedGraphs(false)
            .utcXaxis(false)
            .build())
        .queryAnnotationId("string")
        .queryStyle("string")
        .build())
    .slos(BoardSloArgs.builder()
        .id("string")
        .build())
    .build());

    board_resource = honeycombio.Board("boardResource",
    board_id="string",
    column_layout="string",
    description="string",
    name="string",
    queries=[{
        "query_id": "string",
        "caption": "string",
        "graph_settings": {
            "hide_markers": False,
            "log_scale": False,
            "omit_missing_values": False,
            "overlaid_charts": False,
            "stacked_graphs": False,
            "utc_xaxis": False,
        },
        "query_annotation_id": "string",
        "query_style": "string",
    }],
    slos=[{
        "id": "string",
    }])

    const boardResource = new honeycombio.Board("boardResource", {
    boardId: "string",
    columnLayout: "string",
    description: "string",
    name: "string",
    queries: [{
        queryId: "string",
        caption: "string",
        graphSettings: {
            hideMarkers: false,
            logScale: false,
            omitMissingValues: false,
            overlaidCharts: false,
            stackedGraphs: false,
            utcXaxis: false,
        },
        queryAnnotationId: "string",
        queryStyle: "string",
    }],
    slos: [{
        id: "string",
    }],
});

    type: honeycombio:Board
properties:
    boardId: string
    columnLayout: string
    description: string
    name: string
    queries:
        - caption: string
          graphSettings:
            hideMarkers: false
            logScale: false
            omitMissingValues: false
            overlaidCharts: false
            stackedGraphs: false
            utcXaxis: false
          queryAnnotationId: string
          queryId: string
          queryStyle: string
    slos:
        - id: string

    Board 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 Board resource accepts the following input properties:

    BoardId string
    ID of the board.
    ColumnLayout string
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    Description string
    Description of the board. Supports Markdown.
    Name string
    Name of the board.
    Queries List<BoardQuery>
    Zero or more configurations blocks (described below) with the queries of the board.
    Slos List<BoardSlo>
    Up to six configuration blocks (described below) to place SLOs on the board.
    Style string
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    BoardId string
    ID of the board.
    ColumnLayout string
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    Description string
    Description of the board. Supports Markdown.
    Name string
    Name of the board.
    Queries []BoardQueryArgs
    Zero or more configurations blocks (described below) with the queries of the board.
    Slos []BoardSloArgs
    Up to six configuration blocks (described below) to place SLOs on the board.
    Style string
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    boardId String
    ID of the board.
    columnLayout String
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    description String
    Description of the board. Supports Markdown.
    name String
    Name of the board.
    queries List<BoardQuery>
    Zero or more configurations blocks (described below) with the queries of the board.
    slos List<BoardSlo>
    Up to six configuration blocks (described below) to place SLOs on the board.
    style String
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    boardId string
    ID of the board.
    columnLayout string
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    description string
    Description of the board. Supports Markdown.
    name string
    Name of the board.
    queries BoardQuery[]
    Zero or more configurations blocks (described below) with the queries of the board.
    slos BoardSlo[]
    Up to six configuration blocks (described below) to place SLOs on the board.
    style string
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    board_id str
    ID of the board.
    column_layout str
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    description str
    Description of the board. Supports Markdown.
    name str
    Name of the board.
    queries Sequence[BoardQueryArgs]
    Zero or more configurations blocks (described below) with the queries of the board.
    slos Sequence[BoardSloArgs]
    Up to six configuration blocks (described below) to place SLOs on the board.
    style str
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    boardId String
    ID of the board.
    columnLayout String
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    description String
    Description of the board. Supports Markdown.
    name String
    Name of the board.
    queries List<Property Map>
    Zero or more configurations blocks (described below) with the queries of the board.
    slos List<Property Map>
    Up to six configuration blocks (described below) to place SLOs on the board.
    style String
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    Outputs

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

    BoardUrl string
    The URL to the board in the Honeycomb UI.
    Id string
    The provider-assigned unique ID for this managed resource.
    BoardUrl string
    The URL to the board in the Honeycomb UI.
    Id string
    The provider-assigned unique ID for this managed resource.
    boardUrl String
    The URL to the board in the Honeycomb UI.
    id String
    The provider-assigned unique ID for this managed resource.
    boardUrl string
    The URL to the board in the Honeycomb UI.
    id string
    The provider-assigned unique ID for this managed resource.
    board_url str
    The URL to the board in the Honeycomb UI.
    id str
    The provider-assigned unique ID for this managed resource.
    boardUrl String
    The URL to the board in the Honeycomb UI.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Board Resource

    Get an existing Board 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?: BoardState, opts?: CustomResourceOptions): Board
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        board_id: Optional[str] = None,
        board_url: Optional[str] = None,
        column_layout: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        queries: Optional[Sequence[BoardQueryArgs]] = None,
        slos: Optional[Sequence[BoardSloArgs]] = None,
        style: Optional[str] = None) -> Board
    func GetBoard(ctx *Context, name string, id IDInput, state *BoardState, opts ...ResourceOption) (*Board, error)
    public static Board Get(string name, Input<string> id, BoardState? state, CustomResourceOptions? opts = null)
    public static Board get(String name, Output<String> id, BoardState state, CustomResourceOptions options)
    resources:  _:    type: honeycombio:Board    get:      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:
    BoardId string
    ID of the board.
    BoardUrl string
    The URL to the board in the Honeycomb UI.
    ColumnLayout string
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    Description string
    Description of the board. Supports Markdown.
    Name string
    Name of the board.
    Queries List<BoardQuery>
    Zero or more configurations blocks (described below) with the queries of the board.
    Slos List<BoardSlo>
    Up to six configuration blocks (described below) to place SLOs on the board.
    Style string
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    BoardId string
    ID of the board.
    BoardUrl string
    The URL to the board in the Honeycomb UI.
    ColumnLayout string
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    Description string
    Description of the board. Supports Markdown.
    Name string
    Name of the board.
    Queries []BoardQueryArgs
    Zero or more configurations blocks (described below) with the queries of the board.
    Slos []BoardSloArgs
    Up to six configuration blocks (described below) to place SLOs on the board.
    Style string
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    boardId String
    ID of the board.
    boardUrl String
    The URL to the board in the Honeycomb UI.
    columnLayout String
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    description String
    Description of the board. Supports Markdown.
    name String
    Name of the board.
    queries List<BoardQuery>
    Zero or more configurations blocks (described below) with the queries of the board.
    slos List<BoardSlo>
    Up to six configuration blocks (described below) to place SLOs on the board.
    style String
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    boardId string
    ID of the board.
    boardUrl string
    The URL to the board in the Honeycomb UI.
    columnLayout string
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    description string
    Description of the board. Supports Markdown.
    name string
    Name of the board.
    queries BoardQuery[]
    Zero or more configurations blocks (described below) with the queries of the board.
    slos BoardSlo[]
    Up to six configuration blocks (described below) to place SLOs on the board.
    style string
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    board_id str
    ID of the board.
    board_url str
    The URL to the board in the Honeycomb UI.
    column_layout str
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    description str
    Description of the board. Supports Markdown.
    name str
    Name of the board.
    queries Sequence[BoardQueryArgs]
    Zero or more configurations blocks (described below) with the queries of the board.
    slos Sequence[BoardSloArgs]
    Up to six configuration blocks (described below) to place SLOs on the board.
    style str
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    boardId String
    ID of the board.
    boardUrl String
    The URL to the board in the Honeycomb UI.
    columnLayout String
    the number of columns to layout on the board, either multi (the default) or single. Only visual style boards (see below) have a column layout.
    description String
    Description of the board. Supports Markdown.
    name String
    Name of the board.
    queries List<Property Map>
    Zero or more configurations blocks (described below) with the queries of the board.
    slos List<Property Map>
    Up to six configuration blocks (described below) to place SLOs on the board.
    style String
    Deprecated: All Boards are now displayed as visual style. How the board should be displayed in the UI, either visual (the default) or list.

    Deprecated: Deprecated

    Supporting Types

    BoardQuery, BoardQueryArgs

    QueryId string
    The ID of the Query to run.
    Caption string
    Descriptive text to contextualize the Query within the Board. Supports Markdown.
    Dataset string
    The dataset this query is associated with.

    Deprecated: Deprecated

    GraphSettings BoardQueryGraphSettings
    A map of boolean toggles to manages the settings for this query's graph on the board. If a value is unspecified, it is assumed to be false. Currently supported toggles are:
    QueryAnnotationId string
    The ID of the Query Annotation to associate with this query.
    QueryStyle string
    How the query should be displayed within the board, either graph (the default), table or combo.
    QueryId string
    The ID of the Query to run.
    Caption string
    Descriptive text to contextualize the Query within the Board. Supports Markdown.
    Dataset string
    The dataset this query is associated with.

    Deprecated: Deprecated

    GraphSettings BoardQueryGraphSettings
    A map of boolean toggles to manages the settings for this query's graph on the board. If a value is unspecified, it is assumed to be false. Currently supported toggles are:
    QueryAnnotationId string
    The ID of the Query Annotation to associate with this query.
    QueryStyle string
    How the query should be displayed within the board, either graph (the default), table or combo.
    queryId String
    The ID of the Query to run.
    caption String
    Descriptive text to contextualize the Query within the Board. Supports Markdown.
    dataset String
    The dataset this query is associated with.

    Deprecated: Deprecated

    graphSettings BoardQueryGraphSettings
    A map of boolean toggles to manages the settings for this query's graph on the board. If a value is unspecified, it is assumed to be false. Currently supported toggles are:
    queryAnnotationId String
    The ID of the Query Annotation to associate with this query.
    queryStyle String
    How the query should be displayed within the board, either graph (the default), table or combo.
    queryId string
    The ID of the Query to run.
    caption string
    Descriptive text to contextualize the Query within the Board. Supports Markdown.
    dataset string
    The dataset this query is associated with.

    Deprecated: Deprecated

    graphSettings BoardQueryGraphSettings
    A map of boolean toggles to manages the settings for this query's graph on the board. If a value is unspecified, it is assumed to be false. Currently supported toggles are:
    queryAnnotationId string
    The ID of the Query Annotation to associate with this query.
    queryStyle string
    How the query should be displayed within the board, either graph (the default), table or combo.
    query_id str
    The ID of the Query to run.
    caption str
    Descriptive text to contextualize the Query within the Board. Supports Markdown.
    dataset str
    The dataset this query is associated with.

    Deprecated: Deprecated

    graph_settings BoardQueryGraphSettings
    A map of boolean toggles to manages the settings for this query's graph on the board. If a value is unspecified, it is assumed to be false. Currently supported toggles are:
    query_annotation_id str
    The ID of the Query Annotation to associate with this query.
    query_style str
    How the query should be displayed within the board, either graph (the default), table or combo.
    queryId String
    The ID of the Query to run.
    caption String
    Descriptive text to contextualize the Query within the Board. Supports Markdown.
    dataset String
    The dataset this query is associated with.

    Deprecated: Deprecated

    graphSettings Property Map
    A map of boolean toggles to manages the settings for this query's graph on the board. If a value is unspecified, it is assumed to be false. Currently supported toggles are:
    queryAnnotationId String
    The ID of the Query Annotation to associate with this query.
    queryStyle String
    How the query should be displayed within the board, either graph (the default), table or combo.

    BoardQueryGraphSettings, BoardQueryGraphSettingsArgs

    HideMarkers bool
    Disable the overlay of Markers on the graph.
    LogScale bool
    Set the graph's Y axis to Log scale.
    OmitMissingValues bool
    Enable interpolatation between datapoints when the intervening time buckets have no matching events.
    OverlaidCharts bool
    See Graph Settings in the documentation for more information on any individual setting.
    StackedGraphs bool
    Enable the display of groups as stacked colored area under their line graphs.
    UtcXaxis bool
    Set the graph's X axis to UTC.
    HideMarkers bool
    Disable the overlay of Markers on the graph.
    LogScale bool
    Set the graph's Y axis to Log scale.
    OmitMissingValues bool
    Enable interpolatation between datapoints when the intervening time buckets have no matching events.
    OverlaidCharts bool
    See Graph Settings in the documentation for more information on any individual setting.
    StackedGraphs bool
    Enable the display of groups as stacked colored area under their line graphs.
    UtcXaxis bool
    Set the graph's X axis to UTC.
    hideMarkers Boolean
    Disable the overlay of Markers on the graph.
    logScale Boolean
    Set the graph's Y axis to Log scale.
    omitMissingValues Boolean
    Enable interpolatation between datapoints when the intervening time buckets have no matching events.
    overlaidCharts Boolean
    See Graph Settings in the documentation for more information on any individual setting.
    stackedGraphs Boolean
    Enable the display of groups as stacked colored area under their line graphs.
    utcXaxis Boolean
    Set the graph's X axis to UTC.
    hideMarkers boolean
    Disable the overlay of Markers on the graph.
    logScale boolean
    Set the graph's Y axis to Log scale.
    omitMissingValues boolean
    Enable interpolatation between datapoints when the intervening time buckets have no matching events.
    overlaidCharts boolean
    See Graph Settings in the documentation for more information on any individual setting.
    stackedGraphs boolean
    Enable the display of groups as stacked colored area under their line graphs.
    utcXaxis boolean
    Set the graph's X axis to UTC.
    hide_markers bool
    Disable the overlay of Markers on the graph.
    log_scale bool
    Set the graph's Y axis to Log scale.
    omit_missing_values bool
    Enable interpolatation between datapoints when the intervening time buckets have no matching events.
    overlaid_charts bool
    See Graph Settings in the documentation for more information on any individual setting.
    stacked_graphs bool
    Enable the display of groups as stacked colored area under their line graphs.
    utc_xaxis bool
    Set the graph's X axis to UTC.
    hideMarkers Boolean
    Disable the overlay of Markers on the graph.
    logScale Boolean
    Set the graph's Y axis to Log scale.
    omitMissingValues Boolean
    Enable interpolatation between datapoints when the intervening time buckets have no matching events.
    overlaidCharts Boolean
    See Graph Settings in the documentation for more information on any individual setting.
    stackedGraphs Boolean
    Enable the display of groups as stacked colored area under their line graphs.
    utcXaxis Boolean
    Set the graph's X axis to UTC.

    BoardSlo, BoardSloArgs

    Id string
    The ID of the SLO to place on the board.
    Id string
    The ID of the SLO to place on the board.
    id String
    The ID of the SLO to place on the board.
    id string
    The ID of the SLO to place on the board.
    id str
    The ID of the SLO to place on the board.
    id String
    The ID of the SLO to place on the board.

    Import

    Boards can be imported using their ID, e.g.

    $ pulumi import honeycombio:index/board:Board my_board AobW9oAZX71

    You can find the ID in the URL bar when visiting the board from the UI.

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

    Package Details

    Repository
    honeycombio honeycombio/terraform-provider-honeycombio
    License
    Notes
    This Pulumi package is based on the honeycombio Terraform Provider.
    honeycombio logo
    honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
    honeycombio/terraform-provider-honeycombio