NotifyList

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

NS1 Documentation

NotifyList Api Doc

Create a NotifyList Resource

def NotifyList(resource_name, opts=None, name=None, notifications=None, __props__=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.
opts ResourceOptions
A bag of options that control this 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 Programming Model 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 []NotifyListNotification

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 NotifyListNotification[]

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 List[NotifyListNotification]

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
static get(resource_name, id, opts=None, name=None, notifications=None, __props__=None);
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 []NotifyListNotification

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 NotifyListNotification[]

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 List[NotifyListNotification]

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

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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 Dict[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.