Docs Packages
  1. Pulumi Registry
  2. Grafana Cloud
  3. API Docs
  4. AlertNotification
grafana logo
Grafana v0.0.10, May 21 23

grafana.AlertNotification

Explore with Pulumi AI

Import

 $ pulumi import grafana:index/alertNotification:AlertNotification alert_notification_name {{alert_notification_id}}

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Lbrlabs.PulumiPackage.Grafana;

return await Deployment.RunAsync(() => 
{
    var emailSometeam = new Grafana.AlertNotification("emailSometeam", new()
    {
        Frequency = "24h",
        IsDefault = false,
        SendReminder = true,
        Settings = 
        {
            { "addresses", "foo@example.net;bar@example.net" },
            { "uploadImage", "false" },
        },
        Type = "email",
    });

});

package main

import (
	"github.com/lbrlabs/pulumi-grafana/sdk/go/grafana"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := grafana.NewAlertNotification(ctx, "emailSometeam", &grafana.AlertNotificationArgs{
			Frequency:    pulumi.String("24h"),
			IsDefault:    pulumi.Bool(false),
			SendReminder: pulumi.Bool(true),
			Settings: pulumi.AnyMap{
				"addresses":   pulumi.Any("foo@example.net;bar@example.net"),
				"uploadImage": pulumi.Any("false"),
			},
			Type: pulumi.String("email"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.AlertNotification;
import com.pulumi.grafana.AlertNotificationArgs;
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 emailSometeam = new AlertNotification("emailSometeam", AlertNotificationArgs.builder()        
            .frequency("24h")
            .isDefault(false)
            .sendReminder(true)
            .settings(Map.ofEntries(
                Map.entry("addresses", "foo@example.net;bar@example.net"),
                Map.entry("uploadImage", "false")
            ))
            .type("email")
            .build());

    }
}

import pulumi
import lbrlabs_pulumi_grafana as grafana

email_someteam = grafana.AlertNotification("emailSometeam",
    frequency="24h",
    is_default=False,
    send_reminder=True,
    settings={
        "addresses": "foo@example.net;bar@example.net",
        "uploadImage": "false",
    },
    type="email")

import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@lbrlabs/pulumi-grafana";

const emailSometeam = new grafana.AlertNotification("emailSometeam", {
    frequency: "24h",
    isDefault: false,
    sendReminder: true,
    settings: {
        addresses: "foo@example.net;bar@example.net",
        uploadImage: "false",
    },
    type: "email",
});

resources:
  emailSometeam:
    type: grafana:AlertNotification
    properties:
      frequency: 24h
      isDefault: false
      sendReminder: true
      settings:
        addresses: foo@example.net;bar@example.net
        uploadImage: 'false'
      type: email

Create AlertNotification Resource

new AlertNotification(name: string, args: AlertNotificationArgs, opts?: CustomResourceOptions);
@overload
def AlertNotification(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      disable_resolve_message: Optional[bool] = None,
                      frequency: Optional[str] = None,
                      is_default: Optional[bool] = None,
                      name: Optional[str] = None,
                      secure_settings: Optional[Mapping[str, Any]] = None,
                      send_reminder: Optional[bool] = None,
                      settings: Optional[Mapping[str, Any]] = None,
                      type: Optional[str] = None,
                      uid: Optional[str] = None)
@overload
def AlertNotification(resource_name: str,
                      args: AlertNotificationArgs,
                      opts: Optional[ResourceOptions] = None)
func NewAlertNotification(ctx *Context, name string, args AlertNotificationArgs, opts ...ResourceOption) (*AlertNotification, error)
public AlertNotification(string name, AlertNotificationArgs args, CustomResourceOptions? opts = null)
public AlertNotification(String name, AlertNotificationArgs args)
public AlertNotification(String name, AlertNotificationArgs args, CustomResourceOptions options)

type: grafana:AlertNotification
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AlertNotificationArgs
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 AlertNotificationArgs
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 AlertNotificationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AlertNotificationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AlertNotificationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AlertNotification Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AlertNotification resource accepts the following input properties:

Type string

The type of the alert notification channel.

DisableResolveMessage bool

Whether to disable sending resolve messages. Defaults to false.

Frequency string

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

IsDefault bool

Is this the default channel for all your alerts. Defaults to false.

Name string

The name of the alert notification channel.

SecureSettings Dictionary<string, object>

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

SendReminder bool

Whether to send reminders for triggered alerts. Defaults to false.

Settings Dictionary<string, object>

Additional settings, for full reference see Grafana HTTP API documentation.

Uid string

Unique identifier. If unset, this will be automatically generated.

Type string

The type of the alert notification channel.

DisableResolveMessage bool

Whether to disable sending resolve messages. Defaults to false.

Frequency string

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

IsDefault bool

Is this the default channel for all your alerts. Defaults to false.

Name string

The name of the alert notification channel.

SecureSettings map[string]interface{}

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

SendReminder bool

Whether to send reminders for triggered alerts. Defaults to false.

Settings map[string]interface{}

Additional settings, for full reference see Grafana HTTP API documentation.

Uid string

Unique identifier. If unset, this will be automatically generated.

type String

The type of the alert notification channel.

disableResolveMessage Boolean

Whether to disable sending resolve messages. Defaults to false.

frequency String

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

isDefault Boolean

Is this the default channel for all your alerts. Defaults to false.

name String

The name of the alert notification channel.

secureSettings Map<String,Object>

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

sendReminder Boolean

Whether to send reminders for triggered alerts. Defaults to false.

settings Map<String,Object>

Additional settings, for full reference see Grafana HTTP API documentation.

uid String

Unique identifier. If unset, this will be automatically generated.

type string

The type of the alert notification channel.

disableResolveMessage boolean

Whether to disable sending resolve messages. Defaults to false.

frequency string

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

isDefault boolean

Is this the default channel for all your alerts. Defaults to false.

name string

The name of the alert notification channel.

secureSettings {[key: string]: any}

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

sendReminder boolean

Whether to send reminders for triggered alerts. Defaults to false.

settings {[key: string]: any}

Additional settings, for full reference see Grafana HTTP API documentation.

uid string

Unique identifier. If unset, this will be automatically generated.

type str

The type of the alert notification channel.

disable_resolve_message bool

Whether to disable sending resolve messages. Defaults to false.

frequency str

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

is_default bool

Is this the default channel for all your alerts. Defaults to false.

name str

The name of the alert notification channel.

secure_settings Mapping[str, Any]

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

send_reminder bool

Whether to send reminders for triggered alerts. Defaults to false.

settings Mapping[str, Any]

Additional settings, for full reference see Grafana HTTP API documentation.

uid str

Unique identifier. If unset, this will be automatically generated.

type String

The type of the alert notification channel.

disableResolveMessage Boolean

Whether to disable sending resolve messages. Defaults to false.

frequency String

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

isDefault Boolean

Is this the default channel for all your alerts. Defaults to false.

name String

The name of the alert notification channel.

secureSettings Map<Any>

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

sendReminder Boolean

Whether to send reminders for triggered alerts. Defaults to false.

settings Map<Any>

Additional settings, for full reference see Grafana HTTP API documentation.

uid String

Unique identifier. If unset, this will be automatically generated.

Outputs

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

Get an existing AlertNotification 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?: AlertNotificationState, opts?: CustomResourceOptions): AlertNotification
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        disable_resolve_message: Optional[bool] = None,
        frequency: Optional[str] = None,
        is_default: Optional[bool] = None,
        name: Optional[str] = None,
        secure_settings: Optional[Mapping[str, Any]] = None,
        send_reminder: Optional[bool] = None,
        settings: Optional[Mapping[str, Any]] = None,
        type: Optional[str] = None,
        uid: Optional[str] = None) -> AlertNotification
