@pulumi/ns1/notifyList.d.ts

A Pulumi package for creating and managing ns1 cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Provides a NS1 Notify List resource. This can be used to create, modify, and delete notify lists.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as ns1 from "@pulumi/ns1";
 *
 * const nl = new ns1.NotifyList("nl", {
 *     name: "my notify list",
 *     notifications: [
 *         {
 *             type: "webhook",
 *             config: {
 *                 url: "http://www.mywebhook.com",
 *             },
 *         },
 *         {
 *             type: "email",
 *             config: {
 *                 email: "test@test.com",
 *             },
 *         },
 *     ],
 * });
 * ```
 *
 * ## NS1 Documentation
 *
 * [NotifyList Api Doc](https://ns1.com/api#notification-lists)
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import ns1:index/notifyList:NotifyList <name> <notifylist_id>`
 * ```
 */
export declare class NotifyList extends pulumi.CustomResource {
    /**
     * Get an existing NotifyList resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NotifyListState, opts?: pulumi.CustomResourceOptions): NotifyList;
    /**
     * Returns true if the given object is an instance of NotifyList.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is NotifyList;
    /**
     * The free-form display name for the notify list.
     */
    readonly name: pulumi.Output<string>;
    /**
     * 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.
     */
    readonly notifications: pulumi.Output<outputs.NotifyListNotification[] | undefined>;
    /**
     * Create a NotifyList resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args?: NotifyListArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering NotifyList resources.
 */
export interface NotifyListState {
    /**
     * The free-form display name for the notify list.
     */
    name?: pulumi.Input<string>;
    /**
     * 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.
     */
    notifications?: pulumi.Input<pulumi.Input<inputs.NotifyListNotification>[]>;
}
/**
 * The set of arguments for constructing a NotifyList resource.
 */
export interface NotifyListArgs {
    /**
     * The free-form display name for the notify list.
     */
    name?: pulumi.Input<string>;
    /**
     * 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.
     */
    notifications?: pulumi.Input<pulumi.Input<inputs.NotifyListNotification>[]>;
}