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

honeycombio.Dataset

Explore with Pulumi AI

# Resource: honeycombio.Dataset

Creates a Dataset in an Environment.

Warning Prior to version 0.27.0 of the provider, datasets were not deleted on destroy but left in place and only removed from state.

Example Usage

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

const myDataset = new honeycombio.Dataset("myDataset", {description: "buzzing with data"});
Copy
import pulumi
import pulumi_honeycombio as honeycombio

my_dataset = honeycombio.Dataset("myDataset", description="buzzing with data")
Copy
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.NewDataset(ctx, "myDataset", &honeycombio.DatasetArgs{
			Description: pulumi.String("buzzing with data"),
		})
		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 myDataset = new Honeycombio.Dataset("myDataset", new()
    {
        Description = "buzzing with data",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.Dataset;
import com.pulumi.honeycombio.DatasetArgs;
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 myDataset = new Dataset("myDataset", DatasetArgs.builder()
            .description("buzzing with data")
            .build());

    }
}
Copy
resources:
  myDataset:
    type: honeycombio:Dataset
    properties:
      description: buzzing with data
Copy

Create Dataset Resource

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

Constructor syntax

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

@overload
def Dataset(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            delete_protected: Optional[bool] = None,
            description: Optional[str] = None,
            expand_json_depth: Optional[float] = None,
            name: Optional[str] = None)
func NewDataset(ctx *Context, name string, args *DatasetArgs, opts ...ResourceOption) (*Dataset, error)
public Dataset(string name, DatasetArgs? args = null, CustomResourceOptions? opts = null)
public Dataset(String name, DatasetArgs args)
public Dataset(String name, DatasetArgs args, CustomResourceOptions options)
type: honeycombio:Dataset
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 DatasetArgs
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 DatasetArgs
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 DatasetArgs
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 DatasetArgs
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. DatasetArgs
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 datasetResource = new Honeycombio.Dataset("datasetResource", new()
{
    DeleteProtected = false,
    Description = "string",
    ExpandJsonDepth = 0,
    Name = "string",
});
Copy
example, err := honeycombio.NewDataset(ctx, "datasetResource", &honeycombio.DatasetArgs{
DeleteProtected: pulumi.Bool(false),
Description: pulumi.String("string"),
ExpandJsonDepth: pulumi.Float64(0),
Name: pulumi.String("string"),
})
Copy
var datasetResource = new Dataset("datasetResource", DatasetArgs.builder()
    .deleteProtected(false)
    .description("string")
    .expandJsonDepth(0)
    .name("string")
    .build());
Copy
dataset_resource = honeycombio.Dataset("datasetResource",
    delete_protected=False,
    description="string",
    expand_json_depth=0,
    name="string")
Copy
const datasetResource = new honeycombio.Dataset("datasetResource", {
    deleteProtected: false,
    description: "string",
    expandJsonDepth: 0,
    name: "string",
});
Copy
type: honeycombio:Dataset
properties:
    deleteProtected: false
    description: string
    expandJsonDepth: 0
    name: string
Copy

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

DeleteProtected bool
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
Description string
A longer description for dataset.
ExpandJsonDepth double
The maximum unpacking depth of nested JSON fields.
Name string
The name of the dataset.
DeleteProtected bool
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
Description string
A longer description for dataset.
ExpandJsonDepth float64
The maximum unpacking depth of nested JSON fields.
Name string
The name of the dataset.
deleteProtected Boolean
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
description String
A longer description for dataset.
expandJsonDepth Double
The maximum unpacking depth of nested JSON fields.
name String
The name of the dataset.
deleteProtected boolean
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
description string
A longer description for dataset.
expandJsonDepth number
The maximum unpacking depth of nested JSON fields.
name string
The name of the dataset.
delete_protected bool
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
description str
A longer description for dataset.
expand_json_depth float
The maximum unpacking depth of nested JSON fields.
name str
The name of the dataset.
deleteProtected Boolean
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
description String
A longer description for dataset.
expandJsonDepth Number
The maximum unpacking depth of nested JSON fields.
name String
The name of the dataset.

Outputs

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

