1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. DatasetDefinition
Honeycomb 0.45.0 published on Tuesday, Jan 6, 2026 by honeycombio
Schema (JSON)
honeycombio/terraform-provider-honeycombio

honeycombio.DatasetDefinition

honeycombio logo
Honeycomb 0.45.0 published on Tuesday, Jan 6, 2026 by honeycombio
Schema (JSON)
honeycombio/terraform-provider-honeycombio

    # Resource:<span pulumi-lang-nodejs=" honeycombio.DatasetDefinition

    " pulumi-lang-dotnet=" honeycombio.DatasetDefinition " pulumi-lang-go=" DatasetDefinition " pulumi-lang-python=" DatasetDefinition " pulumi-lang-yaml=" honeycombio.DatasetDefinition " pulumi-lang-java=" honeycombio.DatasetDefinition “> honeycombio.DatasetDefinition Dataset Definitions define the fields in your Dataset that have special meaning.

    Some Dataset Definitions are automatically set when a dataset is created or first receives an event.

    Example Usage

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

const traceId = new honeycombio.DatasetDefinition("trace_id", {
    dataset: dataset,
    name: "trace_id",
    column: "trace.trace_id",
});

    import pulumi
import pulumi_honeycombio as honeycombio

trace_id = honeycombio.DatasetDefinition("trace_id",
    dataset=dataset,
    name="trace_id",
    column="trace.trace_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 {
		_, err := honeycombio.NewDatasetDefinition(ctx, "trace_id", &honeycombio.DatasetDefinitionArgs{
			Dataset: pulumi.Any(dataset),
			Name:    pulumi.String("trace_id"),
			Column:  pulumi.String("trace.trace_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 traceId = new Honeycombio.DatasetDefinition("trace_id", new()
    {
        Dataset = dataset,
        Name = "trace_id",
        Column = "trace.trace_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.DatasetDefinition;
import com.pulumi.honeycombio.DatasetDefinitionArgs;
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 traceId = new DatasetDefinition("traceId", DatasetDefinitionArgs.builder()
            .dataset(dataset)
            .name("trace_id")
            .column("trace.trace_id")
            .build());

    }
}

    resources:
  traceId:
    type: honeycombio:DatasetDefinition
    name: trace_id
    properties:
      dataset: ${dataset}
      name: trace_id
      column: trace.trace_id

    Create DatasetDefinition Resource

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

    Constructor syntax

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

@overload
def DatasetDefinition(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      column: Optional[str] = None,
                      dataset: Optional[str] = None,
                      dataset_definition_id: Optional[str] = None,
                      name: Optional[str] = None)
    func NewDatasetDefinition(ctx *Context, name string, args DatasetDefinitionArgs, opts ...ResourceOption) (*DatasetDefinition, error)
    public DatasetDefinition(string name, DatasetDefinitionArgs args, CustomResourceOptions? opts = null)
    public DatasetDefinition(String name, DatasetDefinitionArgs args)
public DatasetDefinition(String name, DatasetDefinitionArgs args, CustomResourceOptions options)

    type: honeycombio:DatasetDefinition
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 DatasetDefinitionArgs
    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 DatasetDefinitionArgs
    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 DatasetDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatasetDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatasetDefinitionArgs
    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 datasetDefinitionResource = new Honeycombio.DatasetDefinition("datasetDefinitionResource", new()
{
    Column = "string",
    Dataset = "string",
    DatasetDefinitionId = "string",
    Name = "string",
});

    example, err := honeycombio.NewDatasetDefinition(ctx, "datasetDefinitionResource", &honeycombio.DatasetDefinitionArgs{
	Column:              pulumi.String("string"),
	Dataset:             pulumi.String("string"),
	DatasetDefinitionId: pulumi.String("string"),
	Name:                pulumi.String("string"),
})

    var datasetDefinitionResource = new DatasetDefinition("datasetDefinitionResource", DatasetDefinitionArgs.builder()
    .column("string")
    .dataset("string")
    .datasetDefinitionId("string")
    .name("string")
    .build());

    dataset_definition_resource = honeycombio.DatasetDefinition("datasetDefinitionResource",
    column="string",
    dataset="string",
    dataset_definition_id="string",
    name="string")

    const datasetDefinitionResource = new honeycombio.DatasetDefinition("datasetDefinitionResource", {
    column: "string",
    dataset: "string",
    datasetDefinitionId: "string",
    name: "string",
});

    type: honeycombio:DatasetDefinition
properties:
    column: string
    dataset: string
    datasetDefinitionId: string
    name: string

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

    Column string
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    Dataset string
    The dataset to set the Dataset Definition for.
    DatasetDefinitionId string
    The ID of this resource.
    Name string
    The name of the definition being set.
    Column string
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    Dataset string
    The dataset to set the Dataset Definition for.
    DatasetDefinitionId string
    The ID of this resource.
    Name string
    The name of the definition being set.
    column String
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    dataset String
    The dataset to set the Dataset Definition for.
    datasetDefinitionId String
    The ID of this resource.
    name String
    The name of the definition being set.
    column string
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    dataset string
    The dataset to set the Dataset Definition for.
    datasetDefinitionId string
    The ID of this resource.
    name string
    The name of the definition being set.
    column str
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    dataset str
    The dataset to set the Dataset Definition for.
    dataset_definition_id str
    The ID of this resource.
    name str
    The name of the definition being set.
    column String
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    dataset String
    The dataset to set the Dataset Definition for.
    datasetDefinitionId String
    The ID of this resource.
    name String
    The name of the definition being set.

    Outputs

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

    ColumnType string
    The type of the column assigned to the definition. Either column or derived_column.
    Id string
    The provider-assigned unique ID for this managed resource.
    ColumnType string
    The type of the column assigned to the definition. Either column or derived_column.
    Id string
    The provider-assigned unique ID for this managed resource.
    columnType String
    The type of the column assigned to the definition. Either column or derived_column.
    id String
    The provider-assigned unique ID for this managed resource.
    columnType string
    The type of the column assigned to the definition. Either column or derived_column.
    id string
    The provider-assigned unique ID for this managed resource.
    column_type str
    The type of the column assigned to the definition. Either column or derived_column.
    id str
    The provider-assigned unique ID for this managed resource.
    columnType String
    The type of the column assigned to the definition. Either column or derived_column.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DatasetDefinition Resource

    Get an existing DatasetDefinition 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?: DatasetDefinitionState, opts?: CustomResourceOptions): DatasetDefinition
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        column: Optional[str] = None,
        column_type: Optional[str] = None,
        dataset: Optional[str] = None,
        dataset_definition_id: Optional[str] = None,
        name: Optional[str] = None) -> DatasetDefinition
    func GetDatasetDefinition(ctx *Context, name string, id IDInput, state *DatasetDefinitionState, opts ...ResourceOption) (*DatasetDefinition, error)
    public static DatasetDefinition Get(string name, Input<string> id, DatasetDefinitionState? state, CustomResourceOptions? opts = null)
    public static DatasetDefinition get(String name, Output<String> id, DatasetDefinitionState state, CustomResourceOptions options)
    resources:  _:    type: honeycombio:DatasetDefinition    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:
    Column string
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    ColumnType string
    The type of the column assigned to the definition. Either column or derived_column.
    Dataset string
    The dataset to set the Dataset Definition for.
    DatasetDefinitionId string
    The ID of this resource.
    Name string
    The name of the definition being set.
    Column string
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    ColumnType string
    The type of the column assigned to the definition. Either column or derived_column.
    Dataset string
    The dataset to set the Dataset Definition for.
    DatasetDefinitionId string
    The ID of this resource.
    Name string
    The name of the definition being set.
    column String
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    columnType String
    The type of the column assigned to the definition. Either column or derived_column.
    dataset String
    The dataset to set the Dataset Definition for.
    datasetDefinitionId String
    The ID of this resource.
    name String
    The name of the definition being set.
    column string
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    columnType string
    The type of the column assigned to the definition. Either column or derived_column.
    dataset string
    The dataset to set the Dataset Definition for.
    datasetDefinitionId string
    The ID of this resource.
    name string
    The name of the definition being set.
    column str
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    column_type str
    The type of the column assigned to the definition. Either column or derived_column.
    dataset str
    The dataset to set the Dataset Definition for.
    dataset_definition_id str
    The ID of this resource.
    name str
    The name of the definition being set.
    column String
    The column to set the definition to. Must be the name of an existing Column or the alias of an existing Derived Column.
    columnType String
    The type of the column assigned to the definition. Either column or derived_column.
    dataset String
    The dataset to set the Dataset Definition for.
    datasetDefinitionId String
    The ID of this resource.
    name String
    The name of the definition being set.

    Import

    Dataset Definitions cannot be imported.

    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
    Honeycomb 0.45.0 published on Tuesday, Jan 6, 2026 by honeycombio
    Schema (JSON)
    honeycombio/terraform-provider-honeycombio
      Meet Neo: Your AI Platform Teammate