Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. getRecipients
honeycombio 0.34.0 published on Tuesday, May 6, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

honeycombio.getRecipients

Explore with Pulumi AI

honeycombio logo
honeycombio 0.34.0 published on Tuesday, May 6, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

    # Data Source: honeycombio.getRecipients

    honeycombio.getRecipients data source provides recipient IDs of recipients matching a set of criteria.

    Example Usage

    Get all recipients

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

const all = honeycombio.getRecipients({});

    import pulumi
import pulumi_honeycombio as honeycombio

all = honeycombio.get_recipients()

    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.GetRecipients(ctx, &honeycombio.GetRecipientsArgs{}, nil)
		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 all = Honeycombio.GetRecipients.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetRecipientsArgs;
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 all = HoneycombioFunctions.getRecipients();

    }
}

    variables:
  all:
    fn::invoke:
      function: honeycombio:getRecipients
      arguments: {}

    Get all email recipients matching a specific domain

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

const example_dot_com = honeycombio.getRecipients({
    detailFilter: {
        name: "address",
        valueRegex: ".*@example.com",
    },
    type: "email",
});

    import pulumi
import pulumi_honeycombio as honeycombio

example_dot_com = honeycombio.get_recipients(detail_filter={
        "name": "address",
        "value_regex": ".*@example.com",
    },
    type="email")

    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.GetRecipients(ctx, &honeycombio.GetRecipientsArgs{
			DetailFilter: honeycombio.GetRecipientsDetailFilter{
				Name:       "address",
				ValueRegex: pulumi.StringRef(".*@example.com"),
			},
			Type: pulumi.StringRef("email"),
		}, nil)
		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 example_dot_com = Honeycombio.GetRecipients.Invoke(new()
    {
        DetailFilter = new Honeycombio.Inputs.GetRecipientsDetailFilterInputArgs
        {
            Name = "address",
            ValueRegex = ".*@example.com",
        },
        Type = "email",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetRecipientsArgs;
import com.pulumi.honeycombio.inputs.GetRecipientsDetailFilterArgs;
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 example-dot-com = HoneycombioFunctions.getRecipients(GetRecipientsArgs.builder()
            .detailFilter(GetRecipientsDetailFilterArgs.builder()
                .name("address")
                .valueRegex(".*@example.com")
                .build())
            .type("email")
            .build());

    }
}

    variables:
  example-dot-com:
    fn::invoke:
      function: honeycombio:getRecipients
      arguments:
        detailFilter:
          name: address
          valueRegex: .*@example.com
        type: email

    Using getRecipients

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRecipients(args: GetRecipientsArgs, opts?: InvokeOptions): Promise<GetRecipientsResult>
function getRecipientsOutput(args: GetRecipientsOutputArgs, opts?: InvokeOptions): Output<GetRecipientsResult>
    def get_recipients(detail_filter: Optional[GetRecipientsDetailFilter] = None,
                   id: Optional[str] = None,
                   type: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetRecipientsResult
def get_recipients_output(detail_filter: Optional[pulumi.Input[GetRecipientsDetailFilterArgs]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   type: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetRecipientsResult]
    func GetRecipients(ctx *Context, args *GetRecipientsArgs, opts ...InvokeOption) (*GetRecipientsResult, error)
func GetRecipientsOutput(ctx *Context, args *GetRecipientsOutputArgs, opts ...InvokeOption) GetRecipientsResultOutput

    > Note: This function is named GetRecipients in the Go SDK.

    public static class GetRecipients 
{
    public static Task<GetRecipientsResult> InvokeAsync(GetRecipientsArgs args, InvokeOptions? opts = null)
    public static Output<GetRecipientsResult> Invoke(GetRecipientsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRecipientsResult> getRecipients(GetRecipientsArgs args, InvokeOptions options)
public static Output<GetRecipientsResult> getRecipients(GetRecipientsArgs args, InvokeOptions options)

    fn::invoke:
  function: honeycombio:index/getRecipients:getRecipients
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DetailFilter GetRecipientsDetailFilter
    a block to further filter recipients as described below. name must be set when providing a filter.
    Id string
    Type string
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    DetailFilter GetRecipientsDetailFilter
    a block to further filter recipients as described below. name must be set when providing a filter.
    Id string
    Type string
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    detailFilter GetRecipientsDetailFilter
    a block to further filter recipients as described below. name must be set when providing a filter.
    id String
    type String
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    detailFilter GetRecipientsDetailFilter
    a block to further filter recipients as described below. name must be set when providing a filter.
    id string
    type string
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    detail_filter GetRecipientsDetailFilter
    a block to further filter recipients as described below. name must be set when providing a filter.
    id str
    type str
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    detailFilter Property Map
    a block to further filter recipients as described below. name must be set when providing a filter.
    id String
    type String
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.

    getRecipients Result

    The following output properties are available:

    Id string
    Ids List<string>
    A list of all the recipient IDs found.
    DetailFilter GetRecipientsDetailFilter
    Type string
    Id string
    Ids []string
    A list of all the recipient IDs found.
    DetailFilter GetRecipientsDetailFilter
    Type string
    id String
    ids List<String>
    A list of all the recipient IDs found.
    detailFilter GetRecipientsDetailFilter
    type String
    id string
    ids string[]
    A list of all the recipient IDs found.
    detailFilter GetRecipientsDetailFilter
    type string
    id str
    ids Sequence[str]
    A list of all the recipient IDs found.
    detail_filter GetRecipientsDetailFilter
    type str
    id String
    ids List<String>
    A list of all the recipient IDs found.
    detailFilter Property Map
    type String

    Supporting Types

    GetRecipientsDetailFilter

    Name string
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    Value string
    The value of the detail field to match on.
    ValueRegex string

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    Name string
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    Value string
    The value of the detail field to match on.
    ValueRegex string

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    name String
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    value String
    The value of the detail field to match on.
    valueRegex String

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    name string
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    value string
    The value of the detail field to match on.
    valueRegex string

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    name str
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    value str
    The value of the detail field to match on.
    value_regex str

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    name String
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    value String
    The value of the detail field to match on.
    valueRegex String

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    Package Details

    Repository
    honeycombio honeycombio/terraform-provider-honeycombio
    License
    Notes
    This Pulumi package is based on the honeycombio Terraform Provider.
    honeycombio logo
    honeycombio 0.34.0 published on Tuesday, May 6, 2025 by honeycombio
    honeycombio/terraform-provider-honeycombio