CreatedAt string
ISO8601-formatted time the dataset was created
Id string
The provider-assigned unique ID for this managed resource.
LastWrittenAt string
ISO8601-formatted time the dataset was last written to (received event data)
Slug string
The slug of the dataset.
CreatedAt string
ISO8601-formatted time the dataset was created
Id string
The provider-assigned unique ID for this managed resource.
LastWrittenAt string
ISO8601-formatted time the dataset was last written to (received event data)
Slug string
The slug of the dataset.
createdAt String
ISO8601-formatted time the dataset was created
id String
The provider-assigned unique ID for this managed resource.
lastWrittenAt String
ISO8601-formatted time the dataset was last written to (received event data)
slug String
The slug of the dataset.
createdAt string
ISO8601-formatted time the dataset was created
id string
The provider-assigned unique ID for this managed resource.
lastWrittenAt string
ISO8601-formatted time the dataset was last written to (received event data)
slug string
The slug of the dataset.
created_at str
ISO8601-formatted time the dataset was created
id str
The provider-assigned unique ID for this managed resource.
last_written_at str
ISO8601-formatted time the dataset was last written to (received event data)
slug str
The slug of the dataset.
createdAt String
ISO8601-formatted time the dataset was created
id String
The provider-assigned unique ID for this managed resource.
lastWrittenAt String
ISO8601-formatted time the dataset was last written to (received event data)
slug String
The slug of the dataset.

Look up Existing Dataset Resource

Get an existing Dataset 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?: DatasetState, opts?: CustomResourceOptions): Dataset
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        delete_protected: Optional[bool] = None,
        description: Optional[str] = None,
        expand_json_depth: Optional[float] = None,
        last_written_at: Optional[str] = None,
        name: Optional[str] = None,
        slug: Optional[str] = None) -> Dataset
func GetDataset(ctx *Context, name string, id IDInput, state *DatasetState, opts ...ResourceOption) (*Dataset, error)
public static Dataset Get(string name, Input<string> id, DatasetState? state, CustomResourceOptions? opts = null)
public static Dataset get(String name, Output<String> id, DatasetState state, CustomResourceOptions options)
resources:  _:    type: honeycombio:Dataset    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:
CreatedAt string
ISO8601-formatted time the dataset was created
DeleteProtected bool
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
Description string
A longer description for dataset.
ExpandJsonDepth double
The maximum unpacking depth of nested JSON fields.
LastWrittenAt string
ISO8601-formatted time the dataset was last written to (received event data)
Name string
The name of the dataset.
Slug string
The slug of the dataset.
CreatedAt string
ISO8601-formatted time the dataset was created
DeleteProtected bool
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
Description string
A longer description for dataset.
ExpandJsonDepth float64
The maximum unpacking depth of nested JSON fields.
LastWrittenAt string
ISO8601-formatted time the dataset was last written to (received event data)
Name string
The name of the dataset.
Slug string
The slug of the dataset.
createdAt String
ISO8601-formatted time the dataset was created
deleteProtected Boolean
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
description String
A longer description for dataset.
expandJsonDepth Double
The maximum unpacking depth of nested JSON fields.
lastWrittenAt String
ISO8601-formatted time the dataset was last written to (received event data)
name String
The name of the dataset.
slug String
The slug of the dataset.
createdAt string
ISO8601-formatted time the dataset was created
deleteProtected boolean
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
description string
A longer description for dataset.
expandJsonDepth number
The maximum unpacking depth of nested JSON fields.
lastWrittenAt string
ISO8601-formatted time the dataset was last written to (received event data)
name string
The name of the dataset.
slug string
The slug of the dataset.
created_at str
ISO8601-formatted time the dataset was created
delete_protected bool
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
description str
A longer description for dataset.
expand_json_depth float
The maximum unpacking depth of nested JSON fields.
last_written_at str
ISO8601-formatted time the dataset was last written to (received event data)
name str
The name of the dataset.
slug str
The slug of the dataset.
createdAt String
ISO8601-formatted time the dataset was created
deleteProtected Boolean
the current state of the Dataset's deletion protection status. Defaults to true. Cannot be set to false on create.
description String
A longer description for dataset.
expandJsonDepth Number
The maximum unpacking depth of nested JSON fields.
lastWrittenAt String
ISO8601-formatted time the dataset was last written to (received event data)
name String
The name of the dataset.
slug String
The slug of the dataset.

Import

Datasets can be imported by their slug, e.g.

$ pulumi import honeycombio:index/dataset:Dataset my_dataset my-dataset
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.