1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. Notification
CloudAMQP v3.20.2 published on Tuesday, Oct 29, 2024 by Pulumi

cloudamqp.Notification

Explore with Pulumi AI

cloudamqp logo
CloudAMQP v3.20.2 published on Tuesday, Oct 29, 2024 by Pulumi

    This resource allows you to create and manage recipients to receive alarm notifications. There will always be a default recipient created upon instance creation. This recipient will use team email and receive notifications from default alarms.

    Available for all subscription plans.

    Example Usage

    Email recipient
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const emailRecipient = new cloudamqp.Notification("email_recipient", {
        instanceId: instance.id,
        type: "email",
        value: "alarm@example.com",
        name: "alarm",
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    email_recipient = cloudamqp.Notification("email_recipient",
        instance_id=instance["id"],
        type="email",
        value="alarm@example.com",
        name="alarm")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewNotification(ctx, "email_recipient", &cloudamqp.NotificationArgs{
    			InstanceId: pulumi.Any(instance.Id),
    			Type:       pulumi.String("email"),
    			Value:      pulumi.String("alarm@example.com"),
    			Name:       pulumi.String("alarm"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var emailRecipient = new CloudAmqp.Notification("email_recipient", new()
        {
            InstanceId = instance.Id,
            Type = "email",
            Value = "alarm@example.com",
            Name = "alarm",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Notification;
    import com.pulumi.cloudamqp.NotificationArgs;
    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 emailRecipient = new Notification("emailRecipient", NotificationArgs.builder()
                .instanceId(instance.id())
                .type("email")
                .value("alarm@example.com")
                .name("alarm")
                .build());
    
        }
    }
    
    resources:
      emailRecipient:
        type: cloudamqp:Notification
        name: email_recipient
        properties:
          instanceId: ${instance.id}
          type: email
          value: alarm@example.com
          name: alarm
    
    OpsGenie recipient with optional responders
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const opsgenieRecipient = new cloudamqp.Notification("opsgenie_recipient", {
        instanceId: instance.id,
        type: "opsgenie",
        value: "<api-key>",
        name: "OpsGenie",
        responders: [
            {
                type: "team",
                id: "<team-uuid>",
            },
            {
                type: "user",
                username: "<username>",
            },
        ],
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    opsgenie_recipient = cloudamqp.Notification("opsgenie_recipient",
        instance_id=instance["id"],
        type="opsgenie",
        value="<api-key>",
        name="OpsGenie",
        responders=[
            {
                "type": "team",
                "id": "<team-uuid>",
            },
            {
                "type": "user",
                "username": "<username>",
            },
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewNotification(ctx, "opsgenie_recipient", &cloudamqp.NotificationArgs{
    			InstanceId: pulumi.Any(instance.Id),
    			Type:       pulumi.String("opsgenie"),
    			Value:      pulumi.String("<api-key>"),
    			Name:       pulumi.String("OpsGenie"),
    			Responders: cloudamqp.NotificationResponderArray{
    				&cloudamqp.NotificationResponderArgs{
    					Type: pulumi.String("team"),
    					Id:   pulumi.String("<team-uuid>"),
    				},
    				&cloudamqp.NotificationResponderArgs{
    					Type:     pulumi.String("user"),
    					Username: pulumi.String("<username>"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var opsgenieRecipient = new CloudAmqp.Notification("opsgenie_recipient", new()
        {
            InstanceId = instance.Id,
            Type = "opsgenie",
            Value = "<api-key>",
            Name = "OpsGenie",
            Responders = new[]
            {
                new CloudAmqp.Inputs.NotificationResponderArgs
                {
                    Type = "team",
                    Id = "<team-uuid>",
                },
                new CloudAmqp.Inputs.NotificationResponderArgs
                {
                    Type = "user",
                    Username = "<username>",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Notification;
    import com.pulumi.cloudamqp.NotificationArgs;
    import com.pulumi.cloudamqp.inputs.NotificationResponderArgs;
    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 opsgenieRecipient = new Notification("opsgenieRecipient", NotificationArgs.builder()
                .instanceId(instance.id())
                .type("opsgenie")
                .value("<api-key>")
                .name("OpsGenie")
                .responders(            
                    NotificationResponderArgs.builder()
                        .type("team")
                        .id("<team-uuid>")
                        .build(),
                    NotificationResponderArgs.builder()
                        .type("user")
                        .username("<username>")
                        .build())
                .build());
    
        }
    }
    
    resources:
      opsgenieRecipient:
        type: cloudamqp:Notification
        name: opsgenie_recipient
        properties:
          instanceId: ${instance.id}
          type: opsgenie
          value: <api-key>
          name: OpsGenie
          responders:
            - type: team
              id: <team-uuid>
            - type: user
              username: <username>
    
    Pagerduty recipient with optional dedup key
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const pagerdutyRecipient = new cloudamqp.Notification("pagerduty_recipient", {
        instanceId: instance.id,
        type: "pagerduty",
        value: "<integration-key>",
        name: "PagerDuty",
        options: {
            dedupkey: "DEDUPKEY",
        },
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    pagerduty_recipient = cloudamqp.Notification("pagerduty_recipient",
        instance_id=instance["id"],
        type="pagerduty",
        value="<integration-key>",
        name="PagerDuty",
        options={
            "dedupkey": "DEDUPKEY",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewNotification(ctx, "pagerduty_recipient", &cloudamqp.NotificationArgs{
    			InstanceId: pulumi.Any(instance.Id),
    			Type:       pulumi.String("pagerduty"),
    			Value:      pulumi.String("<integration-key>"),
    			Name:       pulumi.String("PagerDuty"),
    			Options: pulumi.StringMap{
    				"dedupkey": pulumi.String("DEDUPKEY"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var pagerdutyRecipient = new CloudAmqp.Notification("pagerduty_recipient", new()
        {
            InstanceId = instance.Id,
            Type = "pagerduty",
            Value = "<integration-key>",
            Name = "PagerDuty",
            Options = 
            {
                { "dedupkey", "DEDUPKEY" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Notification;
    import com.pulumi.cloudamqp.NotificationArgs;
    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 pagerdutyRecipient = new Notification("pagerdutyRecipient", NotificationArgs.builder()
                .instanceId(instance.id())
                .type("pagerduty")
                .value("<integration-key>")
                .name("PagerDuty")
                .options(Map.of("dedupkey", "DEDUPKEY"))
                .build());
    
        }
    }
    
    resources:
      pagerdutyRecipient:
        type: cloudamqp:Notification
        name: pagerduty_recipient
        properties:
          instanceId: ${instance.id}
          type: pagerduty
          value: <integration-key>
          name: PagerDuty
          options:
            dedupkey: DEDUPKEY
    
    Signl4 recipient
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const signl4Recipient = new cloudamqp.Notification("signl4_recipient", {
        instanceId: instance.id,
        type: "signl4",
        value: "<team-secret>",
        name: "Signl4",
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    signl4_recipient = cloudamqp.Notification("signl4_recipient",
        instance_id=instance["id"],
        type="signl4",
        value="<team-secret>",
        name="Signl4")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewNotification(ctx, "signl4_recipient", &cloudamqp.NotificationArgs{
    			InstanceId: pulumi.Any(instance.Id),
    			Type:       pulumi.String("signl4"),
    			Value:      pulumi.String("<team-secret>"),
    			Name:       pulumi.String("Signl4"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var signl4Recipient = new CloudAmqp.Notification("signl4_recipient", new()
        {
            InstanceId = instance.Id,
            Type = "signl4",
            Value = "<team-secret>",
            Name = "Signl4",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Notification;
    import com.pulumi.cloudamqp.NotificationArgs;
    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 signl4Recipient = new Notification("signl4Recipient", NotificationArgs.builder()
                .instanceId(instance.id())
                .type("signl4")
                .value("<team-secret>")
                .name("Signl4")
                .build());
    
        }
    }
    
    resources:
      signl4Recipient:
        type: cloudamqp:Notification
        name: signl4_recipient
        properties:
          instanceId: ${instance.id}
          type: signl4
          value: <team-secret>
          name: Signl4
    
    Teams recipient
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const teamsRecipient = new cloudamqp.Notification("teams_recipient", {
        instanceId: instance.id,
        type: "teams",
        value: "<teams-webhook-url>",
        name: "Teams",
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    teams_recipient = cloudamqp.Notification("teams_recipient",
        instance_id=instance["id"],
        type="teams",
        value="<teams-webhook-url>",
        name="Teams")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewNotification(ctx, "teams_recipient", &cloudamqp.NotificationArgs{
    			InstanceId: pulumi.Any(instance.Id),
    			Type:       pulumi.String("teams"),
    			Value:      pulumi.String("<teams-webhook-url>"),
    			Name:       pulumi.String("Teams"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var teamsRecipient = new CloudAmqp.Notification("teams_recipient", new()
        {
            InstanceId = instance.Id,
            Type = "teams",
            Value = "<teams-webhook-url>",
            Name = "Teams",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Notification;
    import com.pulumi.cloudamqp.NotificationArgs;
    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 teamsRecipient = new Notification("teamsRecipient", NotificationArgs.builder()
                .instanceId(instance.id())
                .type("teams")
                .value("<teams-webhook-url>")
                .name("Teams")
                .build());
    
        }
    }
    
    resources:
      teamsRecipient:
        type: cloudamqp:Notification
        name: teams_recipient
        properties:
          instanceId: ${instance.id}
          type: teams
          value: <teams-webhook-url>
          name: Teams
    
    Victorops recipient with optional routing key (rk)
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const victoropsRecipient = new cloudamqp.Notification("victorops_recipient", {
        instanceId: instance.id,
        type: "victorops",
        value: "<integration-key>",
        name: "Victorops",
        options: {
            rk: "ROUTINGKEY",
        },
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    victorops_recipient = cloudamqp.Notification("victorops_recipient",
        instance_id=instance["id"],
        type="victorops",
        value="<integration-key>",
        name="Victorops",
        options={
            "rk": "ROUTINGKEY",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewNotification(ctx, "victorops_recipient", &cloudamqp.NotificationArgs{
    			InstanceId: pulumi.Any(instance.Id),
    			Type:       pulumi.String("victorops"),
    			Value:      pulumi.String("<integration-key>"),
    			Name:       pulumi.String("Victorops"),
    			Options: pulumi.StringMap{
    				"rk": pulumi.String("ROUTINGKEY"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var victoropsRecipient = new CloudAmqp.Notification("victorops_recipient", new()
        {
            InstanceId = instance.Id,
            Type = "victorops",
            Value = "<integration-key>",
            Name = "Victorops",
            Options = 
            {
                { "rk", "ROUTINGKEY" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Notification;
    import com.pulumi.cloudamqp.NotificationArgs;
    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 victoropsRecipient = new Notification("victoropsRecipient", NotificationArgs.builder()
                .instanceId(instance.id())
                .type("victorops")
                .value("<integration-key>")
                .name("Victorops")
                .options(Map.of("rk", "ROUTINGKEY"))
                .build());
    
        }
    }
    
    resources:
      victoropsRecipient:
        type: cloudamqp:Notification
        name: victorops_recipient
        properties:
          instanceId: ${instance.id}
          type: victorops
          value: <integration-key>
          name: Victorops
          options:
            rk: ROUTINGKEY
    
    Slack recipient
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const slackRecipient = new cloudamqp.Notification("slack_recipient", {
        instanceId: instance.id,
        type: "slack",
        value: "<slack-webhook-url>",
        name: "Slack webhook recipient",
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    slack_recipient = cloudamqp.Notification("slack_recipient",
        instance_id=instance["id"],
        type="slack",
        value="<slack-webhook-url>",
        name="Slack webhook recipient")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewNotification(ctx, "slack_recipient", &cloudamqp.NotificationArgs{
    			InstanceId: pulumi.Any(instance.Id),
    			Type:       pulumi.String("slack"),
    			Value:      pulumi.String("<slack-webhook-url>"),
    			Name:       pulumi.String("Slack webhook recipient"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var slackRecipient = new CloudAmqp.Notification("slack_recipient", new()
        {
            InstanceId = instance.Id,
            Type = "slack",
            Value = "<slack-webhook-url>",
            Name = "Slack webhook recipient",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Notification;
    import com.pulumi.cloudamqp.NotificationArgs;
    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 slackRecipient = new Notification("slackRecipient", NotificationArgs.builder()
                .instanceId(instance.id())
                .type("slack")
                .value("<slack-webhook-url>")
                .name("Slack webhook recipient")
                .build());
    
        }
    }
    
    resources:
      slackRecipient:
        type: cloudamqp:Notification
        name: slack_recipient
        properties:
          instanceId: ${instance.id}
          type: slack
          value: <slack-webhook-url>
          name: Slack webhook recipient
    
    Webhook recipient
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const webhookRecipient = new cloudamqp.Notification("webhook_recipient", {
        instanceId: instance.id,
        type: "webhook",
        value: "<webhook-url>",
        name: "Webhook",
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    webhook_recipient = cloudamqp.Notification("webhook_recipient",
        instance_id=instance["id"],
        type="webhook",
        value="<webhook-url>",
        name="Webhook")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewNotification(ctx, "webhook_recipient", &cloudamqp.NotificationArgs{
    			InstanceId: pulumi.Any(instance.Id),
    			Type:       pulumi.String("webhook"),
    			Value:      pulumi.String("<webhook-url>"),
    			Name:       pulumi.String("Webhook"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var webhookRecipient = new CloudAmqp.Notification("webhook_recipient", new()
        {
            InstanceId = instance.Id,
            Type = "webhook",
            Value = "<webhook-url>",
            Name = "Webhook",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Notification;
    import com.pulumi.cloudamqp.NotificationArgs;
    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 webhookRecipient = new Notification("webhookRecipient", NotificationArgs.builder()
                .instanceId(instance.id())
                .type("webhook")
                .value("<webhook-url>")
                .name("Webhook")
                .build());
    
        }
    }
    
    resources:
      webhookRecipient:
        type: cloudamqp:Notification
        name: webhook_recipient
        properties:
          instanceId: ${instance.id}
          type: webhook
          value: <webhook-url>
          name: Webhook
    

    Notification Type reference

    Valid options for notification type.

    • email
    • opsgenie
    • opsgenie-eu
    • pagerduty
    • signl4
    • slack
    • teams
    • victorops
    • webhook

    Options parameter

    TypeOptionsDescriptionNote
    VictoropsrkRouting key to route alarm notification-
    PagerDutydedupkeyDefault the dedup key for PagerDuty is generated depending on what alarm has triggered, but here you can set what dedup key to use so even if the same alarm is triggered for different resources you only get one notification. Leave blank to use the generated dedup key.If multiple alarms are triggered using this recipient, since they all share dedup key only the first alarm will be shown in PagerDuty

    Dependency

    This resource depends on CloudAMQP instance identifier, cloudamqp_instance.instance.id.

    Create Notification Resource

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

    Constructor syntax

    new Notification(name: string, args: NotificationArgs, opts?: CustomResourceOptions);
    @overload
    def Notification(resource_name: str,
                     args: NotificationArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def Notification(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     instance_id: Optional[int] = None,
                     type: Optional[str] = None,
                     value: Optional[str] = None,
                     name: Optional[str] = None,
                     options: Optional[Mapping[str, str]] = None,
                     responders: Optional[Sequence[NotificationResponderArgs]] = None)
    func NewNotification(ctx *Context, name string, args NotificationArgs, opts ...ResourceOption) (*Notification, error)
    public Notification(string name, NotificationArgs args, CustomResourceOptions? opts = null)
    public Notification(String name, NotificationArgs args)
    public Notification(String name, NotificationArgs args, CustomResourceOptions options)
    
    type: cloudamqp:Notification
    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 NotificationArgs
    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 NotificationArgs
    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 NotificationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotificationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotificationArgs
    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 notificationResource = new CloudAmqp.Notification("notificationResource", new()
    {
        InstanceId = 0,
        Type = "string",
        Value = "string",
        Name = "string",
        Options = 
        {
            { "string", "string" },
        },
        Responders = new[]
        {
            new CloudAmqp.Inputs.NotificationResponderArgs
            {
                Type = "string",
                Id = "string",
                Name = "string",
                Username = "string",
            },
        },
    });
    
    example, err := cloudamqp.NewNotification(ctx, "notificationResource", &cloudamqp.NotificationArgs{
    	InstanceId: pulumi.Int(0),
    	Type:       pulumi.String("string"),
    	Value:      pulumi.String("string"),
    	Name:       pulumi.String("string"),
    	Options: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Responders: cloudamqp.NotificationResponderArray{
    		&cloudamqp.NotificationResponderArgs{
    			Type:     pulumi.String("string"),
    			Id:       pulumi.String("string"),
    			Name:     pulumi.String("string"),
    			Username: pulumi.String("string"),
    		},
    	},
    })
    
    var notificationResource = new Notification("notificationResource", NotificationArgs.builder()
        .instanceId(0)
        .type("string")
        .value("string")
        .name("string")
        .options(Map.of("string", "string"))
        .responders(NotificationResponderArgs.builder()
            .type("string")
            .id("string")
            .name("string")
            .username("string")
            .build())
        .build());
    
    notification_resource = cloudamqp.Notification("notificationResource",
        instance_id=0,
        type="string",
        value="string",
        name="string",
        options={
            "string": "string",
        },
        responders=[{
            "type": "string",
            "id": "string",
            "name": "string",
            "username": "string",
        }])
    
    const notificationResource = new cloudamqp.Notification("notificationResource", {
        instanceId: 0,
        type: "string",
        value: "string",
        name: "string",
        options: {
            string: "string",
        },
        responders: [{
            type: "string",
            id: "string",
            name: "string",
            username: "string",
        }],
    });
    
    type: cloudamqp:Notification
    properties:
        instanceId: 0
        name: string
        options:
            string: string
        responders:
            - id: string
              name: string
              type: string
              username: string
        type: string
        value: string
    

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

    InstanceId int
    The CloudAMQP instance ID.
    Type string
    Type of responder. [team, user, escalation, schedule]
    Value string
    Integration/API key or endpoint to send the notification.
    Name string
    Name of the responder
    Options Dictionary<string, string>
    Options argument (e.g. rk used for VictorOps routing key).
    Responders List<Pulumi.CloudAmqp.Inputs.NotificationResponder>

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    InstanceId int
    The CloudAMQP instance ID.
    Type string
    Type of responder. [team, user, escalation, schedule]
    Value string
    Integration/API key or endpoint to send the notification.
    Name string
    Name of the responder
    Options map[string]string
    Options argument (e.g. rk used for VictorOps routing key).
    Responders []NotificationResponderArgs

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    instanceId Integer
    The CloudAMQP instance ID.
    type String
    Type of responder. [team, user, escalation, schedule]
    value String
    Integration/API key or endpoint to send the notification.
    name String
    Name of the responder
    options Map<String,String>
    Options argument (e.g. rk used for VictorOps routing key).
    responders List<NotificationResponder>

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    instanceId number
    The CloudAMQP instance ID.
    type string
    Type of responder. [team, user, escalation, schedule]
    value string
    Integration/API key or endpoint to send the notification.
    name string
    Name of the responder
    options {[key: string]: string}
    Options argument (e.g. rk used for VictorOps routing key).
    responders NotificationResponder[]

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    instance_id int
    The CloudAMQP instance ID.
    type str
    Type of responder. [team, user, escalation, schedule]
    value str
    Integration/API key or endpoint to send the notification.
    name str
    Name of the responder
    options Mapping[str, str]
    Options argument (e.g. rk used for VictorOps routing key).
    responders Sequence[NotificationResponderArgs]

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    instanceId Number
    The CloudAMQP instance ID.
    type String
    Type of responder. [team, user, escalation, schedule]
    value String
    Integration/API key or endpoint to send the notification.
    name String
    Name of the responder
    options Map<String>
    Options argument (e.g. rk used for VictorOps routing key).
    responders List<Property Map>

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    Outputs

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

    Get an existing Notification 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?: NotificationState, opts?: CustomResourceOptions): Notification
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            instance_id: Optional[int] = None,
            name: Optional[str] = None,
            options: Optional[Mapping[str, str]] = None,
            responders: Optional[Sequence[NotificationResponderArgs]] = None,
            type: Optional[str] = None,
            value: Optional[str] = None) -> Notification
    func GetNotification(ctx *Context, name string, id IDInput, state *NotificationState, opts ...ResourceOption) (*Notification, error)
    public static Notification Get(string name, Input<string> id, NotificationState? state, CustomResourceOptions? opts = null)
    public static Notification get(String name, Output<String> id, NotificationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    InstanceId int
    The CloudAMQP instance ID.
    Name string
    Name of the responder
    Options Dictionary<string, string>
    Options argument (e.g. rk used for VictorOps routing key).
    Responders List<Pulumi.CloudAmqp.Inputs.NotificationResponder>

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    Type string
    Type of responder. [team, user, escalation, schedule]
    Value string
    Integration/API key or endpoint to send the notification.
    InstanceId int
    The CloudAMQP instance ID.
    Name string
    Name of the responder
    Options map[string]string
    Options argument (e.g. rk used for VictorOps routing key).
    Responders []NotificationResponderArgs

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    Type string
    Type of responder. [team, user, escalation, schedule]
    Value string
    Integration/API key or endpoint to send the notification.
    instanceId Integer
    The CloudAMQP instance ID.
    name String
    Name of the responder
    options Map<String,String>
    Options argument (e.g. rk used for VictorOps routing key).
    responders List<NotificationResponder>

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    type String
    Type of responder. [team, user, escalation, schedule]
    value String
    Integration/API key or endpoint to send the notification.
    instanceId number
    The CloudAMQP instance ID.
    name string
    Name of the responder
    options {[key: string]: string}
    Options argument (e.g. rk used for VictorOps routing key).
    responders NotificationResponder[]

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    type string
    Type of responder. [team, user, escalation, schedule]
    value string
    Integration/API key or endpoint to send the notification.
    instance_id int
    The CloudAMQP instance ID.
    name str
    Name of the responder
    options Mapping[str, str]
    Options argument (e.g. rk used for VictorOps routing key).
    responders Sequence[NotificationResponderArgs]

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    type str
    Type of responder. [team, user, escalation, schedule]
    value str
    Integration/API key or endpoint to send the notification.
    instanceId Number
    The CloudAMQP instance ID.
    name String
    Name of the responder
    options Map<String>
    Options argument (e.g. rk used for VictorOps routing key).
    responders List<Property Map>

    An array of reponders (only for OpsGenie). Each responders block consists of the field documented below.


    The responders block consists of:

    type String
    Type of responder. [team, user, escalation, schedule]
    value String
    Integration/API key or endpoint to send the notification.

    Supporting Types

    NotificationResponder, NotificationResponderArgs

    Type string
    Type of responder. [team, user, escalation, schedule]
    Id string
    Identifier in UUID format
    Name string
    Name of the responder
    Username string

    Username of the responder

    Responders of type team, escalation and schedule can use either id or name. While user can use either id or username.

    Type string
    Type of responder. [team, user, escalation, schedule]
    Id string
    Identifier in UUID format
    Name string
    Name of the responder
    Username string

    Username of the responder

    Responders of type team, escalation and schedule can use either id or name. While user can use either id or username.

    type String
    Type of responder. [team, user, escalation, schedule]
    id String
    Identifier in UUID format
    name String
    Name of the responder
    username String

    Username of the responder

    Responders of type team, escalation and schedule can use either id or name. While user can use either id or username.

    type string
    Type of responder. [team, user, escalation, schedule]
    id string
    Identifier in UUID format
    name string
    Name of the responder
    username string

    Username of the responder

    Responders of type team, escalation and schedule can use either id or name. While user can use either id or username.

    type str
    Type of responder. [team, user, escalation, schedule]
    id str
    Identifier in UUID format
    name str
    Name of the responder
    username str

    Username of the responder

    Responders of type team, escalation and schedule can use either id or name. While user can use either id or username.

    type String
    Type of responder. [team, user, escalation, schedule]
    id String
    Identifier in UUID format
    name String
    Name of the responder
    username String

    Username of the responder

    Responders of type team, escalation and schedule can use either id or name. While user can use either id or username.

    Import

    cloudamqp_notification can be imported using CloudAMQP internal identifier of a recipient together

    (CSV separated) with the instance identifier. To retrieve the identifier of a recipient, use

    CloudAMQP API.

    $ pulumi import cloudamqp:index/notification:Notification recipient <id>,<instance_id>`
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    CloudAMQP pulumi/pulumi-cloudamqp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudamqp Terraform Provider.
    cloudamqp logo
    CloudAMQP v3.20.2 published on Tuesday, Oct 29, 2024 by Pulumi