Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. DatasetDefinition
honeycombio 0.32.0 published on Monday, Apr 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

honeycombio.DatasetDefinition

Explore with Pulumi AI

honeycombio 0.32.0 published on Monday, Apr 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

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 This property is required. string
The unique name of the resource.
args This property is required. DatasetDefinitionArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. DatasetDefinitionArgs
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. DatasetDefinitionArgs
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. 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",
});
Copy
example, err := honeycombio.NewDatasetDefinition(ctx, "datasetDefinitionResource", &honeycombio.DatasetDefinitionArgs{
Column: pulumi.String("string"),
Dataset: pulumi.String("string"),
DatasetDefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
})
Copy
var datasetDefinitionResource = new DatasetDefinition("datasetDefinitionResource", DatasetDefinitionArgs.builder()
    .column("string")
    .dataset("string")
    .datasetDefinitionId("string")
    .name("string")
    .build());
Copy
dataset_definition_resource = honeycombio.DatasetDefinition("datasetDefinitionResource",
    column="string",
    dataset="string",
    dataset_definition_id="string",
    name="string")
Copy
const datasetDefinitionResource = new honeycombio.DatasetDefinition("datasetDefinitionResource", {
    column: "string",
    dataset: "string",
    datasetDefinitionId: "string",
    name: "string",
});
Copy
type: honeycombio:DatasetDefinition
properties:
    column: string
    dataset: string
    datasetDefinitionId: string
    name: string
Copy

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 This property is required. 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 This property is required. string
The dataset to set the Dataset Definition for.
DatasetDefinitionId string
Name string
The name of the definition being set.
Column This property is required. 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 This property is required. string
The dataset to set the Dataset Definition for.
DatasetDefinitionId string
Name string
The name of the definition being set.
column This property is required. 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 This property is required. String
The dataset to set the Dataset Definition for.
datasetDefinitionId String
name String
The name of the definition being set.
column This property is required. 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 This property is required. string
The dataset to set the Dataset Definition for.
datasetDefinitionId string
name string
The name of the definition being set.
column This property is required. 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 This property is required. str
The dataset to set the Dataset Definition for.
dataset_definition_id str
name str
The name of the definition being set.
column This property is required. 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 This property is required. String
The dataset to set the Dataset Definition for.
datasetDefinitionId String
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 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:
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
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
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
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
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
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
name String
The name of the definition being set.

Package Details

Repository
honeycombio honeycombio/terraform-provider-honeycombio
License
Notes
This Pulumi package is based on the honeycombio Terraform Provider.
honeycombio 0.32.0 published on Monday, Apr 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio