1. Registry
  2. Packages
  3. Honeycombio Provider
  4. API Docs
  5. TelemetrySchema
Viewing docs for Honeycomb 0.57.0
published on Friday, Nov 13, 2026 by honeycombio
Honeycomb
Viewing docs for Honeycomb 0.57.0
published on Friday, Nov 13, 2026 by honeycombio

    Example Usage

    Create TelemetrySchema Resource

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

    Constructor syntax

    new TelemetrySchema(name: string, args: TelemetrySchemaArgs, opts?: CustomResourceOptions);
    @overload
    def TelemetrySchema(resource_name: str,
                        args: TelemetrySchemaArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def TelemetrySchema(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        schema_yaml: Optional[str] = None)
    func NewTelemetrySchema(ctx *Context, name string, args TelemetrySchemaArgs, opts ...ResourceOption) (*TelemetrySchema, error)
    public TelemetrySchema(string name, TelemetrySchemaArgs args, CustomResourceOptions? opts = null)
    public TelemetrySchema(String name, TelemetrySchemaArgs args)
    public TelemetrySchema(String name, TelemetrySchemaArgs args, CustomResourceOptions options)
    
    type: honeycombio:TelemetrySchema
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "honeycombio_telemetry_schema" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args TelemetrySchemaArgs
    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 TelemetrySchemaArgs
    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 TelemetrySchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TelemetrySchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TelemetrySchemaArgs
    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 telemetrySchemaResource = new Honeycombio.TelemetrySchema("telemetrySchemaResource", new()
    {
        SchemaYaml = "string",
    });
    
    example, err := honeycombio.NewTelemetrySchema(ctx, "telemetrySchemaResource", &honeycombio.TelemetrySchemaArgs{
    	SchemaYaml: pulumi.String("string"),
    })
    
    resource "honeycombio_telemetry_schema" "telemetrySchemaResource" {
      lifecycle {
        create_before_destroy = true
      }
      schema_yaml = "string"
    }
    
    var telemetrySchemaResource = new TelemetrySchema("telemetrySchemaResource", TelemetrySchemaArgs.builder()
        .schemaYaml("string")
        .build());
    
    telemetry_schema_resource = honeycombio.TelemetrySchema("telemetrySchemaResource", schema_yaml="string")
    
    const telemetrySchemaResource = new honeycombio.TelemetrySchema("telemetrySchemaResource", {schemaYaml: "string"});
    
    type: honeycombio:TelemetrySchema
    properties:
        schemaYaml: string
    

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

    SchemaYaml string
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    SchemaYaml string
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    schema_yaml string
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    schemaYaml String
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    schemaYaml string
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    schema_yaml str
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    schemaYaml String
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TelemetrySchema 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 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 TelemetrySchema Resource

    Get an existing TelemetrySchema 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?: TelemetrySchemaState, opts?: CustomResourceOptions): TelemetrySchema
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            schema_yaml: Optional[str] = None) -> TelemetrySchema
    func GetTelemetrySchema(ctx *Context, name string, id IDInput, state *TelemetrySchemaState, opts ...ResourceOption) (*TelemetrySchema, error)
    public static TelemetrySchema Get(string name, Input<string> id, TelemetrySchemaState? state, CustomResourceOptions? opts = null)
    public static TelemetrySchema get(String name, Output<String> id, TelemetrySchemaState state, CustomResourceOptions options)
    resources:  existingTelemetrySchema:    type: honeycombio:TelemetrySchema    get:      id: ${id}
    import {
      to = honeycombio_telemetry_schema.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state TelemetrySchemaState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state TelemetrySchemaState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state TelemetrySchemaState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state TelemetrySchemaState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    SchemaYaml string
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    SchemaYaml string
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    schema_yaml string
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    schemaYaml String
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    schemaYaml string
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    schema_yaml str
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.
    schemaYaml String
    The telemetry schema, as the YAML of a Weaver registry, of up to 1 MiB (1,048,576 bytes). It is stored and returned exactly as written, so any change to the text, including whitespace and comments, is a change to the schema.

    Import

    A Team’s existing telemetry schema can be imported by the slug of the Team. The slug is the first part of the path in Honeycomb URLs, such as ui.honeycomb.io/my-team/environments/production, and the team.slug attribute of the honeycombio_auth_metadata data source.

    To bring an existing schema under management:

    1. Add a honeycombio_telemetry_schema resource with schema_yaml set to the schema you want.

    2. Import the existing schema. e.g.

    $ pulumi import honeycombio:index/telemetrySchema:TelemetrySchema example my-team
    

    Or with an import block:

    terraform

    import {

    to = honeycombio_telemetry_schema.example

    id = “my-team”

    }

    1. Run pulumi preview. The plan shows how the existing schema differs from your configuration. There is no change if they match exactly.

    2. Run pulumi up to replace the existing schema with the configuration, or change the configuration to match the existing schema first.

    The slug must be that of the Team of the provider’s Management Key. Importing any other slug fails.

    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.
    Honeycomb
    Viewing docs for Honeycomb 0.57.0
    published on Friday, Nov 13, 2026 by honeycombio

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial