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

honeycombio.EmailRecipient

Explore with Pulumi AI

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

    # Resource: honeycombio.EmailRecipient

    honeycombio.EmailRecipient allows you to define and manage an Email recipient that can be used by Triggers or BurnAlerts notifications.

    Example Usage

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

const alerts = new honeycombio.EmailRecipient("alerts", {address: "alerts@example.com"});

    import pulumi
import pulumi_honeycombio as honeycombio

alerts = honeycombio.EmailRecipient("alerts", address="alerts@example.com")

    package main

import (
	"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.NewEmailRecipient(ctx, "alerts", &honeycombio.EmailRecipientArgs{
			Address: pulumi.String("alerts@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var alerts = new Honeycombio.EmailRecipient("alerts", new()
    {
        Address = "alerts@example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.EmailRecipient;
import com.pulumi.honeycombio.EmailRecipientArgs;
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 alerts = new EmailRecipient("alerts", EmailRecipientArgs.builder()
            .address("alerts@example.com")
            .build());

    }
}

    resources:
  alerts:
    type: honeycombio:EmailRecipient
    properties:
      address: alerts@example.com

    Create EmailRecipient Resource

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

    Constructor syntax

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

@overload
def EmailRecipient(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   address: Optional[str] = None,
                   email_recipient_id: Optional[str] = None)
    func NewEmailRecipient(ctx *Context, name string, args EmailRecipientArgs, opts ...ResourceOption) (*EmailRecipient, error)
    public EmailRecipient(string name, EmailRecipientArgs args, CustomResourceOptions? opts = null)
    public EmailRecipient(String name, EmailRecipientArgs args)
public EmailRecipient(String name, EmailRecipientArgs args, CustomResourceOptions options)

    type: honeycombio:EmailRecipient
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 EmailRecipientArgs
    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 EmailRecipientArgs
    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 EmailRecipientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailRecipientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailRecipientArgs
    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 emailRecipientResource = new Honeycombio.EmailRecipient("emailRecipientResource", new()
{
    Address = "string",
    EmailRecipientId = "string",
});

    example, err := honeycombio.NewEmailRecipient(ctx, "emailRecipientResource", &honeycombio.EmailRecipientArgs{
Address: pulumi.String("string"),
EmailRecipientId: pulumi.String("string"),
})

    var emailRecipientResource = new EmailRecipient("emailRecipientResource", EmailRecipientArgs.builder()
    .address("string")
    .emailRecipientId("string")
    .build());

    email_recipient_resource = honeycombio.EmailRecipient("emailRecipientResource",
    address="string",
    email_recipient_id="string")

    const emailRecipientResource = new honeycombio.EmailRecipient("emailRecipientResource", {
    address: "string",
    emailRecipientId: "string",
});

    type: honeycombio:EmailRecipient
properties:
    address: string
    emailRecipientId: string

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

    Address string
    The email address to send the notification to.
    EmailRecipientId string
    The ID of the recipient.
    Address string
    The email address to send the notification to.
    EmailRecipientId string
    The ID of the recipient.
    address String
    The email address to send the notification to.
    emailRecipientId String
    The ID of the recipient.
    address string
    The email address to send the notification to.
    emailRecipientId string
    The ID of the recipient.
    address str
    The email address to send the notification to.
    email_recipient_id str
    The ID of the recipient.
    address String
    The email address to send the notification to.
    emailRecipientId String
    The ID of the recipient.

    Outputs

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

    Get an existing EmailRecipient 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?: EmailRecipientState, opts?: CustomResourceOptions): EmailRecipient
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        email_recipient_id: Optional[str] = None) -> EmailRecipient
    func GetEmailRecipient(ctx *Context, name string, id IDInput, state *EmailRecipientState, opts ...ResourceOption) (*EmailRecipient, error)
    public static EmailRecipient Get(string name, Input<string> id, EmailRecipientState? state, CustomResourceOptions? opts = null)
    public static EmailRecipient get(String name, Output<String> id, EmailRecipientState state, CustomResourceOptions options)
    resources:  _:    type: honeycombio:EmailRecipient    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:
    Address string
    The email address to send the notification to.
    EmailRecipientId string
    The ID of the recipient.
    Address string
    The email address to send the notification to.
    EmailRecipientId string
    The ID of the recipient.
    address String
    The email address to send the notification to.
    emailRecipientId String
    The ID of the recipient.
    address string
    The email address to send the notification to.
    emailRecipientId string
    The ID of the recipient.
    address str
    The email address to send the notification to.
    email_recipient_id str
    The ID of the recipient.
    address String
    The email address to send the notification to.
    emailRecipientId String
    The ID of the recipient.

    Import

    Email Recipients can be imported by their ID, e.g.

    $ pulumi import honeycombio:index/emailRecipient:EmailRecipient my_recipient nx2zsegA0dZ

    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