1. Packages
  2. Sysdig Provider
  3. API Docs
  4. MonitorNotificationChannelEmail
sysdig 1.52.0 published on Monday, Apr 14, 2025 by sysdiglabs

sysdig.MonitorNotificationChannelEmail

Explore with Pulumi AI

Example Usage

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

const sampleEmail = new sysdig.MonitorNotificationChannelEmail("sampleEmail", {
    enabled: true,
    notifyWhenOk: false,
    notifyWhenResolved: false,
    recipients: [
        "foo@localhost.com",
        "bar@localhost.com",
    ],
    sendTestNotification: false,
});
Copy
import pulumi
import pulumi_sysdig as sysdig

sample_email = sysdig.MonitorNotificationChannelEmail("sampleEmail",
    enabled=True,
    notify_when_ok=False,
    notify_when_resolved=False,
    recipients=[
        "foo@localhost.com",
        "bar@localhost.com",
    ],
    send_test_notification=False)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sysdig/sysdig"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sysdig.NewMonitorNotificationChannelEmail(ctx, "sampleEmail", &sysdig.MonitorNotificationChannelEmailArgs{
			Enabled:            pulumi.Bool(true),
			NotifyWhenOk:       pulumi.Bool(false),
			NotifyWhenResolved: pulumi.Bool(false),
			Recipients: pulumi.StringArray{
				pulumi.String("foo@localhost.com"),
				pulumi.String("bar@localhost.com"),
			},
			SendTestNotification: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sysdig = Pulumi.Sysdig;

return await Deployment.RunAsync(() => 
{
    var sampleEmail = new Sysdig.MonitorNotificationChannelEmail("sampleEmail", new()
    {
        Enabled = true,
        NotifyWhenOk = false,
        NotifyWhenResolved = false,
        Recipients = new[]
        {
            "foo@localhost.com",
            "bar@localhost.com",
        },
        SendTestNotification = false,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sysdig.MonitorNotificationChannelEmail;
import com.pulumi.sysdig.MonitorNotificationChannelEmailArgs;
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 sampleEmail = new MonitorNotificationChannelEmail("sampleEmail", MonitorNotificationChannelEmailArgs.builder()
            .enabled(true)
            .notifyWhenOk(false)
            .notifyWhenResolved(false)
            .recipients(            
                "foo@localhost.com",
                "bar@localhost.com")
            .sendTestNotification(false)
            .build());

    }
}
Copy
resources:
  sampleEmail:
    type: sysdig:MonitorNotificationChannelEmail
    properties:
      enabled: true
      notifyWhenOk: false
      notifyWhenResolved: false
      recipients:
        - foo@localhost.com
        - bar@localhost.com
      sendTestNotification: false
Copy

Create MonitorNotificationChannelEmail Resource

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

Constructor syntax

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

@overload
def MonitorNotificationChannelEmail(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    recipients: Optional[Sequence[str]] = None,
                                    enabled: Optional[bool] = None,
                                    monitor_notification_channel_email_id: Optional[str] = None,
                                    name: Optional[str] = None,
                                    notify_when_ok: Optional[bool] = None,
                                    notify_when_resolved: Optional[bool] = None,
                                    send_test_notification: Optional[bool] = None,
                                    share_with_current_team: Optional[bool] = None,
                                    timeouts: Optional[MonitorNotificationChannelEmailTimeoutsArgs] = None)
func NewMonitorNotificationChannelEmail(ctx *Context, name string, args MonitorNotificationChannelEmailArgs, opts ...ResourceOption) (*MonitorNotificationChannelEmail, error)
public MonitorNotificationChannelEmail(string name, MonitorNotificationChannelEmailArgs args, CustomResourceOptions? opts = null)
public MonitorNotificationChannelEmail(String name, MonitorNotificationChannelEmailArgs args)
public MonitorNotificationChannelEmail(String name, MonitorNotificationChannelEmailArgs args, CustomResourceOptions options)
type: sysdig:MonitorNotificationChannelEmail
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. MonitorNotificationChannelEmailArgs
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. MonitorNotificationChannelEmailArgs
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. MonitorNotificationChannelEmailArgs
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. MonitorNotificationChannelEmailArgs
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. MonitorNotificationChannelEmailArgs
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 monitorNotificationChannelEmailResource = new Sysdig.MonitorNotificationChannelEmail("monitorNotificationChannelEmailResource", new()
{
    Recipients = new[]
    {
        "string",
    },
    Enabled = false,
    MonitorNotificationChannelEmailId = "string",
    Name = "string",
    NotifyWhenOk = false,
    NotifyWhenResolved = false,
    SendTestNotification = false,
    ShareWithCurrentTeam = false,
    Timeouts = new Sysdig.Inputs.MonitorNotificationChannelEmailTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
});
Copy
example, err := sysdig.NewMonitorNotificationChannelEmail(ctx, "monitorNotificationChannelEmailResource", &sysdig.MonitorNotificationChannelEmailArgs{
Recipients: pulumi.StringArray{
pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
MonitorNotificationChannelEmailId: pulumi.String("string"),
Name: pulumi.String("string"),
NotifyWhenOk: pulumi.Bool(false),
NotifyWhenResolved: pulumi.Bool(false),
SendTestNotification: pulumi.Bool(false),
ShareWithCurrentTeam: pulumi.Bool(false),
Timeouts: &.MonitorNotificationChannelEmailTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Read: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var monitorNotificationChannelEmailResource = new MonitorNotificationChannelEmail("monitorNotificationChannelEmailResource", MonitorNotificationChannelEmailArgs.builder()
    .recipients("string")
    .enabled(false)
    .monitorNotificationChannelEmailId("string")
    .name("string")
    .notifyWhenOk(false)
    .notifyWhenResolved(false)
    .sendTestNotification(false)
    .shareWithCurrentTeam(false)
    .timeouts(MonitorNotificationChannelEmailTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .build());
Copy
monitor_notification_channel_email_resource = sysdig.MonitorNotificationChannelEmail("monitorNotificationChannelEmailResource",
    recipients=["string"],
    enabled=False,
    monitor_notification_channel_email_id="string",
    name="string",
    notify_when_ok=False,
    notify_when_resolved=False,
    send_test_notification=False,
    share_with_current_team=False,
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    })
Copy
const monitorNotificationChannelEmailResource = new sysdig.MonitorNotificationChannelEmail("monitorNotificationChannelEmailResource", {
    recipients: ["string"],
    enabled: false,
    monitorNotificationChannelEmailId: "string",
    name: "string",
    notifyWhenOk: false,
    notifyWhenResolved: false,
    sendTestNotification: false,
    shareWithCurrentTeam: false,
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
});
Copy
type: sysdig:MonitorNotificationChannelEmail
properties:
    enabled: false
    monitorNotificationChannelEmailId: string
    name: string
    notifyWhenOk: false
    notifyWhenResolved: false
    recipients:
        - string
    sendTestNotification: false
    shareWithCurrentTeam: false
    timeouts:
        create: string
        delete: string
        read: string
        update: string
Copy

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

Recipients This property is required. List<string>
List of recipients that will receive the message.
Enabled bool
If false, the channel will not emit notifications. Default is true.
MonitorNotificationChannelEmailId string
(Computed) The ID of the Notification Channel.
Name string
The name of the Notification Channel. Must be unique.
NotifyWhenOk bool
Send a new notification when the alert condition is no longer triggered. Default is false.
NotifyWhenResolved bool
Send a new notification when the alert is manually acknowledged by a user. Default is false.
SendTestNotification bool
Send an initial test notification to check if the notification channel is working. Default is false.
ShareWithCurrentTeam bool
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
Timeouts MonitorNotificationChannelEmailTimeouts
Recipients This property is required. []string
List of recipients that will receive the message.
Enabled bool
If false, the channel will not emit notifications. Default is true.
MonitorNotificationChannelEmailId string
(Computed) The ID of the Notification Channel.
Name string
The name of the Notification Channel. Must be unique.
NotifyWhenOk bool
Send a new notification when the alert condition is no longer triggered. Default is false.
NotifyWhenResolved bool
Send a new notification when the alert is manually acknowledged by a user. Default is false.
SendTestNotification bool
Send an initial test notification to check if the notification channel is working. Default is false.
ShareWithCurrentTeam bool
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
Timeouts MonitorNotificationChannelEmailTimeoutsArgs
recipients This property is required. List<String>
List of recipients that will receive the message.
enabled Boolean
If false, the channel will not emit notifications. Default is true.
monitorNotificationChannelEmailId String
(Computed) The ID of the Notification Channel.
name String
The name of the Notification Channel. Must be unique.
notifyWhenOk Boolean
Send a new notification when the alert condition is no longer triggered. Default is false.
notifyWhenResolved Boolean
Send a new notification when the alert is manually acknowledged by a user. Default is false.
sendTestNotification Boolean
Send an initial test notification to check if the notification channel is working. Default is false.
shareWithCurrentTeam Boolean
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
timeouts MonitorNotificationChannelEmailTimeouts
recipients This property is required. string[]
List of recipients that will receive the message.
enabled boolean
If false, the channel will not emit notifications. Default is true.
monitorNotificationChannelEmailId string
(Computed) The ID of the Notification Channel.
name string
The name of the Notification Channel. Must be unique.
notifyWhenOk boolean
Send a new notification when the alert condition is no longer triggered. Default is false.
notifyWhenResolved boolean
Send a new notification when the alert is manually acknowledged by a user. Default is false.
sendTestNotification boolean
Send an initial test notification to check if the notification channel is working. Default is false.
shareWithCurrentTeam boolean
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
timeouts MonitorNotificationChannelEmailTimeouts
recipients This property is required. Sequence[str]
List of recipients that will receive the message.
enabled bool
If false, the channel will not emit notifications. Default is true.
monitor_notification_channel_email_id str
(Computed) The ID of the Notification Channel.
name str
The name of the Notification Channel. Must be unique.
notify_when_ok bool
Send a new notification when the alert condition is no longer triggered. Default is false.
notify_when_resolved bool
Send a new notification when the alert is manually acknowledged by a user. Default is false.
send_test_notification bool
Send an initial test notification to check if the notification channel is working. Default is false.
share_with_current_team bool
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
timeouts MonitorNotificationChannelEmailTimeoutsArgs
recipients This property is required. List<String>
List of recipients that will receive the message.
enabled Boolean
If false, the channel will not emit notifications. Default is true.
monitorNotificationChannelEmailId String
(Computed) The ID of the Notification Channel.
name String
The name of the Notification Channel. Must be unique.
notifyWhenOk Boolean
Send a new notification when the alert condition is no longer triggered. Default is false.
notifyWhenResolved Boolean
Send a new notification when the alert is manually acknowledged by a user. Default is false.
sendTestNotification Boolean
Send an initial test notification to check if the notification channel is working. Default is false.
shareWithCurrentTeam Boolean
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
timeouts Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the MonitorNotificationChannelEmail resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Version double
(Computed) The current version of the Notification Channel.
Id string
The provider-assigned unique ID for this managed resource.
Version float64
(Computed) The current version of the Notification Channel.
id String
The provider-assigned unique ID for this managed resource.
version Double
(Computed) The current version of the Notification Channel.
id string
The provider-assigned unique ID for this managed resource.
version number
(Computed) The current version of the Notification Channel.
id str
The provider-assigned unique ID for this managed resource.
version float
(Computed) The current version of the Notification Channel.
id String
The provider-assigned unique ID for this managed resource.
version Number
(Computed) The current version of the Notification Channel.

Look up Existing MonitorNotificationChannelEmail Resource

Get an existing MonitorNotificationChannelEmail 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?: MonitorNotificationChannelEmailState, opts?: CustomResourceOptions): MonitorNotificationChannelEmail
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        monitor_notification_channel_email_id: Optional[str] = None,
        name: Optional[str] = None,
        notify_when_ok: Optional[bool] = None,
        notify_when_resolved: Optional[bool] = None,
        recipients: Optional[Sequence[str]] = None,
        send_test_notification: Optional[bool] = None,
        share_with_current_team: Optional[bool] = None,
        timeouts: Optional[MonitorNotificationChannelEmailTimeoutsArgs] = None,
        version: Optional[float] = None) -> MonitorNotificationChannelEmail
func GetMonitorNotificationChannelEmail(ctx *Context, name string, id IDInput, state *MonitorNotificationChannelEmailState, opts ...ResourceOption) (*MonitorNotificationChannelEmail, error)
public static MonitorNotificationChannelEmail Get(string name, Input<string> id, MonitorNotificationChannelEmailState? state, CustomResourceOptions? opts = null)
public static MonitorNotificationChannelEmail get(String name, Output<String> id, MonitorNotificationChannelEmailState state, CustomResourceOptions options)
resources:  _:    type: sysdig:MonitorNotificationChannelEmail    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:
Enabled bool
If false, the channel will not emit notifications. Default is true.
MonitorNotificationChannelEmailId string
(Computed) The ID of the Notification Channel.
Name string
The name of the Notification Channel. Must be unique.
NotifyWhenOk bool
Send a new notification when the alert condition is no longer triggered. Default is false.
NotifyWhenResolved bool
Send a new notification when the alert is manually acknowledged by a user. Default is false.
Recipients List<string>
List of recipients that will receive the message.
SendTestNotification bool
Send an initial test notification to check if the notification channel is working. Default is false.
ShareWithCurrentTeam bool
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
Timeouts MonitorNotificationChannelEmailTimeouts
Version double
(Computed) The current version of the Notification Channel.
Enabled bool
If false, the channel will not emit notifications. Default is true.
MonitorNotificationChannelEmailId string
(Computed) The ID of the Notification Channel.
Name string
The name of the Notification Channel. Must be unique.
NotifyWhenOk bool
Send a new notification when the alert condition is no longer triggered. Default is false.
NotifyWhenResolved bool
Send a new notification when the alert is manually acknowledged by a user. Default is false.
Recipients []string
List of recipients that will receive the message.
SendTestNotification bool
Send an initial test notification to check if the notification channel is working. Default is false.
ShareWithCurrentTeam bool
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
Timeouts MonitorNotificationChannelEmailTimeoutsArgs
Version float64
(Computed) The current version of the Notification Channel.
enabled Boolean
If false, the channel will not emit notifications. Default is true.
monitorNotificationChannelEmailId String
(Computed) The ID of the Notification Channel.
name String
The name of the Notification Channel. Must be unique.
notifyWhenOk Boolean
Send a new notification when the alert condition is no longer triggered. Default is false.
notifyWhenResolved Boolean
Send a new notification when the alert is manually acknowledged by a user. Default is false.
recipients List<String>
List of recipients that will receive the message.
sendTestNotification Boolean
Send an initial test notification to check if the notification channel is working. Default is false.
shareWithCurrentTeam Boolean
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
timeouts MonitorNotificationChannelEmailTimeouts
version Double
(Computed) The current version of the Notification Channel.
enabled boolean
If false, the channel will not emit notifications. Default is true.
monitorNotificationChannelEmailId string
(Computed) The ID of the Notification Channel.
name string
The name of the Notification Channel. Must be unique.
notifyWhenOk boolean
Send a new notification when the alert condition is no longer triggered. Default is false.
notifyWhenResolved boolean
Send a new notification when the alert is manually acknowledged by a user. Default is false.
recipients string[]
List of recipients that will receive the message.
sendTestNotification boolean
Send an initial test notification to check if the notification channel is working. Default is false.
shareWithCurrentTeam boolean
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
timeouts MonitorNotificationChannelEmailTimeouts
version number
(Computed) The current version of the Notification Channel.
enabled bool
If false, the channel will not emit notifications. Default is true.
monitor_notification_channel_email_id str
(Computed) The ID of the Notification Channel.
name str
The name of the Notification Channel. Must be unique.
notify_when_ok bool
Send a new notification when the alert condition is no longer triggered. Default is false.
notify_when_resolved bool
Send a new notification when the alert is manually acknowledged by a user. Default is false.
recipients Sequence[str]
List of recipients that will receive the message.
send_test_notification bool
Send an initial test notification to check if the notification channel is working. Default is false.
share_with_current_team bool
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
timeouts MonitorNotificationChannelEmailTimeoutsArgs
version float
(Computed) The current version of the Notification Channel.
enabled Boolean
If false, the channel will not emit notifications. Default is true.
monitorNotificationChannelEmailId String
(Computed) The ID of the Notification Channel.
name String
The name of the Notification Channel. Must be unique.
notifyWhenOk Boolean
Send a new notification when the alert condition is no longer triggered. Default is false.
notifyWhenResolved Boolean
Send a new notification when the alert is manually acknowledged by a user. Default is false.
recipients List<String>
List of recipients that will receive the message.
sendTestNotification Boolean
Send an initial test notification to check if the notification channel is working. Default is false.
shareWithCurrentTeam Boolean
If set to true it will share notification channel only with current team (in which user is logged in). Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a error: 403 Forbidden if this is not set to true.
timeouts Property Map
version Number
(Computed) The current version of the Notification Channel.

Supporting Types

MonitorNotificationChannelEmailTimeouts
, MonitorNotificationChannelEmailTimeoutsArgs

Create string
Delete string
Read string
Update string
Create string
Delete string
Read string
Update string
create String
delete String
read String
update String
create string
delete string
read string
update string
create str
delete str
read str
update str
create String
delete String
read String
update String

Import

Email notification channels for Monitor can be imported using the ID, e.g.

$ pulumi import sysdig:index/monitorNotificationChannelEmail:MonitorNotificationChannelEmail example 12345
Copy

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

Package Details

Repository
sysdig sysdiglabs/terraform-provider-sysdig
License
Notes
This Pulumi package is based on the sysdig Terraform Provider.