func GetAlertNotification(ctx *Context, name string, id IDInput, state *AlertNotificationState, opts ...ResourceOption) (*AlertNotification, error)
public static AlertNotification Get(string name, Input<string> id, AlertNotificationState? state, CustomResourceOptions? opts = null)
public static AlertNotification get(String name, Output<String> id, AlertNotificationState 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:
DisableResolveMessage bool

Whether to disable sending resolve messages. Defaults to false.

Frequency string

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

IsDefault bool

Is this the default channel for all your alerts. Defaults to false.

Name string

The name of the alert notification channel.

SecureSettings Dictionary<string, object>

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

SendReminder bool

Whether to send reminders for triggered alerts. Defaults to false.

Settings Dictionary<string, object>

Additional settings, for full reference see Grafana HTTP API documentation.

Type string

The type of the alert notification channel.

Uid string

Unique identifier. If unset, this will be automatically generated.

DisableResolveMessage bool

Whether to disable sending resolve messages. Defaults to false.

Frequency string

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

IsDefault bool

Is this the default channel for all your alerts. Defaults to false.

Name string

The name of the alert notification channel.

SecureSettings map[string]interface{}

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

SendReminder bool

Whether to send reminders for triggered alerts. Defaults to false.

Settings map[string]interface{}

Additional settings, for full reference see Grafana HTTP API documentation.

Type string

The type of the alert notification channel.

Uid string

Unique identifier. If unset, this will be automatically generated.

disableResolveMessage Boolean

Whether to disable sending resolve messages. Defaults to false.

frequency String

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

isDefault Boolean

Is this the default channel for all your alerts. Defaults to false.

name String

The name of the alert notification channel.

secureSettings Map<String,Object>

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

sendReminder Boolean

Whether to send reminders for triggered alerts. Defaults to false.

settings Map<String,Object>

Additional settings, for full reference see Grafana HTTP API documentation.

type String

The type of the alert notification channel.

uid String

Unique identifier. If unset, this will be automatically generated.

disableResolveMessage boolean

Whether to disable sending resolve messages. Defaults to false.

frequency string

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

isDefault boolean

Is this the default channel for all your alerts. Defaults to false.

name string

The name of the alert notification channel.

secureSettings {[key: string]: any}

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

sendReminder boolean

Whether to send reminders for triggered alerts. Defaults to false.

settings {[key: string]: any}

Additional settings, for full reference see Grafana HTTP API documentation.

type string

The type of the alert notification channel.

uid string

Unique identifier. If unset, this will be automatically generated.

disable_resolve_message bool

Whether to disable sending resolve messages. Defaults to false.

frequency str

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

is_default bool

Is this the default channel for all your alerts. Defaults to false.

name str

The name of the alert notification channel.

secure_settings Mapping[str, Any]

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

send_reminder bool

Whether to send reminders for triggered alerts. Defaults to false.

settings Mapping[str, Any]

Additional settings, for full reference see Grafana HTTP API documentation.

type str

The type of the alert notification channel.

uid str

Unique identifier. If unset, this will be automatically generated.

disableResolveMessage Boolean

Whether to disable sending resolve messages. Defaults to false.

frequency String

Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.

isDefault Boolean

Is this the default channel for all your alerts. Defaults to false.

name String

The name of the alert notification channel.

secureSettings Map<Any>

Additional secure settings, for full reference lookup Grafana Supported Settings documentation.

sendReminder Boolean

Whether to send reminders for triggered alerts. Defaults to false.

settings Map<Any>

Additional settings, for full reference see Grafana HTTP API documentation.

type String

The type of the alert notification channel.

uid String

Unique identifier. If unset, this will be automatically generated.

Package Details

Repository
grafana lbrlabs/pulumi-grafana
License
Apache-2.0
Notes

This Pulumi package is based on the grafana Terraform Provider.