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

honeycombio.Marker

Explore with Pulumi AI

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

# Resource: honeycombio.Marker

Creates a marker. For more information about markers, check out Annotate the timeline with Markers.

Destroying or replacing this resource will not delete the previously created marker. This is intentional to preserve the markers.

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 appVersion = config.require("appVersion");
const appDeploy = new honeycombio.Marker("appDeploy", {
    message: `deploy ${appVersion}`,
    type: "deploy",
    url: "http://www.example.com/",
    dataset: dataset,
});
Copy
import pulumi
import pulumi_honeycombio as honeycombio

config = pulumi.Config()
dataset = config.require("dataset")
app_version = config.require("appVersion")
app_deploy = honeycombio.Marker("appDeploy",
    message=f"deploy {app_version}",
    type="deploy",
    url="http://www.example.com/",
    dataset=dataset)
Copy
package main

import (
	"fmt"

	"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")
		appVersion := cfg.Require("appVersion")
		_, err := honeycombio.NewMarker(ctx, "appDeploy", &honeycombio.MarkerArgs{
			Message: pulumi.Sprintf("deploy %v", appVersion),
			Type:    pulumi.String("deploy"),
			Url:     pulumi.String("http://www.example.com/"),
			Dataset: pulumi.String(dataset),
		})
		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 config = new Config();
    var dataset = config.Require("dataset");
    var appVersion = config.Require("appVersion");
    var appDeploy = new Honeycombio.Marker("appDeploy", new()
    {
        Message = $"deploy {appVersion}",
        Type = "deploy",
        Url = "http://www.example.com/",
        Dataset = dataset,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.Marker;
import com.pulumi.honeycombio.MarkerArgs;
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");
        final var appVersion = config.get("appVersion");
        var appDeploy = new Marker("appDeploy", MarkerArgs.builder()
            .message(String.format("deploy %s", appVersion))
            .type("deploy")
            .url("http://www.example.com/")
            .dataset(dataset)
            .build());

    }
}
Copy
configuration:
  dataset:
    type: string
  appVersion:
    type: string
resources:
  appDeploy:
    type: honeycombio:Marker
    properties:
      message: deploy ${appVersion}
      type: deploy
      url: http://www.example.com/
      dataset: ${dataset}
Copy

Create Marker Resource

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

Constructor syntax

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

@overload
def Marker(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           dataset: Optional[str] = None,
           marker_id: Optional[str] = None,
           message: Optional[str] = None,
           type: Optional[str] = None,
           url: Optional[str] = None)
func NewMarker(ctx *Context, name string, args *MarkerArgs, opts ...ResourceOption) (*Marker, error)
public Marker(string name, MarkerArgs? args = null, CustomResourceOptions? opts = null)
public Marker(String name, MarkerArgs args)
public Marker(String name, MarkerArgs args, CustomResourceOptions options)

type: honeycombio:Marker
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 MarkerArgs
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 MarkerArgs
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 MarkerArgs
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 MarkerArgs
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. MarkerArgs
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 markerResource = new Honeycombio.Marker("markerResource", new()
{
    Dataset = "string",
    MarkerId = "string",
    Message = "string",
    Type = "string",
    Url = "string",
});
Copy
example, err := honeycombio.NewMarker(ctx, "markerResource", &honeycombio.MarkerArgs{
Dataset: pulumi.String("string"),
MarkerId: pulumi.String("string"),
Message: pulumi.String("string"),
Type: pulumi.String("string"),
Url: pulumi.String("string"),
})
Copy
var markerResource = new Marker("markerResource", MarkerArgs.builder()
    .dataset("string")
    .markerId("string")
    .message("string")
    .type("string")
    .url("string")
    .build());
Copy
marker_resource = honeycombio.Marker("markerResource",
    dataset="string",
    marker_id="string",
    message="string",
    type="string",
    url="string")
