honeycombio.Column
Explore with Pulumi AI
# Resource: honeycombio.Column
Provides a Honeycomb Column resource. This can be used to create, update, and delete columns in a dataset.
Warning Deleting a column is a destructive and irreversible operation which also removes the data in the column.
Version 0.38 and later of the Honeycomb Provider include a Feature Toggle which allows the column to be imported and updated automatically if there is a conflict during create instead of throwing an error. This is potentially dangerous if the type changes on the update – switching from
string
toboolean
and causing dataloss, for example – and should be used with caution.
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 durationMs = new honeycombio.Column("durationMs", {
type: "float",
description: "Duration of the trace",
dataset: dataset,
});
import pulumi
import pulumi_honeycombio as honeycombio
config = pulumi.Config()
dataset = config.require("dataset")
duration_ms = honeycombio.Column("durationMs",
type="float",
description="Duration of the trace",
dataset=dataset)
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.NewColumn(ctx, "durationMs", &honeycombio.ColumnArgs{
Type: pulumi.String("float"),
Description: pulumi.String("Duration of the trace"),
Dataset: pulumi.String(dataset),
})
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 config = new Config();
var dataset = config.Require("dataset");
var durationMs = new Honeycombio.Column("durationMs", new()
{
Type = "float",
Description = "Duration of the trace",
Dataset = dataset,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.Column;
import com.pulumi.honeycombio.ColumnArgs;
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 durationMs = new Column("durationMs", ColumnArgs.builder()
.type("float")
.description("Duration of the trace")
.dataset(dataset)
.build());
}
}
configuration:
dataset:
type: string
resources:
durationMs:
type: honeycombio:Column
properties:
type: float
description: Duration of the trace
dataset: ${dataset}
Create Column Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Column(name: string, args: ColumnArgs, opts?: CustomResourceOptions);
@overload
def Column(resource_name: str,
args: ColumnArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Column(resource_name: str,
opts: Optional[ResourceOptions] = None,
dataset: Optional[str] = None,
description: Optional[str] = None,
hidden: Optional[bool] = None,
name: Optional[str] = None,
type: Optional[str] = None)
func NewColumn(ctx *Context, name string, args ColumnArgs, opts ...ResourceOption) (*Column, error)
public Column(string name, ColumnArgs args, CustomResourceOptions? opts = null)
public Column(String name, ColumnArgs args)
public Column(String name, ColumnArgs args, CustomResourceOptions options)
type: honeycombio:Column
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 ColumnArgs
- 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 ColumnArgs
- 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 ColumnArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ColumnArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ColumnArgs
- 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 columnResource = new Honeycombio.Column("columnResource", new()
{
Dataset = "string",
Description = "string",
Hidden = false,
Name = "string",
Type = "string",
});
example, err := honeycombio.NewColumn(ctx, "columnResource", &honeycombio.ColumnArgs{
Dataset: pulumi.String("string"),
Description: pulumi.String("string"),
Hidden: pulumi.Bool(false),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
})
var columnResource = new Column("columnResource", ColumnArgs.builder()
.dataset("string")
.description("string")
.hidden(false)
.name("string")
.type("string")
.build());
column_resource = honeycombio.Column("columnResource",
dataset="string",
description="string",
hidden=False,
name="string",
type="string")
const columnResource = new honeycombio.Column("columnResource", {
dataset: "string",
description: "string",
hidden: false,
name: "string",
type: "string",
});
type: honeycombio:Column
properties:
dataset: string
description: string
hidden: false
name: string
type: string
Column 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 Column resource accepts the following input properties:
- Dataset string
- The dataset this column is added to.
- Description string
- A description that is shown in the UI.
- bool
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- Name string
- The name of the column. Must be unique per dataset.
- Type string
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
.
- Dataset string
- The dataset this column is added to.
- Description string
- A description that is shown in the UI.
- bool
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- Name string
- The name of the column. Must be unique per dataset.
- Type string
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
.
- dataset String
- The dataset this column is added to.
- description String
- A description that is shown in the UI.
- Boolean
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- name String
- The name of the column. Must be unique per dataset.
- type String
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
.
- dataset string
- The dataset this column is added to.
- description string
- A description that is shown in the UI.
- boolean
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- name string
- The name of the column. Must be unique per dataset.
- type string
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
.
- dataset str
- The dataset this column is added to.
- description str
- A description that is shown in the UI.
- bool
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- name str
- The name of the column. Must be unique per dataset.
- type str
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
.
- dataset String
- The dataset this column is added to.
- description String
- A description that is shown in the UI.
- Boolean
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- name String
- The name of the column. Must be unique per dataset.
- type String
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
.
Outputs
All input properties are implicitly available as output properties. Additionally, the Column resource produces the following output properties:
- Created
At string - ISO8601 formatted time the column was created
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Written stringAt - ISO8601 formatted time the column was last written to (received event data)
- Updated
At string - ISO8601 formatted time the column was updated
- Created
At string - ISO8601 formatted time the column was created
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Written stringAt - ISO8601 formatted time the column was last written to (received event data)
- Updated
At string - ISO8601 formatted time the column was updated
- created
At String - ISO8601 formatted time the column was created
- id String
- The provider-assigned unique ID for this managed resource.
- last
Written StringAt - ISO8601 formatted time the column was last written to (received event data)
- updated
At String - ISO8601 formatted time the column was updated
- created
At string - ISO8601 formatted time the column was created
- id string
- The provider-assigned unique ID for this managed resource.
- last
Written stringAt - ISO8601 formatted time the column was last written to (received event data)
- updated
At string - ISO8601 formatted time the column was updated
- created_
at str - ISO8601 formatted time the column was created
- id str
- The provider-assigned unique ID for this managed resource.
- last_
written_ strat - ISO8601 formatted time the column was last written to (received event data)
- updated_
at str - ISO8601 formatted time the column was updated
- created
At String - ISO8601 formatted time the column was created
- id String
- The provider-assigned unique ID for this managed resource.
- last
Written StringAt - ISO8601 formatted time the column was last written to (received event data)
- updated
At String - ISO8601 formatted time the column was updated
Look up Existing Column Resource
Get an existing Column 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?: ColumnState, opts?: CustomResourceOptions): Column
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created_at: Optional[str] = None,
dataset: Optional[str] = None,
description: Optional[str] = None,
hidden: Optional[bool] = None,
last_written_at: Optional[str] = None,
name: Optional[str] = None,
type: Optional[str] = None,
updated_at: Optional[str] = None) -> Column
func GetColumn(ctx *Context, name string, id IDInput, state *ColumnState, opts ...ResourceOption) (*Column, error)
public static Column Get(string name, Input<string> id, ColumnState? state, CustomResourceOptions? opts = null)
public static Column get(String name, Output<String> id, ColumnState state, CustomResourceOptions options)
resources: _: type: honeycombio:Column 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.
- Created
At string - ISO8601 formatted time the column was created
- Dataset string
- The dataset this column is added to.
- Description string
- A description that is shown in the UI.
- bool
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- Last
Written stringAt - ISO8601 formatted time the column was last written to (received event data)
- Name string
- The name of the column. Must be unique per dataset.
- Type string
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
. - Updated
At string - ISO8601 formatted time the column was updated
- Created
At string - ISO8601 formatted time the column was created
- Dataset string
- The dataset this column is added to.
- Description string
- A description that is shown in the UI.
- bool
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- Last
Written stringAt - ISO8601 formatted time the column was last written to (received event data)
- Name string
- The name of the column. Must be unique per dataset.
- Type string
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
. - Updated
At string - ISO8601 formatted time the column was updated
- created
At String - ISO8601 formatted time the column was created
- dataset String
- The dataset this column is added to.
- description String
- A description that is shown in the UI.
- Boolean
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- last
Written StringAt - ISO8601 formatted time the column was last written to (received event data)
- name String
- The name of the column. Must be unique per dataset.
- type String
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
. - updated
At String - ISO8601 formatted time the column was updated
- created
At string - ISO8601 formatted time the column was created
- dataset string
- The dataset this column is added to.
- description string
- A description that is shown in the UI.
- boolean
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- last
Written stringAt - ISO8601 formatted time the column was last written to (received event data)
- name string
- The name of the column. Must be unique per dataset.
- type string
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
. - updated
At string - ISO8601 formatted time the column was updated
- created_
at str - ISO8601 formatted time the column was created
- dataset str
- The dataset this column is added to.
- description str
- A description that is shown in the UI.
- bool
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- last_
written_ strat - ISO8601 formatted time the column was last written to (received event data)
- name str
- The name of the column. Must be unique per dataset.
- type str
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
. - updated_
at str - ISO8601 formatted time the column was updated
- created
At String - ISO8601 formatted time the column was created
- dataset String
- The dataset this column is added to.
- description String
- A description that is shown in the UI.
- Boolean
- Whether this column should be hidden in the query builder and sample data. Defaults to false.
- last
Written StringAt - ISO8601 formatted time the column was last written to (received event data)
- name String
- The name of the column. Must be unique per dataset.
- type String
- The type of the column, allowed values are
string
,float
,integer
andboolean
. Defaults tostring
. - updated
At String - ISO8601 formatted time the column was updated
Import
Columns can be imported using a combination of the dataset name and their name, e.g.
$ pulumi import honeycombio:index/column:Column my_column my-dataset/duration_ms
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.