1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. DerivedColumn
honeycombio 0.32.0 published on Monday, Apr 7, 2025 by honeycombio

honeycombio.DerivedColumn

Explore with Pulumi AI

# Resource: honeycombio.DerivedColumn

Creates a derived column. For more information about derived columns, check out Calculate with derived columns.

Example Usage

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

const config = new pulumi.Config();
const dataset = config.require("dataset");
const durationMsLog = new honeycombio.DerivedColumn("durationMsLog", {
    alias: "duration_ms_log10",
    expression: "LOG10($duration_ms)",
    description: "LOG10 of duration_ms",
    dataset: dataset,
});
Copy
import pulumi
import pulumi_honeycombio as honeycombio

config = pulumi.Config()
dataset = config.require("dataset")
duration_ms_log = honeycombio.DerivedColumn("durationMsLog",
    alias="duration_ms_log10",
    expression="LOG10($duration_ms)",
    description="LOG10 of duration_ms",
    dataset=dataset)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		dataset := cfg.Require("dataset")
		_, err := honeycombio.NewDerivedColumn(ctx, "durationMsLog", &honeycombio.DerivedColumnArgs{
			Alias:       pulumi.String("duration_ms_log10"),
			Expression:  pulumi.String("LOG10($duration_ms)"),
			Description: pulumi.String("LOG10 of duration_ms"),
			Dataset:     pulumi.String(dataset),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var dataset = config.Require("dataset");
    var durationMsLog = new Honeycombio.DerivedColumn("durationMsLog", new()
    {
        Alias = "duration_ms_log10",
        Expression = "LOG10($duration_ms)",
        Description = "LOG10 of duration_ms",
        Dataset = dataset,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.DerivedColumn;
import com.pulumi.honeycombio.DerivedColumnArgs;
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 config = ctx.config();
        final var dataset = config.get("dataset");
        var durationMsLog = new DerivedColumn("durationMsLog", DerivedColumnArgs.builder()
            .alias("duration_ms_log10")
            .expression("LOG10($duration_ms)")
            .description("LOG10 of duration_ms")
            .dataset(dataset)
            .build());

    }
}
Copy
configuration:
  dataset:
    type: string
resources:
  durationMsLog:
    type: honeycombio:DerivedColumn
    properties:
      alias: duration_ms_log10
      expression: LOG10($duration_ms)
      description: LOG10 of duration_ms
      dataset: ${dataset}
Copy

Create DerivedColumn Resource

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

Constructor syntax

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

@overload
def DerivedColumn(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  alias: Optional[str] = None,
                  expression: Optional[str] = None,
                  dataset: Optional[str] = None,
                  derived_column_id: Optional[str] = None,
                  description: Optional[str] = None)
func NewDerivedColumn(ctx *Context, name string, args DerivedColumnArgs, opts ...ResourceOption) (*DerivedColumn, error)
public DerivedColumn(string name, DerivedColumnArgs args, CustomResourceOptions? opts = null)
public DerivedColumn(String name, DerivedColumnArgs args)
public DerivedColumn(String name, DerivedColumnArgs args, CustomResourceOptions options)
type: honeycombio:DerivedColumn
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DerivedColumnArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DerivedColumnArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DerivedColumnArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DerivedColumnArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DerivedColumnArgs
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 derivedColumnResource = new Honeycombio.DerivedColumn("derivedColumnResource", new()
{
    Alias = "string",
    Expression = "string",
    Dataset = "string",
    DerivedColumnId = "string",
    Description = "string",
});
Copy
example, err := honeycombio.NewDerivedColumn(ctx, "derivedColumnResource", &honeycombio.DerivedColumnArgs{
Alias: pulumi.String("string"),
Expression: pulumi.String("string"),
Dataset: pulumi.String("string"),
DerivedColumnId: pulumi.String("string"),
Description: pulumi.String("string"),
})
Copy
var derivedColumnResource = new DerivedColumn("derivedColumnResource", DerivedColumnArgs.builder()
    .alias("string")
    .expression("string")
    .dataset("string")
    .derivedColumnId("string")
    .description("string")
    .build());
Copy
derived_column_resource = honeycombio.DerivedColumn("derivedColumnResource",
    alias="string",
    expression="string",
    dataset="string",
    derived_column_id="string",
    description="string")
Copy
const derivedColumnResource = new honeycombio.DerivedColumn("derivedColumnResource", {
    alias: "string",
    expression: "string",
    dataset: "string",
    derivedColumnId: "string",
    description: "string",
});
Copy
type: honeycombio:DerivedColumn
properties:
    alias: string
    dataset: string
    derivedColumnId: string
    description: string
    expression: string
Copy

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

Alias This property is required. string
The name of the derived column. Must be unique per dataset.
Expression This property is required. string
The formula of the derived column. See Derived Column Syntax.
Dataset string
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
DerivedColumnId string
ID of the derived column.
Description string
A description that is shown in the UI.
Alias This property is required. string
The name of the derived column. Must be unique per dataset.
Expression This property is required. string
The formula of the derived column. See Derived Column Syntax.
Dataset string
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
DerivedColumnId string
ID of the derived column.
Description string
A description that is shown in the UI.
alias This property is required. String
The name of the derived column. Must be unique per dataset.
expression This property is required. String
The formula of the derived column. See Derived Column Syntax.
dataset String
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
derivedColumnId String
ID of the derived column.
description String
A description that is shown in the UI.
alias This property is required. string
The name of the derived column. Must be unique per dataset.
expression This property is required. string
The formula of the derived column. See Derived Column Syntax.
dataset string
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
derivedColumnId string
ID of the derived column.
description string
A description that is shown in the UI.
alias This property is required. str
The name of the derived column. Must be unique per dataset.
expression This property is required. str
The formula of the derived column. See Derived Column Syntax.
dataset str
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
derived_column_id str
ID of the derived column.
description str
A description that is shown in the UI.
alias This property is required. String
The name of the derived column. Must be unique per dataset.
expression This property is required. String
The formula of the derived column. See Derived Column Syntax.
dataset String
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
derivedColumnId String
ID of the derived column.
description String
A description that is shown in the UI.

Outputs

All input properties are implicitly available as output properties. Additionally, the DerivedColumn 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 str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing DerivedColumn Resource

Get an existing DerivedColumn 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?: DerivedColumnState, opts?: CustomResourceOptions): DerivedColumn
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias: Optional[str] = None,
        dataset: Optional[str] = None,
        derived_column_id: Optional[str] = None,
        description: Optional[str] = None,
        expression: Optional[str] = None) -> DerivedColumn
