Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. ApiKey
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

honeycombio.ApiKey

Explore with Pulumi AI

honeycombio logo
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

    # Resource: honeycombio.ApiKey

    Creates a Honeycomb API Key. For more information about API Keys, check out Best Practices for API Keys.

    This resource requires the provider be configured with a Management Key with api-keys:write in the configured scopes.

    Example Usage

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

const prodIngest = new honeycombio.ApiKey("prodIngest", {
    type: "ingest",
    environmentId: _var.environment_id,
    permissions: [{
        createDatasets: true,
    }],
});
export const ingestKey = `${honeycomb_api_key.prod_ingest.id}${honeycomb_api_key.prod_ingest.secret}`;

    import pulumi
import pulumi_honeycombio as honeycombio

prod_ingest = honeycombio.ApiKey("prodIngest",
    type="ingest",
    environment_id=var["environment_id"],
    permissions=[{
        "create_datasets": True,
    }])
pulumi.export("ingestKey", f"{honeycomb_api_key['prod_ingest']['id']}{honeycomb_api_key['prod_ingest']['secret']}")

    package main

import (
	"fmt"

	"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.NewApiKey(ctx, "prodIngest", &honeycombio.ApiKeyArgs{
			Type:          pulumi.String("ingest"),
			EnvironmentId: pulumi.Any(_var.Environment_id),
			Permissions: honeycombio.ApiKeyPermissionArray{
				&honeycombio.ApiKeyPermissionArgs{
					CreateDatasets: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("ingestKey", pulumi.Sprintf("%v%v", honeycomb_api_key.Prod_ingest.Id, honeycomb_api_key.Prod_ingest.Secret))
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    var prodIngest = new Honeycombio.ApiKey("prodIngest", new()
    {
        Type = "ingest",
        EnvironmentId = @var.Environment_id,
        Permissions = new[]
        {
            new Honeycombio.Inputs.ApiKeyPermissionArgs
            {
                CreateDatasets = true,
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["ingestKey"] = $"{honeycomb_api_key.Prod_ingest.Id}{honeycomb_api_key.Prod_ingest.Secret}",
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.ApiKey;
import com.pulumi.honeycombio.ApiKeyArgs;
import com.pulumi.honeycombio.inputs.ApiKeyPermissionArgs;
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 prodIngest = new ApiKey("prodIngest", ApiKeyArgs.builder()
            .type("ingest")
            .environmentId(var_.environment_id())
            .permissions(ApiKeyPermissionArgs.builder()
                .createDatasets(true)
                .build())
            .build());

        ctx.export("ingestKey", String.format("%s%s", honeycomb_api_key.prod_ingest().id(),honeycomb_api_key.prod_ingest().secret()));
    }
}

    resources:
  prodIngest:
    type: honeycombio:ApiKey
    properties:
      type: ingest
      environmentId: ${var.environment_id}
      permissions:
        - createDatasets: true
outputs:
  ingestKey: ${honeycomb_api_key.prod_ingest.id}${honeycomb_api_key.prod_ingest.secret}

    Create ApiKey Resource

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

    Constructor syntax

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

@overload
def ApiKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           environment_id: Optional[str] = None,
           type: Optional[str] = None,
           disabled: Optional[bool] = None,
           name: Optional[str] = None,
           permissions: Optional[Sequence[ApiKeyPermissionArgs]] = None)
    func NewApiKey(ctx *Context, name string, args ApiKeyArgs, opts ...ResourceOption) (*ApiKey, error)
    public ApiKey(string name, ApiKeyArgs args, CustomResourceOptions? opts = null)
    public ApiKey(String name, ApiKeyArgs args)
public ApiKey(String name, ApiKeyArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args ApiKeyArgs
    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 ApiKeyArgs
    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 ApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiKeyArgs
    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 apiKeyResource = new Honeycombio.ApiKey("apiKeyResource", new()
{
    EnvironmentId = "string",
    Type = "string",
    Disabled = false,
    Name = "string",
    Permissions = new[]
    {
        new Honeycombio.Inputs.ApiKeyPermissionArgs
        {
            CreateDatasets = false,
        },
    },
});

    example, err := honeycombio.NewApiKey(ctx, "apiKeyResource", &honeycombio.ApiKeyArgs{
EnvironmentId: pulumi.String("string"),
Type: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Name: pulumi.String("string"),
Permissions: .ApiKeyPermissionArray{
&.ApiKeyPermissionArgs{
CreateDatasets: pulumi.Bool(false),
},
},
})

    var apiKeyResource = new ApiKey("apiKeyResource", ApiKeyArgs.builder()
    .environmentId("string")
    .type("string")
    .disabled(false)
    .name("string")
    .permissions(ApiKeyPermissionArgs.builder()
        .createDatasets(false)
        .build())
    .build());

    api_key_resource = honeycombio.ApiKey("apiKeyResource",
    environment_id="string",
    type="string",
    disabled=False,
    name="string",
    permissions=[{
        "create_datasets": False,
    }])

    const apiKeyResource = new honeycombio.ApiKey("apiKeyResource", {
    environmentId: "string",
    type: "string",
    disabled: false,
    name: "string",
    permissions: [{
        createDatasets: false,
    }],
});

    type: honeycombio:ApiKey
properties:
    disabled: false
    environmentId: string
    name: string
    permissions:
        - createDatasets: false
    type: string

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

    EnvironmentId string
    The Environment ID the API key is scoped to.
    Type string
    The type of API key. Currently only ingest is supported.
    Disabled bool
    Whether the API key is disabled. Defaults to false.
    Name string
    The name of the API key.
    Permissions List<ApiKeyPermission>
    A configuration block (described below) setting what actions the API key can perform.
    EnvironmentId string
    The Environment ID the API key is scoped to.
    Type string
    The type of API key. Currently only ingest is supported.
    Disabled bool
    Whether the API key is disabled. Defaults to false.
    Name string
    The name of the API key.
    Permissions []ApiKeyPermissionArgs
    A configuration block (described below) setting what actions the API key can perform.
    environmentId String
    The Environment ID the API key is scoped to.
    type String
    The type of API key. Currently only ingest is supported.
    disabled Boolean
    Whether the API key is disabled. Defaults to false.
    name String
    The name of the API key.
    permissions List<ApiKeyPermission>
    A configuration block (described below) setting what actions the API key can perform.
    environmentId string
    The Environment ID the API key is scoped to.
    type string
    The type of API key. Currently only ingest is supported.
    disabled boolean
    Whether the API key is disabled. Defaults to false.
    name string
    The name of the API key.
    permissions ApiKeyPermission[]
    A configuration block (described below) setting what actions the API key can perform.
    environment_id str
    The Environment ID the API key is scoped to.
    type str
    The type of API key. Currently only ingest is supported.
    disabled bool
    Whether the API key is disabled. Defaults to false.
    name str
    The name of the API key.
    permissions Sequence[ApiKeyPermissionArgs]
    A configuration block (described below) setting what actions the API key can perform.
    environmentId String
    The Environment ID the API key is scoped to.
    type String
    The type of API key. Currently only ingest is supported.
    disabled Boolean
    Whether the API key is disabled. Defaults to false.
    name String
    The name of the API key.
    permissions List<Property Map>
    A configuration block (described below) setting what actions the API key can perform.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Secret string
    The secret portion of the API Key.
    Id string
    The provider-assigned unique ID for this managed resource.
    Secret string
    The secret portion of the API Key.
    id String
    The provider-assigned unique ID for this managed resource.
    secret String
    The secret portion of the API Key.
    id string
    The provider-assigned unique ID for this managed resource.
    secret string
    The secret portion of the API Key.
    id str
    The provider-assigned unique ID for this managed resource.
    secret str
    The secret portion of the API Key.
    id String
    The provider-assigned unique ID for this managed resource.
    secret String
    The secret portion of the API Key.

    Look up Existing ApiKey Resource

    Get an existing ApiKey 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?: ApiKeyState, opts?: CustomResourceOptions): ApiKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        disabled: Optional[bool] = None,
        environment_id: Optional[str] = None,
        name: Optional[str] = None,
        permissions: Optional[Sequence[ApiKeyPermissionArgs]] = None,
        secret: Optional[str] = None,
        type: Optional[str] = None) -> ApiKey
    func GetApiKey(ctx *Context, name string, id IDInput, state *ApiKeyState, opts ...ResourceOption) (*ApiKey, error)
    public static ApiKey Get(string name, Input<string> id, ApiKeyState? state, CustomResourceOptions? opts = null)
    public static ApiKey get(String name, Output<String> id, ApiKeyState state, CustomResourceOptions options)
    resources:  _:    type: honeycombio:ApiKey    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Disabled bool
    Whether the API key is disabled. Defaults to false.
    EnvironmentId string
    The Environment ID the API key is scoped to.
    Name string
    The name of the API key.
    Permissions List<ApiKeyPermission>
    A configuration block (described below) setting what actions the API key can perform.
    Secret string
    The secret portion of the API Key.
    Type string
    The type of API key. Currently only ingest is supported.
    Disabled bool
    Whether the API key is disabled. Defaults to false.
    EnvironmentId string
    The Environment ID the API key is scoped to.
    Name string
    The name of the API key.
    Permissions []ApiKeyPermissionArgs
    A configuration block (described below) setting what actions the API key can perform.
    Secret string
    The secret portion of the API Key.
    Type string
    The type of API key. Currently only ingest is supported.
    disabled Boolean
    Whether the API key is disabled. Defaults to false.
    environmentId String
    The Environment ID the API key is scoped to.
    name String
    The name of the API key.
    permissions List<ApiKeyPermission>
    A configuration block (described below) setting what actions the API key can perform.
    secret String
    The secret portion of the API Key.
    type String
    The type of API key. Currently only ingest is supported.
    disabled boolean
    Whether the API key is disabled. Defaults to false.
    environmentId string
    The Environment ID the API key is scoped to.
    name string
    The name of the API key.
    permissions ApiKeyPermission[]
    A configuration block (described below) setting what actions the API key can perform.
    secret string
    The secret portion of the API Key.
    type string
    The type of API key. Currently only ingest is supported.
    disabled bool
    Whether the API key is disabled. Defaults to false.
    environment_id str
    The Environment ID the API key is scoped to.
    name str
    The name of the API key.
    permissions Sequence[ApiKeyPermissionArgs]
    A configuration block (described below) setting what actions the API key can perform.
    secret str
    The secret portion of the API Key.
    type str
    The type of API key. Currently only ingest is supported.
    disabled Boolean
    Whether the API key is disabled. Defaults to false.
    environmentId String
    The Environment ID the API key is scoped to.
    name String
    The name of the API key.
    permissions List<Property Map>
    A configuration block (described below) setting what actions the API key can perform.
    secret String
    The secret portion of the API Key.
    type String
    The type of API key. Currently only ingest is supported.

    Supporting Types

    ApiKeyPermission, ApiKeyPermissionArgs

    CreateDatasets bool
    Allow this key to create missing datasets when sending telemetry. Defaults to false.
    CreateDatasets bool
    Allow this key to create missing datasets when sending telemetry. Defaults to false.
    createDatasets Boolean
    Allow this key to create missing datasets when sending telemetry. Defaults to false.
    createDatasets boolean
    Allow this key to create missing datasets when sending telemetry. Defaults to false.
    create_datasets bool
    Allow this key to create missing datasets when sending telemetry. Defaults to false.
    createDatasets Boolean
    Allow this key to create missing datasets when sending telemetry. Defaults to false.

    Import

    API Keys cannot be imported.

    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.
    honeycombio logo
    honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
    honeycombio/terraform-provider-honeycombio