Copy
const markerResource = new honeycombio.Marker("markerResource", {
    dataset: "string",
    markerId: "string",
    message: "string",
    type: "string",
    url: "string",
});
Copy
type: honeycombio:Marker
properties:
    dataset: string
    markerId: string
    message: string
    type: string
    url: string
Copy

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

Dataset string
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
MarkerId string
ID of the marker.
Message string
A message that appears above the marker and can be used to describe the marker.
Type string
The type of the marker (e.g. "deploy", "job-run")
Url string
A target URL for the Marker. Rendered as a link in the UI..
Dataset string
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
MarkerId string
ID of the marker.
Message string
A message that appears above the marker and can be used to describe the marker.
Type string
The type of the marker (e.g. "deploy", "job-run")
Url string
A target URL for the Marker. Rendered as a link in the UI..
dataset String
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
markerId String
ID of the marker.
message String
A message that appears above the marker and can be used to describe the marker.
type String
The type of the marker (e.g. "deploy", "job-run")
url String
A target URL for the Marker. Rendered as a link in the UI..
dataset string
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
markerId string
ID of the marker.
message string
A message that appears above the marker and can be used to describe the marker.
type string
The type of the marker (e.g. "deploy", "job-run")
url string
A target URL for the Marker. Rendered as a link in the UI..
dataset str
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
marker_id str
ID of the marker.
message str
A message that appears above the marker and can be used to describe the marker.
type str
The type of the marker (e.g. "deploy", "job-run")
url str
A target URL for the Marker. Rendered as a link in the UI..
dataset String
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
markerId String
ID of the marker.
message String
A message that appears above the marker and can be used to describe the marker.
type String
The type of the marker (e.g. "deploy", "job-run")
url String
A target URL for the Marker. Rendered as a link in the UI..

Outputs

All input properties are implicitly available as output properties. Additionally, the Marker 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 str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Marker Resource

Get an existing Marker 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?: MarkerState, opts?: CustomResourceOptions): Marker
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dataset: Optional[str] = None,
        marker_id: Optional[str] = None,
        message: Optional[str] = None,
        type: Optional[str] = None,
        url: Optional[str] = None) -> Marker
func GetMarker(ctx *Context, name string, id IDInput, state *MarkerState, opts ...ResourceOption) (*Marker, error)
public static Marker Get(string name, Input<string> id, MarkerState? state, CustomResourceOptions? opts = null)
public static Marker get(String name, Output<String> id, MarkerState state, CustomResourceOptions options)
resources:  _:    type: honeycombio:Marker    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:
Dataset string
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
MarkerId string
ID of the marker.
Message string
A message that appears above the marker and can be used to describe the marker.
Type string
The type of the marker (e.g. "deploy", "job-run")
Url string
A target URL for the Marker. Rendered as a link in the UI..
Dataset string
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
MarkerId string
ID of the marker.
Message string
A message that appears above the marker and can be used to describe the marker.
Type string
The type of the marker (e.g. "deploy", "job-run")
Url string
A target URL for the Marker. Rendered as a link in the UI..
dataset String
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
markerId String
ID of the marker.
message String
A message that appears above the marker and can be used to describe the marker.
type String
The type of the marker (e.g. "deploy", "job-run")
url String
A target URL for the Marker. Rendered as a link in the UI..
dataset string
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
markerId string
ID of the marker.
message string
A message that appears above the marker and can be used to describe the marker.
type string
The type of the marker (e.g. "deploy", "job-run")
url string
A target URL for the Marker. Rendered as a link in the UI..
dataset str
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
marker_id str
ID of the marker.
message str
A message that appears above the marker and can be used to describe the marker.
type str
The type of the marker (e.g. "deploy", "job-run")
url str
A target URL for the Marker. Rendered as a link in the UI..
dataset String
The dataset where this marker is placed. If not set, an Environment-wide Marker will be created.
markerId String
ID of the marker.
message String
A message that appears above the marker and can be used to describe the marker.
type String
The type of the marker (e.g. "deploy", "job-run")
url String
A target URL for the Marker. Rendered as a link in the UI..

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