func GetDerivedColumn(ctx *Context, name string, id IDInput, state *DerivedColumnState, opts ...ResourceOption) (*DerivedColumn, error)
public static DerivedColumn Get(string name, Input<string> id, DerivedColumnState? state, CustomResourceOptions? opts = null)
public static DerivedColumn get(String name, Output<String> id, DerivedColumnState state, CustomResourceOptions options)
resources:  _:    type: honeycombio:DerivedColumn    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Alias string
The name of the derived column. Must be unique per dataset.
Dataset string
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
DerivedColumnId string
ID of the derived column.
Description string
A description that is shown in the UI.
Expression string
The formula of the derived column. See Derived Column Syntax.
Alias string
The name of the derived column. Must be unique per dataset.
Dataset string
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
DerivedColumnId string
ID of the derived column.
Description string
A description that is shown in the UI.
Expression string
The formula of the derived column. See Derived Column Syntax.
alias String
The name of the derived column. Must be unique per dataset.
dataset String
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
derivedColumnId String
ID of the derived column.
description String
A description that is shown in the UI.
expression String
The formula of the derived column. See Derived Column Syntax.
alias string
The name of the derived column. Must be unique per dataset.
dataset string
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
derivedColumnId string
ID of the derived column.
description string
A description that is shown in the UI.
expression string
The formula of the derived column. See Derived Column Syntax.
alias str
The name of the derived column. Must be unique per dataset.
dataset str
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
derived_column_id str
ID of the derived column.
description str
A description that is shown in the UI.
expression str
The formula of the derived column. See Derived Column Syntax.
alias String
The name of the derived column. Must be unique per dataset.
dataset String
The dataset this derived column is added to. If not set, an Environment-wide derived column will be created.
derivedColumnId String
ID of the derived column.
description String
A description that is shown in the UI.
expression String
The formula of the derived column. See Derived Column Syntax.

Import

Derived columns can be imported using a combination of the dataset name and their alias, e.g.

$ pulumi import honeycombio:index/derivedColumn:DerivedColumn my_column my-dataset/duration_ms_log10
Copy

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.