honeycombio.Query

# Resource: honeycombio.Query

Creates a Query scoped to a Dataset or Environment.

Queries can be used by Triggers and Boards, or be executed via the Query Data API.

Queries are immutable and can not be deleted – only created or read. Any changes will result in a new query object being created.

Create Query Resource

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

Constructor syntax

new Query(name: string, args: QueryArgs, opts?: CustomResourceOptions);

@overload
def Query(resource_name: str,
          args: QueryArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Query(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          dataset: Optional[str] = None,
          query_json: Optional[str] = None)

func NewQuery(ctx *Context, name string, args QueryArgs, opts ...ResourceOption) (*Query, error)

public Query(string name, QueryArgs args, CustomResourceOptions? opts = null)

public Query(String name, QueryArgs args)
public Query(String name, QueryArgs args, CustomResourceOptions options)

type: honeycombio:Query
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var queryResource = new Honeycombio.Query("queryResource", new()
{
    Dataset = "string",
    QueryJson = "string",
});

example, err := honeycombio.NewQuery(ctx, "queryResource", &honeycombio.QueryArgs{
Dataset: pulumi.String("string"),
QueryJson: pulumi.String("string"),
})

var queryResource = new Query("queryResource", QueryArgs.builder()
    .dataset("string")
    .queryJson("string")
    .build());

query_resource = honeycombio.Query("queryResource",
    dataset="string",
    query_json="string")

const queryResource = new honeycombio.Query("queryResource", {
    dataset: "string",
    queryJson: "string",
});

type: honeycombio:Query
properties:
    dataset: string
    queryJson: string

Query Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Query resource accepts the following input properties:

Outputs

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

Look up Existing Query Resource

Get an existing Query 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?: QueryState, opts?: CustomResourceOptions): Query

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dataset: Optional[str] = None,
        query_json: Optional[str] = None) -> Query

func GetQuery(ctx *Context, name string, id IDInput, state *QueryState, opts ...ResourceOption) (*Query, error)

public static Query Get(string name, Input<string> id, QueryState? state, CustomResourceOptions? opts = null)

public static Query get(String name, Output<String> id, QueryState state, CustomResourceOptions options)

resources:  _:    type: honeycombio:Query    get:      id: ${id}

Import

Querys can be imported using a combination of the dataset name and their ID, e.g.

$ pulumi import honeycombio:index/query:Query my_query my-dataset/bj8BwOa1uRz

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.