1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. PagerdutyRecipient
honeycombio 0.32.0 published on Monday, Apr 7, 2025 by honeycombio

honeycombio.PagerdutyRecipient

Explore with Pulumi AI

# Resource: honeycombio.PagerdutyRecipient

honeycombio.PagerdutyRecipient allows you to define and manage a PagerDuty 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 prod_oncall = new honeycombio.PagerdutyRecipient("prod-oncall", {
    integrationKey: "cd6e8de3c857aefc950e0d5ebcb79ac2",
    integrationName: "Production on-call notifications",
});
Copy
import pulumi
import pulumi_honeycombio as honeycombio

prod_oncall = honeycombio.PagerdutyRecipient("prod-oncall",
    integration_key="cd6e8de3c857aefc950e0d5ebcb79ac2",
    integration_name="Production on-call notifications")
Copy
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.NewPagerdutyRecipient(ctx, "prod-oncall", &honeycombio.PagerdutyRecipientArgs{
			IntegrationKey:  pulumi.String("cd6e8de3c857aefc950e0d5ebcb79ac2"),
			IntegrationName: pulumi.String("Production on-call notifications"),
		})
		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 prod_oncall = new Honeycombio.PagerdutyRecipient("prod-oncall", new()
    {
        IntegrationKey = "cd6e8de3c857aefc950e0d5ebcb79ac2",
        IntegrationName = "Production on-call notifications",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.PagerdutyRecipient;
import com.pulumi.honeycombio.PagerdutyRecipientArgs;
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 prod_oncall = new PagerdutyRecipient("prod-oncall", PagerdutyRecipientArgs.builder()
            .integrationKey("cd6e8de3c857aefc950e0d5ebcb79ac2")
            .integrationName("Production on-call notifications")
            .build());

    }
}
Copy
resources:
  prod-oncall:
    type: honeycombio:PagerdutyRecipient
    properties:
      integrationKey: cd6e8de3c857aefc950e0d5ebcb79ac2
      integrationName: Production on-call notifications
Copy

Create PagerdutyRecipient Resource

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

Constructor syntax

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

@overload
def PagerdutyRecipient(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       integration_key: Optional[str] = None,
                       integration_name: Optional[str] = None,
                       pagerduty_recipient_id: Optional[str] = None)
func NewPagerdutyRecipient(ctx *Context, name string, args PagerdutyRecipientArgs, opts ...ResourceOption) (*PagerdutyRecipient, error)
public PagerdutyRecipient(string name, PagerdutyRecipientArgs args, CustomResourceOptions? opts = null)
public PagerdutyRecipient(String name, PagerdutyRecipientArgs args)
public PagerdutyRecipient(String name, PagerdutyRecipientArgs args, CustomResourceOptions options)
type: honeycombio:PagerdutyRecipient
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 This property is required. PagerdutyRecipientArgs
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 This property is required. PagerdutyRecipientArgs
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 This property is required. PagerdutyRecipientArgs
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 This property is required. PagerdutyRecipientArgs
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. PagerdutyRecipientArgs
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 pagerdutyRecipientResource = new Honeycombio.PagerdutyRecipient("pagerdutyRecipientResource", new()
{
    IntegrationKey = "string",
    IntegrationName = "string",
    PagerdutyRecipientId = "string",
});
Copy
example, err := honeycombio.NewPagerdutyRecipient(ctx, "pagerdutyRecipientResource", &honeycombio.PagerdutyRecipientArgs{
IntegrationKey: pulumi.String("string"),
IntegrationName: pulumi.String("string"),
PagerdutyRecipientId: pulumi.String("string"),
})
Copy
var pagerdutyRecipientResource = new PagerdutyRecipient("pagerdutyRecipientResource", PagerdutyRecipientArgs.builder()
    .integrationKey("string")
    .integrationName("string")
    .pagerdutyRecipientId("string")
    .build());
Copy
pagerduty_recipient_resource = honeycombio.PagerdutyRecipient("pagerdutyRecipientResource",
    integration_key="string",
    integration_name="string",
    pagerduty_recipient_id="string")
