MonitoringJob

Provides a NS1 Monitoring Job resource. This can be used to create, modify, and delete monitoring jobs.

NS1 Documentation

Create a MonitoringJob Resource

new MonitoringJob(name: string, args: MonitoringJobArgs, opts?: CustomResourceOptions);

def MonitoringJob(resource_name, opts=None, active=None, config=None, frequency=None, job_type=None, name=None, notes=None, notify_delay=None, notify_failback=None, notify_list=None, notify_regional=None, notify_repeat=None, policy=None, rapid_recheck=None, regions=None, rules=None, __props__=None);

func NewMonitoringJob(ctx *Context, name string, args MonitoringJobArgs, opts ...ResourceOption) (*MonitoringJob, error)

public MonitoringJob(string name, MonitoringJobArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args MonitoringJobArgs: 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 MonitoringJobArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MonitoringJobArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

MonitoringJob Resource Properties

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

Inputs

The MonitoringJob resource accepts the following input properties:

Config Dictionary<string, object>: A configuration dictionary with keys and values depending on the jobs’ type.
Frequency int: The frequency, in seconds, at which to run the monitoring job in each region.
JobType string: The type of monitoring job to be run. See NS1 API docs for supported values.
Regions List<string>: The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.
Active bool: Indicates if the job is active or temporarily disabled.
Name string: The free-form display name for the monitoring job.
Notes string: Freeform notes to be included in any notifications about this job.
NotifyDelay int: The time in seconds after a failure to wait before sending a notification.
NotifyFailback bool: If true, a notification is sent when a job returns to an “up” state.
NotifyList string: The id of the notification list to send notifications to.
NotifyRegional bool: If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.
NotifyRepeat int: The time in seconds between repeat notifications of a failed job.
Policy string: The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.
RapidRecheck bool: If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.
Rules List<MonitoringJobRuleArgs>: A list of rules for determining failure conditions. Job Rules are documented below.

Config map[string]interface{}: A configuration dictionary with keys and values depending on the jobs’ type.
Frequency int: The frequency, in seconds, at which to run the monitoring job in each region.
JobType string: The type of monitoring job to be run. See NS1 API docs for supported values.
Regions []string: The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.
Active bool: Indicates if the job is active or temporarily disabled.
Name string: The free-form display name for the monitoring job.
Notes string: Freeform notes to be included in any notifications about this job.
NotifyDelay int: The time in seconds after a failure to wait before sending a notification.
NotifyFailback bool: If true, a notification is sent when a job returns to an “up” state.
NotifyList string: The id of the notification list to send notifications to.
NotifyRegional bool: If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.
NotifyRepeat int: The time in seconds between repeat notifications of a failed job.
Policy string: The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.
RapidRecheck bool: If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.
Rules []MonitoringJobRule: A list of rules for determining failure conditions. Job Rules are documented below.

config {[key: string]: any}: A configuration dictionary with keys and values depending on the jobs’ type.
frequency number: The frequency, in seconds, at which to run the monitoring job in each region.
jobType string: The type of monitoring job to be run. See NS1 API docs for supported values.
regions string[]: The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.
active boolean: Indicates if the job is active or temporarily disabled.
name string: The free-form display name for the monitoring job.
notes string: Freeform notes to be included in any notifications about this job.
notifyDelay number: The time in seconds after a failure to wait before sending a notification.
notifyFailback boolean: If true, a notification is sent when a job returns to an “up” state.
notifyList string: The id of the notification list to send notifications to.
notifyRegional boolean: If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.
notifyRepeat number: The time in seconds between repeat notifications of a failed job.
policy string: The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.
rapidRecheck boolean: If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.
rules MonitoringJobRule[]: A list of rules for determining failure conditions. Job Rules are documented below.

config Dict[str, Any]: A configuration dictionary with keys and values depending on the jobs’ type.
frequency float: The frequency, in seconds, at which to run the monitoring job in each region.
job_type str: The type of monitoring job to be run. See NS1 API docs for supported values.
regions List[str]: The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.
active bool: Indicates if the job is active or temporarily disabled.
name str: The free-form display name for the monitoring job.
notes str: Freeform notes to be included in any notifications about this job.
notify_delay float: The time in seconds after a failure to wait before sending a notification.
notify_failback bool: If true, a notification is sent when a job returns to an “up” state.
notify_list str: The id of the notification list to send notifications to.
notify_regional bool: If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.
notify_repeat float: The time in seconds between repeat notifications of a failed job.
policy str: The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.
rapid_recheck bool: If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.
rules List[MonitoringJobRule]: A list of rules for determining failure conditions. Job Rules are documented below.

Outputs

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

Get an existing MonitoringJob 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?: MonitoringJobState, opts?: CustomResourceOptions): MonitoringJob

