Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

NotifyList

Provides a NS1 Notify List resource. This can be used to create, modify, and delete notify lists.

NS1 Documentation

NotifyList Api Doc

Example Usage

using Pulumi;
using Ns1 = Pulumi.Ns1;

class MyStack : Stack
{
    public MyStack()
    {
        var nl = new Ns1.NotifyList("nl", new Ns1.NotifyListArgs
        {
            Notifications = 
            {
                new Ns1.Inputs.NotifyListNotificationArgs
                {
                    Config = 
                    {
                        { "url", "http://www.mywebhook.com" },
                    },
                    Type = "webhook",
                },
                new Ns1.Inputs.NotifyListNotificationArgs
                {
                    Config = 
                    {
                        { "email", "test@test.com" },
                    },
                    Type = "email",
                },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-ns1/sdk/v2/go/ns1"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ns1.NewNotifyList(ctx, "nl", &ns1.NotifyListArgs{
			Notifications: NotifyListNotificationArray{
				&NotifyListNotificationArgs{
					Config: pulumi.AnyMap{
						"url": pulumi.Any("http://www.mywebhook.com"),
					},
					Type: pulumi.String("webhook"),
				},
				&NotifyListNotificationArgs{
					Config: pulumi.AnyMap{
						"email": pulumi.Any("test@test.com"),
					},
					Type: pulumi.String("email"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_ns1 as ns1

nl = ns1.NotifyList("nl", notifications=[
    ns1.NotifyListNotificationArgs(
        config={
            "url": "http://www.mywebhook.com",
        },
        type="webhook",
    ),
    ns1.NotifyListNotificationArgs(
        config={
            "email": "test@test.com",
        },
        type="email",
    ),
])
import * as pulumi from "@pulumi/pulumi";
import * as ns1 from "@pulumi/ns1";

const nl = new ns1.NotifyList("nl", {
    notifications: [
        {
            config: {
                url: "http://www.mywebhook.com",
            },
            type: "webhook",
        },
        {
            config: {
                email: "test@test.com",
            },
            type: "email",
        },
    ],
});

Create a NotifyList Resource

new NotifyList(name: string, args?: NotifyListArgs, opts?: CustomResourceOptions);
@overload
def NotifyList(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               name: Optional[str] = None,
               notifications: Optional[Sequence[NotifyListNotificationArgs]] = None)
@overload
def NotifyList(resource_name: str,
               args: Optional[NotifyListArgs] = None,
               opts: Optional[ResourceOptions] = None)
func NewNotifyList(ctx *Context, name string, args *NotifyListArgs, opts ...ResourceOption) (*NotifyList, error)
public NotifyList(string name, NotifyListArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args NotifyListArgs
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 NotifyListArgs
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 NotifyListArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NotifyListArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

Name string
The free-form display name for the notify list.
Notifications List<NotifyListNotificationArgs>
A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.
Name string
The free-form display name for the notify list.
Notifications []NotifyListNotificationArgs
A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.
name string
The free-form display name for the notify list.
notifications NotifyListNotificationArgs[]
A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.
name str
The free-form display name for the notify list.
notifications Sequence[NotifyListNotificationArgs]
A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the NotifyList 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing NotifyList Resource

Get an existing NotifyList 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?: NotifyListState, opts?: CustomResourceOptions): NotifyList
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        notifications: Optional[Sequence[NotifyListNotificationArgs]] = None) -> NotifyList
func GetNotifyList(ctx *Context, name string, id IDInput, state *NotifyListState, opts ...ResourceOption) (*NotifyList, error)
public static NotifyList Get(string name, Input<string> id, NotifyListState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Name string
The free-form display name for the notify list.
Notifications List<NotifyListNotificationArgs>
A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.
Name string
The free-form display name for the notify list.
Notifications []NotifyListNotificationArgs
A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.
name string
The free-form display name for the notify list.
notifications NotifyListNotificationArgs[]
A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.
name str
The free-form display name for the notify list.
notifications Sequence[NotifyListNotificationArgs]
A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.

Supporting Types

NotifyListNotification

Config Dictionary<string, object>
Configuration details for the given notifier type.
Type string
The type of notifier. Available notifiers are indicated in /notifytypes endpoint.
Config map[string]interface{}
Configuration details for the given notifier type.
Type string
The type of notifier. Available notifiers are indicated in /notifytypes endpoint.
config {[key: string]: any}
Configuration details for the given notifier type.
type string
The type of notifier. Available notifiers are indicated in /notifytypes endpoint.
config Mapping[str, Any]
Configuration details for the given notifier type.
type str
The type of notifier. Available notifiers are indicated in /notifytypes endpoint.

Package Details

Repository
https://github.com/pulumi/pulumi-ns1
License
Apache-2.0
Notes
This Pulumi package is based on the ns1 Terraform Provider.