Copy
const pagerdutyRecipientResource = new honeycombio.PagerdutyRecipient("pagerdutyRecipientResource", {
    integrationKey: "string",
    integrationName: "string",
    pagerdutyRecipientId: "string",
});
Copy
type: honeycombio:PagerdutyRecipient
properties:
    integrationKey: string
    integrationName: string
    pagerdutyRecipientId: string
Copy

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

IntegrationKey This property is required. string
The key of the PagerDuty Integration to send the notification to.
IntegrationName This property is required. string
The name of the PagerDuty Integration to send the notification to.
PagerdutyRecipientId string
The ID of the recipient.
IntegrationKey This property is required. string
The key of the PagerDuty Integration to send the notification to.
IntegrationName This property is required. string
The name of the PagerDuty Integration to send the notification to.
PagerdutyRecipientId string
The ID of the recipient.
integrationKey This property is required. String
The key of the PagerDuty Integration to send the notification to.
integrationName This property is required. String
The name of the PagerDuty Integration to send the notification to.
pagerdutyRecipientId String
The ID of the recipient.
integrationKey This property is required. string
The key of the PagerDuty Integration to send the notification to.
integrationName This property is required. string
The name of the PagerDuty Integration to send the notification to.
pagerdutyRecipientId string
The ID of the recipient.
integration_key This property is required. str
The key of the PagerDuty Integration to send the notification to.
integration_name This property is required. str
The name of the PagerDuty Integration to send the notification to.
pagerduty_recipient_id str
The ID of the recipient.
integrationKey This property is required. String
The key of the PagerDuty Integration to send the notification to.
integrationName This property is required. String
The name of the PagerDuty Integration to send the notification to.
pagerdutyRecipientId String
The ID of the recipient.

Outputs

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

Get an existing PagerdutyRecipient 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?: PagerdutyRecipientState, opts?: CustomResourceOptions): PagerdutyRecipient
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        integration_key: Optional[str] = None,
        integration_name: Optional[str] = None,
        pagerduty_recipient_id: Optional[str] = None) -> PagerdutyRecipient
func GetPagerdutyRecipient(ctx *Context, name string, id IDInput, state *PagerdutyRecipientState, opts ...ResourceOption) (*PagerdutyRecipient, error)
public static PagerdutyRecipient Get(string name, Input<string> id, PagerdutyRecipientState? state, CustomResourceOptions? opts = null)
public static PagerdutyRecipient get(String name, Output<String> id, PagerdutyRecipientState state, CustomResourceOptions options)
resources:  _:    type: honeycombio:PagerdutyRecipient    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:
IntegrationKey string
The key of the PagerDuty Integration to send the notification to.
IntegrationName string
The name of the PagerDuty Integration to send the notification to.
PagerdutyRecipientId string
The ID of the recipient.
IntegrationKey string
The key of the PagerDuty Integration to send the notification to.
IntegrationName string
The name of the PagerDuty Integration to send the notification to.
PagerdutyRecipientId string
The ID of the recipient.
integrationKey String
The key of the PagerDuty Integration to send the notification to.
integrationName String
The name of the PagerDuty Integration to send the notification to.
pagerdutyRecipientId String
The ID of the recipient.
integrationKey string
The key of the PagerDuty Integration to send the notification to.
integrationName string
The name of the PagerDuty Integration to send the notification to.
pagerdutyRecipientId string
The ID of the recipient.
integration_key str
The key of the PagerDuty Integration to send the notification to.
integration_name str
The name of the PagerDuty Integration to send the notification to.
pagerduty_recipient_id str
The ID of the recipient.
integrationKey String
The key of the PagerDuty Integration to send the notification to.
integrationName String
The name of the PagerDuty Integration to send the notification to.
pagerdutyRecipientId String
The ID of the recipient.

Import

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

$ pulumi import honeycombio:index/pagerdutyRecipient:PagerdutyRecipient my_recipient nx2zsegA0dZ
Copy

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.