static get(resource_name, id, opts=None, active=None, config=None, frequency=None, job_type=None, name=None, notes=None, notify_delay=None, notify_failback=None, notify_list=None, notify_regional=None, notify_repeat=None, policy=None, rapid_recheck=None, regions=None, rules=None, __props__=None);

func GetMonitoringJob(ctx *Context, name string, id IDInput, state *MonitoringJobState, opts ...ResourceOption) (*MonitoringJob, error)

public static MonitoringJob Get(string name, Input<string> id, MonitoringJobState? 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:

Active bool: Indicates if the job is active or temporarily disabled.
Config Dictionary<string, object>: A configuration dictionary with keys and values depending on the jobs’ type.
Frequency int: The frequency, in seconds, at which to run the monitoring job in each region.
JobType string: The type of monitoring job to be run. See NS1 API docs for supported values.
Name string: The free-form display name for the monitoring job.
Notes string: Freeform notes to be included in any notifications about this job.
NotifyDelay int: The time in seconds after a failure to wait before sending a notification.
NotifyFailback bool: If true, a notification is sent when a job returns to an “up” state.
NotifyList string: The id of the notification list to send notifications to.
NotifyRegional bool: If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.
NotifyRepeat int: The time in seconds between repeat notifications of a failed job.
Policy string: The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.
RapidRecheck bool: If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.
Regions List<string>: The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.
Rules List<MonitoringJobRuleArgs>: A list of rules for determining failure conditions. Job Rules are documented below.

Active bool: Indicates if the job is active or temporarily disabled.
Config map[string]interface{}: A configuration dictionary with keys and values depending on the jobs’ type.
Frequency int: The frequency, in seconds, at which to run the monitoring job in each region.
JobType string: The type of monitoring job to be run. See NS1 API docs for supported values.
Name string: The free-form display name for the monitoring job.
Notes string: Freeform notes to be included in any notifications about this job.
NotifyDelay int: The time in seconds after a failure to wait before sending a notification.
NotifyFailback bool: If true, a notification is sent when a job returns to an “up” state.
NotifyList string: The id of the notification list to send notifications to.
NotifyRegional bool: If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.
NotifyRepeat int: The time in seconds between repeat notifications of a failed job.
Policy string: The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.
RapidRecheck bool: If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.
Regions []string: The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.
Rules []MonitoringJobRule: A list of rules for determining failure conditions. Job Rules are documented below.

active boolean: Indicates if the job is active or temporarily disabled.
config {[key: string]: any}: A configuration dictionary with keys and values depending on the jobs’ type.
frequency number: The frequency, in seconds, at which to run the monitoring job in each region.
jobType string: The type of monitoring job to be run. See NS1 API docs for supported values.
name string: The free-form display name for the monitoring job.
notes string: Freeform notes to be included in any notifications about this job.
notifyDelay number: The time in seconds after a failure to wait before sending a notification.
notifyFailback boolean: If true, a notification is sent when a job returns to an “up” state.
notifyList string: The id of the notification list to send notifications to.
notifyRegional boolean: If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.
notifyRepeat number: The time in seconds between repeat notifications of a failed job.
policy string: The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.
rapidRecheck boolean: If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.
regions string[]: The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.
rules MonitoringJobRule[]: A list of rules for determining failure conditions. Job Rules are documented below.

active bool: Indicates if the job is active or temporarily disabled.
config Dict[str, Any]: A configuration dictionary with keys and values depending on the jobs’ type.
frequency float: The frequency, in seconds, at which to run the monitoring job in each region.
job_type str: The type of monitoring job to be run. See NS1 API docs for supported values.
name str: The free-form display name for the monitoring job.
notes str: Freeform notes to be included in any notifications about this job.
notify_delay float: The time in seconds after a failure to wait before sending a notification.
notify_failback bool: If true, a notification is sent when a job returns to an “up” state.
notify_list str: The id of the notification list to send notifications to.
notify_regional bool: If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.
notify_repeat float: The time in seconds between repeat notifications of a failed job.
policy str: The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.
rapid_recheck bool: If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.
regions List[str]: The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.
rules List[MonitoringJobRule]: A list of rules for determining failure conditions. Job Rules are documented below.

Supporting Types

MonitoringJobRule

See the input and output API doc for this type.

Comparison string: The comparison to perform on the the output.
Key string: The output key.
Value string: The value to compare to.

Comparison string: The comparison to perform on the the output.
Key string: The output key.
Value string: The value to compare to.

comparison string: The comparison to perform on the the output.
key string: The output key.
value string: The value to compare to.

comparison str: The comparison to perform on the the output.
key str: The output key.
value str: The value to compare to.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud