pulumi-checkly 2.3.0a1750944663__py3-none-any.whl → 2.4.0a1754310884__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pulumi_checkly/__init__.py +27 -0
- pulumi_checkly/_inputs.py +1925 -194
- pulumi_checkly/dashboard.py +396 -66
- pulumi_checkly/heartbeat_check.py +0 -4
- pulumi_checkly/heartbeat_monitor.py +480 -0
- pulumi_checkly/outputs.py +1518 -152
- pulumi_checkly/pulumi-plugin.json +1 -1
- pulumi_checkly/tcp_check.py +0 -4
- pulumi_checkly/tcp_monitor.py +1171 -0
- pulumi_checkly/url_monitor.py +1045 -0
- {pulumi_checkly-2.3.0a1750944663.dist-info → pulumi_checkly-2.4.0a1754310884.dist-info}/METADATA +1 -1
- {pulumi_checkly-2.3.0a1750944663.dist-info → pulumi_checkly-2.4.0a1754310884.dist-info}/RECORD +14 -11
- {pulumi_checkly-2.3.0a1750944663.dist-info → pulumi_checkly-2.4.0a1754310884.dist-info}/WHEEL +0 -0
- {pulumi_checkly-2.3.0a1750944663.dist-info → pulumi_checkly-2.4.0a1754310884.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,1045 @@
|
|
1
|
+
# coding=utf-8
|
2
|
+
# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
|
3
|
+
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
4
|
+
|
5
|
+
import copy
|
6
|
+
import warnings
|
7
|
+
import sys
|
8
|
+
import pulumi
|
9
|
+
import pulumi.runtime
|
10
|
+
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
11
|
+
if sys.version_info >= (3, 11):
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
13
|
+
else:
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
15
|
+
from . import _utilities
|
16
|
+
from . import outputs
|
17
|
+
from ._inputs import *
|
18
|
+
|
19
|
+
__all__ = ['UrlMonitorArgs', 'UrlMonitor']
|
20
|
+
|
21
|
+
@pulumi.input_type
|
22
|
+
class UrlMonitorArgs:
|
23
|
+
def __init__(__self__, *,
|
24
|
+
activated: pulumi.Input[bool],
|
25
|
+
frequency: pulumi.Input[int],
|
26
|
+
request: pulumi.Input['UrlMonitorRequestArgs'],
|
27
|
+
alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input['UrlMonitorAlertChannelSubscriptionArgs']]]] = None,
|
28
|
+
alert_settings: Optional[pulumi.Input['UrlMonitorAlertSettingsArgs']] = None,
|
29
|
+
degraded_response_time: Optional[pulumi.Input[int]] = None,
|
30
|
+
frequency_offset: Optional[pulumi.Input[int]] = None,
|
31
|
+
group_id: Optional[pulumi.Input[int]] = None,
|
32
|
+
group_order: Optional[pulumi.Input[int]] = None,
|
33
|
+
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
34
|
+
max_response_time: Optional[pulumi.Input[int]] = None,
|
35
|
+
muted: Optional[pulumi.Input[bool]] = None,
|
36
|
+
name: Optional[pulumi.Input[str]] = None,
|
37
|
+
private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
38
|
+
retry_strategy: Optional[pulumi.Input['UrlMonitorRetryStrategyArgs']] = None,
|
39
|
+
run_parallel: Optional[pulumi.Input[bool]] = None,
|
40
|
+
should_fail: Optional[pulumi.Input[bool]] = None,
|
41
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
42
|
+
use_global_alert_settings: Optional[pulumi.Input[bool]] = None):
|
43
|
+
"""
|
44
|
+
The set of arguments for constructing a UrlMonitor resource.
|
45
|
+
:param pulumi.Input[bool] activated: Determines whether the monitor will run periodically or not after being deployed.
|
46
|
+
:param pulumi.Input[int] frequency: How often the monitor should run in minutes. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
|
47
|
+
:param pulumi.Input['UrlMonitorRequestArgs'] request: The parameters of the HTTP request.
|
48
|
+
:param pulumi.Input[Sequence[pulumi.Input['UrlMonitorAlertChannelSubscriptionArgs']]] alert_channel_subscriptions: An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
|
49
|
+
:param pulumi.Input['UrlMonitorAlertSettingsArgs'] alert_settings: Determines the alert escalation policy for the monitor.
|
50
|
+
:param pulumi.Input[int] degraded_response_time: The response time in milliseconds where the monitor should be considered degraded. Possible values are between `0` and `30000`. (Default `3000`).
|
51
|
+
:param pulumi.Input[int] frequency_offset: To create a high frequency monitor, set `frequency` to `0` and `frequency_offset` to `10`, `20`, or `30`.
|
52
|
+
:param pulumi.Input[int] group_id: The ID of the check group that this monitor is part of.
|
53
|
+
:param pulumi.Input[int] group_order: The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
|
54
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the this monitor.
|
55
|
+
:param pulumi.Input[int] max_response_time: The response time in milliseconds where the monitor should be considered failing. Possible values are between `0` and `30000`. (Default `5000`).
|
56
|
+
:param pulumi.Input[bool] muted: Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default `false`).
|
57
|
+
:param pulumi.Input[str] name: The name of the monitor.
|
58
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
|
59
|
+
:param pulumi.Input['UrlMonitorRetryStrategyArgs'] retry_strategy: A strategy for retrying failed monitor runs.
|
60
|
+
:param pulumi.Input[bool] run_parallel: Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default `false`).
|
61
|
+
:param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when the monitor is considered to fail. (Default `false`).
|
62
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks and monitors.
|
63
|
+
:param pulumi.Input[bool] use_global_alert_settings: When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default `true`).
|
64
|
+
"""
|
65
|
+
pulumi.set(__self__, "activated", activated)
|
66
|
+
pulumi.set(__self__, "frequency", frequency)
|
67
|
+
pulumi.set(__self__, "request", request)
|
68
|
+
if alert_channel_subscriptions is not None:
|
69
|
+
pulumi.set(__self__, "alert_channel_subscriptions", alert_channel_subscriptions)
|
70
|
+
if alert_settings is not None:
|
71
|
+
pulumi.set(__self__, "alert_settings", alert_settings)
|
72
|
+
if degraded_response_time is not None:
|
73
|
+
pulumi.set(__self__, "degraded_response_time", degraded_response_time)
|
74
|
+
if frequency_offset is not None:
|
75
|
+
pulumi.set(__self__, "frequency_offset", frequency_offset)
|
76
|
+
if group_id is not None:
|
77
|
+
pulumi.set(__self__, "group_id", group_id)
|
78
|
+
if group_order is not None:
|
79
|
+
pulumi.set(__self__, "group_order", group_order)
|
80
|
+
if locations is not None:
|
81
|
+
pulumi.set(__self__, "locations", locations)
|
82
|
+
if max_response_time is not None:
|
83
|
+
pulumi.set(__self__, "max_response_time", max_response_time)
|
84
|
+
if muted is not None:
|
85
|
+
pulumi.set(__self__, "muted", muted)
|
86
|
+
if name is not None:
|
87
|
+
pulumi.set(__self__, "name", name)
|
88
|
+
if private_locations is not None:
|
89
|
+
pulumi.set(__self__, "private_locations", private_locations)
|
90
|
+
if retry_strategy is not None:
|
91
|
+
pulumi.set(__self__, "retry_strategy", retry_strategy)
|
92
|
+
if run_parallel is not None:
|
93
|
+
pulumi.set(__self__, "run_parallel", run_parallel)
|
94
|
+
if should_fail is not None:
|
95
|
+
pulumi.set(__self__, "should_fail", should_fail)
|
96
|
+
if tags is not None:
|
97
|
+
pulumi.set(__self__, "tags", tags)
|
98
|
+
if use_global_alert_settings is not None:
|
99
|
+
pulumi.set(__self__, "use_global_alert_settings", use_global_alert_settings)
|
100
|
+
|
101
|
+
@property
|
102
|
+
@pulumi.getter
|
103
|
+
def activated(self) -> pulumi.Input[bool]:
|
104
|
+
"""
|
105
|
+
Determines whether the monitor will run periodically or not after being deployed.
|
106
|
+
"""
|
107
|
+
return pulumi.get(self, "activated")
|
108
|
+
|
109
|
+
@activated.setter
|
110
|
+
def activated(self, value: pulumi.Input[bool]):
|
111
|
+
pulumi.set(self, "activated", value)
|
112
|
+
|
113
|
+
@property
|
114
|
+
@pulumi.getter
|
115
|
+
def frequency(self) -> pulumi.Input[int]:
|
116
|
+
"""
|
117
|
+
How often the monitor should run in minutes. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
|
118
|
+
"""
|
119
|
+
return pulumi.get(self, "frequency")
|
120
|
+
|
121
|
+
@frequency.setter
|
122
|
+
def frequency(self, value: pulumi.Input[int]):
|
123
|
+
pulumi.set(self, "frequency", value)
|
124
|
+
|
125
|
+
@property
|
126
|
+
@pulumi.getter
|
127
|
+
def request(self) -> pulumi.Input['UrlMonitorRequestArgs']:
|
128
|
+
"""
|
129
|
+
The parameters of the HTTP request.
|
130
|
+
"""
|
131
|
+
return pulumi.get(self, "request")
|
132
|
+
|
133
|
+
@request.setter
|
134
|
+
def request(self, value: pulumi.Input['UrlMonitorRequestArgs']):
|
135
|
+
pulumi.set(self, "request", value)
|
136
|
+
|
137
|
+
@property
|
138
|
+
@pulumi.getter(name="alertChannelSubscriptions")
|
139
|
+
def alert_channel_subscriptions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['UrlMonitorAlertChannelSubscriptionArgs']]]]:
|
140
|
+
"""
|
141
|
+
An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
|
142
|
+
"""
|
143
|
+
return pulumi.get(self, "alert_channel_subscriptions")
|
144
|
+
|
145
|
+
@alert_channel_subscriptions.setter
|
146
|
+
def alert_channel_subscriptions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['UrlMonitorAlertChannelSubscriptionArgs']]]]):
|
147
|
+
pulumi.set(self, "alert_channel_subscriptions", value)
|
148
|
+
|
149
|
+
@property
|
150
|
+
@pulumi.getter(name="alertSettings")
|
151
|
+
def alert_settings(self) -> Optional[pulumi.Input['UrlMonitorAlertSettingsArgs']]:
|
152
|
+
"""
|
153
|
+
Determines the alert escalation policy for the monitor.
|
154
|
+
"""
|
155
|
+
return pulumi.get(self, "alert_settings")
|
156
|
+
|
157
|
+
@alert_settings.setter
|
158
|
+
def alert_settings(self, value: Optional[pulumi.Input['UrlMonitorAlertSettingsArgs']]):
|
159
|
+
pulumi.set(self, "alert_settings", value)
|
160
|
+
|
161
|
+
@property
|
162
|
+
@pulumi.getter(name="degradedResponseTime")
|
163
|
+
def degraded_response_time(self) -> Optional[pulumi.Input[int]]:
|
164
|
+
"""
|
165
|
+
The response time in milliseconds where the monitor should be considered degraded. Possible values are between `0` and `30000`. (Default `3000`).
|
166
|
+
"""
|
167
|
+
return pulumi.get(self, "degraded_response_time")
|
168
|
+
|
169
|
+
@degraded_response_time.setter
|
170
|
+
def degraded_response_time(self, value: Optional[pulumi.Input[int]]):
|
171
|
+
pulumi.set(self, "degraded_response_time", value)
|
172
|
+
|
173
|
+
@property
|
174
|
+
@pulumi.getter(name="frequencyOffset")
|
175
|
+
def frequency_offset(self) -> Optional[pulumi.Input[int]]:
|
176
|
+
"""
|
177
|
+
To create a high frequency monitor, set `frequency` to `0` and `frequency_offset` to `10`, `20`, or `30`.
|
178
|
+
"""
|
179
|
+
return pulumi.get(self, "frequency_offset")
|
180
|
+
|
181
|
+
@frequency_offset.setter
|
182
|
+
def frequency_offset(self, value: Optional[pulumi.Input[int]]):
|
183
|
+
pulumi.set(self, "frequency_offset", value)
|
184
|
+
|
185
|
+
@property
|
186
|
+
@pulumi.getter(name="groupId")
|
187
|
+
def group_id(self) -> Optional[pulumi.Input[int]]:
|
188
|
+
"""
|
189
|
+
The ID of the check group that this monitor is part of.
|
190
|
+
"""
|
191
|
+
return pulumi.get(self, "group_id")
|
192
|
+
|
193
|
+
@group_id.setter
|
194
|
+
def group_id(self, value: Optional[pulumi.Input[int]]):
|
195
|
+
pulumi.set(self, "group_id", value)
|
196
|
+
|
197
|
+
@property
|
198
|
+
@pulumi.getter(name="groupOrder")
|
199
|
+
def group_order(self) -> Optional[pulumi.Input[int]]:
|
200
|
+
"""
|
201
|
+
The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
|
202
|
+
"""
|
203
|
+
return pulumi.get(self, "group_order")
|
204
|
+
|
205
|
+
@group_order.setter
|
206
|
+
def group_order(self, value: Optional[pulumi.Input[int]]):
|
207
|
+
pulumi.set(self, "group_order", value)
|
208
|
+
|
209
|
+
@property
|
210
|
+
@pulumi.getter
|
211
|
+
def locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
212
|
+
"""
|
213
|
+
An array of one or more data center locations where to run the this monitor.
|
214
|
+
"""
|
215
|
+
return pulumi.get(self, "locations")
|
216
|
+
|
217
|
+
@locations.setter
|
218
|
+
def locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
219
|
+
pulumi.set(self, "locations", value)
|
220
|
+
|
221
|
+
@property
|
222
|
+
@pulumi.getter(name="maxResponseTime")
|
223
|
+
def max_response_time(self) -> Optional[pulumi.Input[int]]:
|
224
|
+
"""
|
225
|
+
The response time in milliseconds where the monitor should be considered failing. Possible values are between `0` and `30000`. (Default `5000`).
|
226
|
+
"""
|
227
|
+
return pulumi.get(self, "max_response_time")
|
228
|
+
|
229
|
+
@max_response_time.setter
|
230
|
+
def max_response_time(self, value: Optional[pulumi.Input[int]]):
|
231
|
+
pulumi.set(self, "max_response_time", value)
|
232
|
+
|
233
|
+
@property
|
234
|
+
@pulumi.getter
|
235
|
+
def muted(self) -> Optional[pulumi.Input[bool]]:
|
236
|
+
"""
|
237
|
+
Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default `false`).
|
238
|
+
"""
|
239
|
+
return pulumi.get(self, "muted")
|
240
|
+
|
241
|
+
@muted.setter
|
242
|
+
def muted(self, value: Optional[pulumi.Input[bool]]):
|
243
|
+
pulumi.set(self, "muted", value)
|
244
|
+
|
245
|
+
@property
|
246
|
+
@pulumi.getter
|
247
|
+
def name(self) -> Optional[pulumi.Input[str]]:
|
248
|
+
"""
|
249
|
+
The name of the monitor.
|
250
|
+
"""
|
251
|
+
return pulumi.get(self, "name")
|
252
|
+
|
253
|
+
@name.setter
|
254
|
+
def name(self, value: Optional[pulumi.Input[str]]):
|
255
|
+
pulumi.set(self, "name", value)
|
256
|
+
|
257
|
+
@property
|
258
|
+
@pulumi.getter(name="privateLocations")
|
259
|
+
def private_locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
260
|
+
"""
|
261
|
+
An array of one or more private locations slugs.
|
262
|
+
"""
|
263
|
+
return pulumi.get(self, "private_locations")
|
264
|
+
|
265
|
+
@private_locations.setter
|
266
|
+
def private_locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
267
|
+
pulumi.set(self, "private_locations", value)
|
268
|
+
|
269
|
+
@property
|
270
|
+
@pulumi.getter(name="retryStrategy")
|
271
|
+
def retry_strategy(self) -> Optional[pulumi.Input['UrlMonitorRetryStrategyArgs']]:
|
272
|
+
"""
|
273
|
+
A strategy for retrying failed monitor runs.
|
274
|
+
"""
|
275
|
+
return pulumi.get(self, "retry_strategy")
|
276
|
+
|
277
|
+
@retry_strategy.setter
|
278
|
+
def retry_strategy(self, value: Optional[pulumi.Input['UrlMonitorRetryStrategyArgs']]):
|
279
|
+
pulumi.set(self, "retry_strategy", value)
|
280
|
+
|
281
|
+
@property
|
282
|
+
@pulumi.getter(name="runParallel")
|
283
|
+
def run_parallel(self) -> Optional[pulumi.Input[bool]]:
|
284
|
+
"""
|
285
|
+
Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default `false`).
|
286
|
+
"""
|
287
|
+
return pulumi.get(self, "run_parallel")
|
288
|
+
|
289
|
+
@run_parallel.setter
|
290
|
+
def run_parallel(self, value: Optional[pulumi.Input[bool]]):
|
291
|
+
pulumi.set(self, "run_parallel", value)
|
292
|
+
|
293
|
+
@property
|
294
|
+
@pulumi.getter(name="shouldFail")
|
295
|
+
def should_fail(self) -> Optional[pulumi.Input[bool]]:
|
296
|
+
"""
|
297
|
+
Allows to invert the behaviour of when the monitor is considered to fail. (Default `false`).
|
298
|
+
"""
|
299
|
+
return pulumi.get(self, "should_fail")
|
300
|
+
|
301
|
+
@should_fail.setter
|
302
|
+
def should_fail(self, value: Optional[pulumi.Input[bool]]):
|
303
|
+
pulumi.set(self, "should_fail", value)
|
304
|
+
|
305
|
+
@property
|
306
|
+
@pulumi.getter
|
307
|
+
def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
308
|
+
"""
|
309
|
+
A list of tags for organizing and filtering checks and monitors.
|
310
|
+
"""
|
311
|
+
return pulumi.get(self, "tags")
|
312
|
+
|
313
|
+
@tags.setter
|
314
|
+
def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
315
|
+
pulumi.set(self, "tags", value)
|
316
|
+
|
317
|
+
@property
|
318
|
+
@pulumi.getter(name="useGlobalAlertSettings")
|
319
|
+
def use_global_alert_settings(self) -> Optional[pulumi.Input[bool]]:
|
320
|
+
"""
|
321
|
+
When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default `true`).
|
322
|
+
"""
|
323
|
+
return pulumi.get(self, "use_global_alert_settings")
|
324
|
+
|
325
|
+
@use_global_alert_settings.setter
|
326
|
+
def use_global_alert_settings(self, value: Optional[pulumi.Input[bool]]):
|
327
|
+
pulumi.set(self, "use_global_alert_settings", value)
|
328
|
+
|
329
|
+
|
330
|
+
@pulumi.input_type
|
331
|
+
class _UrlMonitorState:
|
332
|
+
def __init__(__self__, *,
|
333
|
+
activated: Optional[pulumi.Input[bool]] = None,
|
334
|
+
alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input['UrlMonitorAlertChannelSubscriptionArgs']]]] = None,
|
335
|
+
alert_settings: Optional[pulumi.Input['UrlMonitorAlertSettingsArgs']] = None,
|
336
|
+
degraded_response_time: Optional[pulumi.Input[int]] = None,
|
337
|
+
frequency: Optional[pulumi.Input[int]] = None,
|
338
|
+
frequency_offset: Optional[pulumi.Input[int]] = None,
|
339
|
+
group_id: Optional[pulumi.Input[int]] = None,
|
340
|
+
group_order: Optional[pulumi.Input[int]] = None,
|
341
|
+
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
342
|
+
max_response_time: Optional[pulumi.Input[int]] = None,
|
343
|
+
muted: Optional[pulumi.Input[bool]] = None,
|
344
|
+
name: Optional[pulumi.Input[str]] = None,
|
345
|
+
private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
346
|
+
request: Optional[pulumi.Input['UrlMonitorRequestArgs']] = None,
|
347
|
+
retry_strategy: Optional[pulumi.Input['UrlMonitorRetryStrategyArgs']] = None,
|
348
|
+
run_parallel: Optional[pulumi.Input[bool]] = None,
|
349
|
+
should_fail: Optional[pulumi.Input[bool]] = None,
|
350
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
351
|
+
use_global_alert_settings: Optional[pulumi.Input[bool]] = None):
|
352
|
+
"""
|
353
|
+
Input properties used for looking up and filtering UrlMonitor resources.
|
354
|
+
:param pulumi.Input[bool] activated: Determines whether the monitor will run periodically or not after being deployed.
|
355
|
+
:param pulumi.Input[Sequence[pulumi.Input['UrlMonitorAlertChannelSubscriptionArgs']]] alert_channel_subscriptions: An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
|
356
|
+
:param pulumi.Input['UrlMonitorAlertSettingsArgs'] alert_settings: Determines the alert escalation policy for the monitor.
|
357
|
+
:param pulumi.Input[int] degraded_response_time: The response time in milliseconds where the monitor should be considered degraded. Possible values are between `0` and `30000`. (Default `3000`).
|
358
|
+
:param pulumi.Input[int] frequency: How often the monitor should run in minutes. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
|
359
|
+
:param pulumi.Input[int] frequency_offset: To create a high frequency monitor, set `frequency` to `0` and `frequency_offset` to `10`, `20`, or `30`.
|
360
|
+
:param pulumi.Input[int] group_id: The ID of the check group that this monitor is part of.
|
361
|
+
:param pulumi.Input[int] group_order: The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
|
362
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the this monitor.
|
363
|
+
:param pulumi.Input[int] max_response_time: The response time in milliseconds where the monitor should be considered failing. Possible values are between `0` and `30000`. (Default `5000`).
|
364
|
+
:param pulumi.Input[bool] muted: Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default `false`).
|
365
|
+
:param pulumi.Input[str] name: The name of the monitor.
|
366
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
|
367
|
+
:param pulumi.Input['UrlMonitorRequestArgs'] request: The parameters of the HTTP request.
|
368
|
+
:param pulumi.Input['UrlMonitorRetryStrategyArgs'] retry_strategy: A strategy for retrying failed monitor runs.
|
369
|
+
:param pulumi.Input[bool] run_parallel: Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default `false`).
|
370
|
+
:param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when the monitor is considered to fail. (Default `false`).
|
371
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks and monitors.
|
372
|
+
:param pulumi.Input[bool] use_global_alert_settings: When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default `true`).
|
373
|
+
"""
|
374
|
+
if activated is not None:
|
375
|
+
pulumi.set(__self__, "activated", activated)
|
376
|
+
if alert_channel_subscriptions is not None:
|
377
|
+
pulumi.set(__self__, "alert_channel_subscriptions", alert_channel_subscriptions)
|
378
|
+
if alert_settings is not None:
|
379
|
+
pulumi.set(__self__, "alert_settings", alert_settings)
|
380
|
+
if degraded_response_time is not None:
|
381
|
+
pulumi.set(__self__, "degraded_response_time", degraded_response_time)
|
382
|
+
if frequency is not None:
|
383
|
+
pulumi.set(__self__, "frequency", frequency)
|
384
|
+
if frequency_offset is not None:
|
385
|
+
pulumi.set(__self__, "frequency_offset", frequency_offset)
|
386
|
+
if group_id is not None:
|
387
|
+
pulumi.set(__self__, "group_id", group_id)
|
388
|
+
if group_order is not None:
|
389
|
+
pulumi.set(__self__, "group_order", group_order)
|
390
|
+
if locations is not None:
|
391
|
+
pulumi.set(__self__, "locations", locations)
|
392
|
+
if max_response_time is not None:
|
393
|
+
pulumi.set(__self__, "max_response_time", max_response_time)
|
394
|
+
if muted is not None:
|
395
|
+
pulumi.set(__self__, "muted", muted)
|
396
|
+
if name is not None:
|
397
|
+
pulumi.set(__self__, "name", name)
|
398
|
+
if private_locations is not None:
|
399
|
+
pulumi.set(__self__, "private_locations", private_locations)
|
400
|
+
if request is not None:
|
401
|
+
pulumi.set(__self__, "request", request)
|
402
|
+
if retry_strategy is not None:
|
403
|
+
pulumi.set(__self__, "retry_strategy", retry_strategy)
|
404
|
+
if run_parallel is not None:
|
405
|
+
pulumi.set(__self__, "run_parallel", run_parallel)
|
406
|
+
if should_fail is not None:
|
407
|
+
pulumi.set(__self__, "should_fail", should_fail)
|
408
|
+
if tags is not None:
|
409
|
+
pulumi.set(__self__, "tags", tags)
|
410
|
+
if use_global_alert_settings is not None:
|
411
|
+
pulumi.set(__self__, "use_global_alert_settings", use_global_alert_settings)
|
412
|
+
|
413
|
+
@property
|
414
|
+
@pulumi.getter
|
415
|
+
def activated(self) -> Optional[pulumi.Input[bool]]:
|
416
|
+
"""
|
417
|
+
Determines whether the monitor will run periodically or not after being deployed.
|
418
|
+
"""
|
419
|
+
return pulumi.get(self, "activated")
|
420
|
+
|
421
|
+
@activated.setter
|
422
|
+
def activated(self, value: Optional[pulumi.Input[bool]]):
|
423
|
+
pulumi.set(self, "activated", value)
|
424
|
+
|
425
|
+
@property
|
426
|
+
@pulumi.getter(name="alertChannelSubscriptions")
|
427
|
+
def alert_channel_subscriptions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['UrlMonitorAlertChannelSubscriptionArgs']]]]:
|
428
|
+
"""
|
429
|
+
An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
|
430
|
+
"""
|
431
|
+
return pulumi.get(self, "alert_channel_subscriptions")
|
432
|
+
|
433
|
+
@alert_channel_subscriptions.setter
|
434
|
+
def alert_channel_subscriptions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['UrlMonitorAlertChannelSubscriptionArgs']]]]):
|
435
|
+
pulumi.set(self, "alert_channel_subscriptions", value)
|
436
|
+
|
437
|
+
@property
|
438
|
+
@pulumi.getter(name="alertSettings")
|
439
|
+
def alert_settings(self) -> Optional[pulumi.Input['UrlMonitorAlertSettingsArgs']]:
|
440
|
+
"""
|
441
|
+
Determines the alert escalation policy for the monitor.
|
442
|
+
"""
|
443
|
+
return pulumi.get(self, "alert_settings")
|
444
|
+
|
445
|
+
@alert_settings.setter
|
446
|
+
def alert_settings(self, value: Optional[pulumi.Input['UrlMonitorAlertSettingsArgs']]):
|
447
|
+
pulumi.set(self, "alert_settings", value)
|
448
|
+
|
449
|
+
@property
|
450
|
+
@pulumi.getter(name="degradedResponseTime")
|
451
|
+
def degraded_response_time(self) -> Optional[pulumi.Input[int]]:
|
452
|
+
"""
|
453
|
+
The response time in milliseconds where the monitor should be considered degraded. Possible values are between `0` and `30000`. (Default `3000`).
|
454
|
+
"""
|
455
|
+
return pulumi.get(self, "degraded_response_time")
|
456
|
+
|
457
|
+
@degraded_response_time.setter
|
458
|
+
def degraded_response_time(self, value: Optional[pulumi.Input[int]]):
|
459
|
+
pulumi.set(self, "degraded_response_time", value)
|
460
|
+
|
461
|
+
@property
|
462
|
+
@pulumi.getter
|
463
|
+
def frequency(self) -> Optional[pulumi.Input[int]]:
|
464
|
+
"""
|
465
|
+
How often the monitor should run in minutes. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
|
466
|
+
"""
|
467
|
+
return pulumi.get(self, "frequency")
|
468
|
+
|
469
|
+
@frequency.setter
|
470
|
+
def frequency(self, value: Optional[pulumi.Input[int]]):
|
471
|
+
pulumi.set(self, "frequency", value)
|
472
|
+
|
473
|
+
@property
|
474
|
+
@pulumi.getter(name="frequencyOffset")
|
475
|
+
def frequency_offset(self) -> Optional[pulumi.Input[int]]:
|
476
|
+
"""
|
477
|
+
To create a high frequency monitor, set `frequency` to `0` and `frequency_offset` to `10`, `20`, or `30`.
|
478
|
+
"""
|
479
|
+
return pulumi.get(self, "frequency_offset")
|
480
|
+
|
481
|
+
@frequency_offset.setter
|
482
|
+
def frequency_offset(self, value: Optional[pulumi.Input[int]]):
|
483
|
+
pulumi.set(self, "frequency_offset", value)
|
484
|
+
|
485
|
+
@property
|
486
|
+
@pulumi.getter(name="groupId")
|
487
|
+
def group_id(self) -> Optional[pulumi.Input[int]]:
|
488
|
+
"""
|
489
|
+
The ID of the check group that this monitor is part of.
|
490
|
+
"""
|
491
|
+
return pulumi.get(self, "group_id")
|
492
|
+
|
493
|
+
@group_id.setter
|
494
|
+
def group_id(self, value: Optional[pulumi.Input[int]]):
|
495
|
+
pulumi.set(self, "group_id", value)
|
496
|
+
|
497
|
+
@property
|
498
|
+
@pulumi.getter(name="groupOrder")
|
499
|
+
def group_order(self) -> Optional[pulumi.Input[int]]:
|
500
|
+
"""
|
501
|
+
The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
|
502
|
+
"""
|
503
|
+
return pulumi.get(self, "group_order")
|
504
|
+
|
505
|
+
@group_order.setter
|
506
|
+
def group_order(self, value: Optional[pulumi.Input[int]]):
|
507
|
+
pulumi.set(self, "group_order", value)
|
508
|
+
|
509
|
+
@property
|
510
|
+
@pulumi.getter
|
511
|
+
def locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
512
|
+
"""
|
513
|
+
An array of one or more data center locations where to run the this monitor.
|
514
|
+
"""
|
515
|
+
return pulumi.get(self, "locations")
|
516
|
+
|
517
|
+
@locations.setter
|
518
|
+
def locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
519
|
+
pulumi.set(self, "locations", value)
|
520
|
+
|
521
|
+
@property
|
522
|
+
@pulumi.getter(name="maxResponseTime")
|
523
|
+
def max_response_time(self) -> Optional[pulumi.Input[int]]:
|
524
|
+
"""
|
525
|
+
The response time in milliseconds where the monitor should be considered failing. Possible values are between `0` and `30000`. (Default `5000`).
|
526
|
+
"""
|
527
|
+
return pulumi.get(self, "max_response_time")
|
528
|
+
|
529
|
+
@max_response_time.setter
|
530
|
+
def max_response_time(self, value: Optional[pulumi.Input[int]]):
|
531
|
+
pulumi.set(self, "max_response_time", value)
|
532
|
+
|
533
|
+
@property
|
534
|
+
@pulumi.getter
|
535
|
+
def muted(self) -> Optional[pulumi.Input[bool]]:
|
536
|
+
"""
|
537
|
+
Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default `false`).
|
538
|
+
"""
|
539
|
+
return pulumi.get(self, "muted")
|
540
|
+
|
541
|
+
@muted.setter
|
542
|
+
def muted(self, value: Optional[pulumi.Input[bool]]):
|
543
|
+
pulumi.set(self, "muted", value)
|
544
|
+
|
545
|
+
@property
|
546
|
+
@pulumi.getter
|
547
|
+
def name(self) -> Optional[pulumi.Input[str]]:
|
548
|
+
"""
|
549
|
+
The name of the monitor.
|
550
|
+
"""
|
551
|
+
return pulumi.get(self, "name")
|
552
|
+
|
553
|
+
@name.setter
|
554
|
+
def name(self, value: Optional[pulumi.Input[str]]):
|
555
|
+
pulumi.set(self, "name", value)
|
556
|
+
|
557
|
+
@property
|
558
|
+
@pulumi.getter(name="privateLocations")
|
559
|
+
def private_locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
560
|
+
"""
|
561
|
+
An array of one or more private locations slugs.
|
562
|
+
"""
|
563
|
+
return pulumi.get(self, "private_locations")
|
564
|
+
|
565
|
+
@private_locations.setter
|
566
|
+
def private_locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
567
|
+
pulumi.set(self, "private_locations", value)
|
568
|
+
|
569
|
+
@property
|
570
|
+
@pulumi.getter
|
571
|
+
def request(self) -> Optional[pulumi.Input['UrlMonitorRequestArgs']]:
|
572
|
+
"""
|
573
|
+
The parameters of the HTTP request.
|
574
|
+
"""
|
575
|
+
return pulumi.get(self, "request")
|
576
|
+
|
577
|
+
@request.setter
|
578
|
+
def request(self, value: Optional[pulumi.Input['UrlMonitorRequestArgs']]):
|
579
|
+
pulumi.set(self, "request", value)
|
580
|
+
|
581
|
+
@property
|
582
|
+
@pulumi.getter(name="retryStrategy")
|
583
|
+
def retry_strategy(self) -> Optional[pulumi.Input['UrlMonitorRetryStrategyArgs']]:
|
584
|
+
"""
|
585
|
+
A strategy for retrying failed monitor runs.
|
586
|
+
"""
|
587
|
+
return pulumi.get(self, "retry_strategy")
|
588
|
+
|
589
|
+
@retry_strategy.setter
|
590
|
+
def retry_strategy(self, value: Optional[pulumi.Input['UrlMonitorRetryStrategyArgs']]):
|
591
|
+
pulumi.set(self, "retry_strategy", value)
|
592
|
+
|
593
|
+
@property
|
594
|
+
@pulumi.getter(name="runParallel")
|
595
|
+
def run_parallel(self) -> Optional[pulumi.Input[bool]]:
|
596
|
+
"""
|
597
|
+
Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default `false`).
|
598
|
+
"""
|
599
|
+
return pulumi.get(self, "run_parallel")
|
600
|
+
|
601
|
+
@run_parallel.setter
|
602
|
+
def run_parallel(self, value: Optional[pulumi.Input[bool]]):
|
603
|
+
pulumi.set(self, "run_parallel", value)
|
604
|
+
|
605
|
+
@property
|
606
|
+
@pulumi.getter(name="shouldFail")
|
607
|
+
def should_fail(self) -> Optional[pulumi.Input[bool]]:
|
608
|
+
"""
|
609
|
+
Allows to invert the behaviour of when the monitor is considered to fail. (Default `false`).
|
610
|
+
"""
|
611
|
+
return pulumi.get(self, "should_fail")
|
612
|
+
|
613
|
+
@should_fail.setter
|
614
|
+
def should_fail(self, value: Optional[pulumi.Input[bool]]):
|
615
|
+
pulumi.set(self, "should_fail", value)
|
616
|
+
|
617
|
+
@property
|
618
|
+
@pulumi.getter
|
619
|
+
def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
620
|
+
"""
|
621
|
+
A list of tags for organizing and filtering checks and monitors.
|
622
|
+
"""
|
623
|
+
return pulumi.get(self, "tags")
|
624
|
+
|
625
|
+
@tags.setter
|
626
|
+
def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
627
|
+
pulumi.set(self, "tags", value)
|
628
|
+
|
629
|
+
@property
|
630
|
+
@pulumi.getter(name="useGlobalAlertSettings")
|
631
|
+
def use_global_alert_settings(self) -> Optional[pulumi.Input[bool]]:
|
632
|
+
"""
|
633
|
+
When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default `true`).
|
634
|
+
"""
|
635
|
+
return pulumi.get(self, "use_global_alert_settings")
|
636
|
+
|
637
|
+
@use_global_alert_settings.setter
|
638
|
+
def use_global_alert_settings(self, value: Optional[pulumi.Input[bool]]):
|
639
|
+
pulumi.set(self, "use_global_alert_settings", value)
|
640
|
+
|
641
|
+
|
642
|
+
class UrlMonitor(pulumi.CustomResource):
|
643
|
+
@overload
|
644
|
+
def __init__(__self__,
|
645
|
+
resource_name: str,
|
646
|
+
opts: Optional[pulumi.ResourceOptions] = None,
|
647
|
+
activated: Optional[pulumi.Input[bool]] = None,
|
648
|
+
alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['UrlMonitorAlertChannelSubscriptionArgs', 'UrlMonitorAlertChannelSubscriptionArgsDict']]]]] = None,
|
649
|
+
alert_settings: Optional[pulumi.Input[Union['UrlMonitorAlertSettingsArgs', 'UrlMonitorAlertSettingsArgsDict']]] = None,
|
650
|
+
degraded_response_time: Optional[pulumi.Input[int]] = None,
|
651
|
+
frequency: Optional[pulumi.Input[int]] = None,
|
652
|
+
frequency_offset: Optional[pulumi.Input[int]] = None,
|
653
|
+
group_id: Optional[pulumi.Input[int]] = None,
|
654
|
+
group_order: Optional[pulumi.Input[int]] = None,
|
655
|
+
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
656
|
+
max_response_time: Optional[pulumi.Input[int]] = None,
|
657
|
+
muted: Optional[pulumi.Input[bool]] = None,
|
658
|
+
name: Optional[pulumi.Input[str]] = None,
|
659
|
+
private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
660
|
+
request: Optional[pulumi.Input[Union['UrlMonitorRequestArgs', 'UrlMonitorRequestArgsDict']]] = None,
|
661
|
+
retry_strategy: Optional[pulumi.Input[Union['UrlMonitorRetryStrategyArgs', 'UrlMonitorRetryStrategyArgsDict']]] = None,
|
662
|
+
run_parallel: Optional[pulumi.Input[bool]] = None,
|
663
|
+
should_fail: Optional[pulumi.Input[bool]] = None,
|
664
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
665
|
+
use_global_alert_settings: Optional[pulumi.Input[bool]] = None,
|
666
|
+
__props__=None):
|
667
|
+
"""
|
668
|
+
Creates a URL Monitor to check HTTP endpoint availability and response times.
|
669
|
+
|
670
|
+
## Example Usage
|
671
|
+
|
672
|
+
```python
|
673
|
+
import pulumi
|
674
|
+
import pulumi_checkly as checkly
|
675
|
+
|
676
|
+
example_url_monitor = checkly.UrlMonitor("example-url-monitor",
|
677
|
+
name="Example URL monitor",
|
678
|
+
activated=True,
|
679
|
+
frequency=2,
|
680
|
+
use_global_alert_settings=True,
|
681
|
+
locations=["eu-west-1"],
|
682
|
+
request={
|
683
|
+
"url": "https://welcome.checklyhq.com",
|
684
|
+
"assertions": [{
|
685
|
+
"source": "STATUS_CODE",
|
686
|
+
"comparison": "EQUALS",
|
687
|
+
"target": "200",
|
688
|
+
}],
|
689
|
+
})
|
690
|
+
```
|
691
|
+
|
692
|
+
:param str resource_name: The name of the resource.
|
693
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
694
|
+
:param pulumi.Input[bool] activated: Determines whether the monitor will run periodically or not after being deployed.
|
695
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['UrlMonitorAlertChannelSubscriptionArgs', 'UrlMonitorAlertChannelSubscriptionArgsDict']]]] alert_channel_subscriptions: An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
|
696
|
+
:param pulumi.Input[Union['UrlMonitorAlertSettingsArgs', 'UrlMonitorAlertSettingsArgsDict']] alert_settings: Determines the alert escalation policy for the monitor.
|
697
|
+
:param pulumi.Input[int] degraded_response_time: The response time in milliseconds where the monitor should be considered degraded. Possible values are between `0` and `30000`. (Default `3000`).
|
698
|
+
:param pulumi.Input[int] frequency: How often the monitor should run in minutes. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
|
699
|
+
:param pulumi.Input[int] frequency_offset: To create a high frequency monitor, set `frequency` to `0` and `frequency_offset` to `10`, `20`, or `30`.
|
700
|
+
:param pulumi.Input[int] group_id: The ID of the check group that this monitor is part of.
|
701
|
+
:param pulumi.Input[int] group_order: The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
|
702
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the this monitor.
|
703
|
+
:param pulumi.Input[int] max_response_time: The response time in milliseconds where the monitor should be considered failing. Possible values are between `0` and `30000`. (Default `5000`).
|
704
|
+
:param pulumi.Input[bool] muted: Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default `false`).
|
705
|
+
:param pulumi.Input[str] name: The name of the monitor.
|
706
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
|
707
|
+
:param pulumi.Input[Union['UrlMonitorRequestArgs', 'UrlMonitorRequestArgsDict']] request: The parameters of the HTTP request.
|
708
|
+
:param pulumi.Input[Union['UrlMonitorRetryStrategyArgs', 'UrlMonitorRetryStrategyArgsDict']] retry_strategy: A strategy for retrying failed monitor runs.
|
709
|
+
:param pulumi.Input[bool] run_parallel: Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default `false`).
|
710
|
+
:param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when the monitor is considered to fail. (Default `false`).
|
711
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks and monitors.
|
712
|
+
:param pulumi.Input[bool] use_global_alert_settings: When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default `true`).
|
713
|
+
"""
|
714
|
+
...
|
715
|
+
@overload
|
716
|
+
def __init__(__self__,
|
717
|
+
resource_name: str,
|
718
|
+
args: UrlMonitorArgs,
|
719
|
+
opts: Optional[pulumi.ResourceOptions] = None):
|
720
|
+
"""
|
721
|
+
Creates a URL Monitor to check HTTP endpoint availability and response times.
|
722
|
+
|
723
|
+
## Example Usage
|
724
|
+
|
725
|
+
```python
|
726
|
+
import pulumi
|
727
|
+
import pulumi_checkly as checkly
|
728
|
+
|
729
|
+
example_url_monitor = checkly.UrlMonitor("example-url-monitor",
|
730
|
+
name="Example URL monitor",
|
731
|
+
activated=True,
|
732
|
+
frequency=2,
|
733
|
+
use_global_alert_settings=True,
|
734
|
+
locations=["eu-west-1"],
|
735
|
+
request={
|
736
|
+
"url": "https://welcome.checklyhq.com",
|
737
|
+
"assertions": [{
|
738
|
+
"source": "STATUS_CODE",
|
739
|
+
"comparison": "EQUALS",
|
740
|
+
"target": "200",
|
741
|
+
}],
|
742
|
+
})
|
743
|
+
```
|
744
|
+
|
745
|
+
:param str resource_name: The name of the resource.
|
746
|
+
:param UrlMonitorArgs args: The arguments to use to populate this resource's properties.
|
747
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
748
|
+
"""
|
749
|
+
...
|
750
|
+
def __init__(__self__, resource_name: str, *args, **kwargs):
|
751
|
+
resource_args, opts = _utilities.get_resource_args_opts(UrlMonitorArgs, pulumi.ResourceOptions, *args, **kwargs)
|
752
|
+
if resource_args is not None:
|
753
|
+
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
|
754
|
+
else:
|
755
|
+
__self__._internal_init(resource_name, *args, **kwargs)
|
756
|
+
|
757
|
+
def _internal_init(__self__,
|
758
|
+
resource_name: str,
|
759
|
+
opts: Optional[pulumi.ResourceOptions] = None,
|
760
|
+
activated: Optional[pulumi.Input[bool]] = None,
|
761
|
+
alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['UrlMonitorAlertChannelSubscriptionArgs', 'UrlMonitorAlertChannelSubscriptionArgsDict']]]]] = None,
|
762
|
+
alert_settings: Optional[pulumi.Input[Union['UrlMonitorAlertSettingsArgs', 'UrlMonitorAlertSettingsArgsDict']]] = None,
|
763
|
+
degraded_response_time: Optional[pulumi.Input[int]] = None,
|
764
|
+
frequency: Optional[pulumi.Input[int]] = None,
|
765
|
+
frequency_offset: Optional[pulumi.Input[int]] = None,
|
766
|
+
group_id: Optional[pulumi.Input[int]] = None,
|
767
|
+
group_order: Optional[pulumi.Input[int]] = None,
|
768
|
+
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
769
|
+
max_response_time: Optional[pulumi.Input[int]] = None,
|
770
|
+
muted: Optional[pulumi.Input[bool]] = None,
|
771
|
+
name: Optional[pulumi.Input[str]] = None,
|
772
|
+
private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
773
|
+
request: Optional[pulumi.Input[Union['UrlMonitorRequestArgs', 'UrlMonitorRequestArgsDict']]] = None,
|
774
|
+
retry_strategy: Optional[pulumi.Input[Union['UrlMonitorRetryStrategyArgs', 'UrlMonitorRetryStrategyArgsDict']]] = None,
|
775
|
+
run_parallel: Optional[pulumi.Input[bool]] = None,
|
776
|
+
should_fail: Optional[pulumi.Input[bool]] = None,
|
777
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
778
|
+
use_global_alert_settings: Optional[pulumi.Input[bool]] = None,
|
779
|
+
__props__=None):
|
780
|
+
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
781
|
+
if not isinstance(opts, pulumi.ResourceOptions):
|
782
|
+
raise TypeError('Expected resource options to be a ResourceOptions instance')
|
783
|
+
if opts.id is None:
|
784
|
+
if __props__ is not None:
|
785
|
+
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
|
786
|
+
__props__ = UrlMonitorArgs.__new__(UrlMonitorArgs)
|
787
|
+
|
788
|
+
if activated is None and not opts.urn:
|
789
|
+
raise TypeError("Missing required property 'activated'")
|
790
|
+
__props__.__dict__["activated"] = activated
|
791
|
+
__props__.__dict__["alert_channel_subscriptions"] = alert_channel_subscriptions
|
792
|
+
__props__.__dict__["alert_settings"] = alert_settings
|
793
|
+
__props__.__dict__["degraded_response_time"] = degraded_response_time
|
794
|
+
if frequency is None and not opts.urn:
|
795
|
+
raise TypeError("Missing required property 'frequency'")
|
796
|
+
__props__.__dict__["frequency"] = frequency
|
797
|
+
__props__.__dict__["frequency_offset"] = frequency_offset
|
798
|
+
__props__.__dict__["group_id"] = group_id
|
799
|
+
__props__.__dict__["group_order"] = group_order
|
800
|
+
__props__.__dict__["locations"] = locations
|
801
|
+
__props__.__dict__["max_response_time"] = max_response_time
|
802
|
+
__props__.__dict__["muted"] = muted
|
803
|
+
__props__.__dict__["name"] = name
|
804
|
+
__props__.__dict__["private_locations"] = private_locations
|
805
|
+
if request is None and not opts.urn:
|
806
|
+
raise TypeError("Missing required property 'request'")
|
807
|
+
__props__.__dict__["request"] = request
|
808
|
+
__props__.__dict__["retry_strategy"] = retry_strategy
|
809
|
+
__props__.__dict__["run_parallel"] = run_parallel
|
810
|
+
__props__.__dict__["should_fail"] = should_fail
|
811
|
+
__props__.__dict__["tags"] = tags
|
812
|
+
__props__.__dict__["use_global_alert_settings"] = use_global_alert_settings
|
813
|
+
super(UrlMonitor, __self__).__init__(
|
814
|
+
'checkly:index/urlMonitor:UrlMonitor',
|
815
|
+
resource_name,
|
816
|
+
__props__,
|
817
|
+
opts)
|
818
|
+
|
819
|
+
@staticmethod
|
820
|
+
def get(resource_name: str,
|
821
|
+
id: pulumi.Input[str],
|
822
|
+
opts: Optional[pulumi.ResourceOptions] = None,
|
823
|
+
activated: Optional[pulumi.Input[bool]] = None,
|
824
|
+
alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['UrlMonitorAlertChannelSubscriptionArgs', 'UrlMonitorAlertChannelSubscriptionArgsDict']]]]] = None,
|
825
|
+
alert_settings: Optional[pulumi.Input[Union['UrlMonitorAlertSettingsArgs', 'UrlMonitorAlertSettingsArgsDict']]] = None,
|
826
|
+
degraded_response_time: Optional[pulumi.Input[int]] = None,
|
827
|
+
frequency: Optional[pulumi.Input[int]] = None,
|
828
|
+
frequency_offset: Optional[pulumi.Input[int]] = None,
|
829
|
+
group_id: Optional[pulumi.Input[int]] = None,
|
830
|
+
group_order: Optional[pulumi.Input[int]] = None,
|
831
|
+
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
832
|
+
max_response_time: Optional[pulumi.Input[int]] = None,
|
833
|
+
muted: Optional[pulumi.Input[bool]] = None,
|
834
|
+
name: Optional[pulumi.Input[str]] = None,
|
835
|
+
private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
836
|
+
request: Optional[pulumi.Input[Union['UrlMonitorRequestArgs', 'UrlMonitorRequestArgsDict']]] = None,
|
837
|
+
retry_strategy: Optional[pulumi.Input[Union['UrlMonitorRetryStrategyArgs', 'UrlMonitorRetryStrategyArgsDict']]] = None,
|
838
|
+
run_parallel: Optional[pulumi.Input[bool]] = None,
|
839
|
+
should_fail: Optional[pulumi.Input[bool]] = None,
|
840
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
841
|
+
use_global_alert_settings: Optional[pulumi.Input[bool]] = None) -> 'UrlMonitor':
|
842
|
+
"""
|
843
|
+
Get an existing UrlMonitor resource's state with the given name, id, and optional extra
|
844
|
+
properties used to qualify the lookup.
|
845
|
+
|
846
|
+
:param str resource_name: The unique name of the resulting resource.
|
847
|
+
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
848
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
849
|
+
:param pulumi.Input[bool] activated: Determines whether the monitor will run periodically or not after being deployed.
|
850
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['UrlMonitorAlertChannelSubscriptionArgs', 'UrlMonitorAlertChannelSubscriptionArgsDict']]]] alert_channel_subscriptions: An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
|
851
|
+
:param pulumi.Input[Union['UrlMonitorAlertSettingsArgs', 'UrlMonitorAlertSettingsArgsDict']] alert_settings: Determines the alert escalation policy for the monitor.
|
852
|
+
:param pulumi.Input[int] degraded_response_time: The response time in milliseconds where the monitor should be considered degraded. Possible values are between `0` and `30000`. (Default `3000`).
|
853
|
+
:param pulumi.Input[int] frequency: How often the monitor should run in minutes. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
|
854
|
+
:param pulumi.Input[int] frequency_offset: To create a high frequency monitor, set `frequency` to `0` and `frequency_offset` to `10`, `20`, or `30`.
|
855
|
+
:param pulumi.Input[int] group_id: The ID of the check group that this monitor is part of.
|
856
|
+
:param pulumi.Input[int] group_order: The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
|
857
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the this monitor.
|
858
|
+
:param pulumi.Input[int] max_response_time: The response time in milliseconds where the monitor should be considered failing. Possible values are between `0` and `30000`. (Default `5000`).
|
859
|
+
:param pulumi.Input[bool] muted: Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default `false`).
|
860
|
+
:param pulumi.Input[str] name: The name of the monitor.
|
861
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
|
862
|
+
:param pulumi.Input[Union['UrlMonitorRequestArgs', 'UrlMonitorRequestArgsDict']] request: The parameters of the HTTP request.
|
863
|
+
:param pulumi.Input[Union['UrlMonitorRetryStrategyArgs', 'UrlMonitorRetryStrategyArgsDict']] retry_strategy: A strategy for retrying failed monitor runs.
|
864
|
+
:param pulumi.Input[bool] run_parallel: Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default `false`).
|
865
|
+
:param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when the monitor is considered to fail. (Default `false`).
|
866
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks and monitors.
|
867
|
+
:param pulumi.Input[bool] use_global_alert_settings: When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default `true`).
|
868
|
+
"""
|
869
|
+
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
870
|
+
|
871
|
+
__props__ = _UrlMonitorState.__new__(_UrlMonitorState)
|
872
|
+
|
873
|
+
__props__.__dict__["activated"] = activated
|
874
|
+
__props__.__dict__["alert_channel_subscriptions"] = alert_channel_subscriptions
|
875
|
+
__props__.__dict__["alert_settings"] = alert_settings
|
876
|
+
__props__.__dict__["degraded_response_time"] = degraded_response_time
|
877
|
+
__props__.__dict__["frequency"] = frequency
|
878
|
+
__props__.__dict__["frequency_offset"] = frequency_offset
|
879
|
+
__props__.__dict__["group_id"] = group_id
|
880
|
+
__props__.__dict__["group_order"] = group_order
|
881
|
+
__props__.__dict__["locations"] = locations
|
882
|
+
__props__.__dict__["max_response_time"] = max_response_time
|
883
|
+
__props__.__dict__["muted"] = muted
|
884
|
+
__props__.__dict__["name"] = name
|
885
|
+
__props__.__dict__["private_locations"] = private_locations
|
886
|
+
__props__.__dict__["request"] = request
|
887
|
+
__props__.__dict__["retry_strategy"] = retry_strategy
|
888
|
+
__props__.__dict__["run_parallel"] = run_parallel
|
889
|
+
__props__.__dict__["should_fail"] = should_fail
|
890
|
+
__props__.__dict__["tags"] = tags
|
891
|
+
__props__.__dict__["use_global_alert_settings"] = use_global_alert_settings
|
892
|
+
return UrlMonitor(resource_name, opts=opts, __props__=__props__)
|
893
|
+
|
894
|
+
@property
|
895
|
+
@pulumi.getter
|
896
|
+
def activated(self) -> pulumi.Output[bool]:
|
897
|
+
"""
|
898
|
+
Determines whether the monitor will run periodically or not after being deployed.
|
899
|
+
"""
|
900
|
+
return pulumi.get(self, "activated")
|
901
|
+
|
902
|
+
@property
|
903
|
+
@pulumi.getter(name="alertChannelSubscriptions")
|
904
|
+
def alert_channel_subscriptions(self) -> pulumi.Output[Optional[Sequence['outputs.UrlMonitorAlertChannelSubscription']]]:
|
905
|
+
"""
|
906
|
+
An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
|
907
|
+
"""
|
908
|
+
return pulumi.get(self, "alert_channel_subscriptions")
|
909
|
+
|
910
|
+
@property
|
911
|
+
@pulumi.getter(name="alertSettings")
|
912
|
+
def alert_settings(self) -> pulumi.Output['outputs.UrlMonitorAlertSettings']:
|
913
|
+
"""
|
914
|
+
Determines the alert escalation policy for the monitor.
|
915
|
+
"""
|
916
|
+
return pulumi.get(self, "alert_settings")
|
917
|
+
|
918
|
+
@property
|
919
|
+
@pulumi.getter(name="degradedResponseTime")
|
920
|
+
def degraded_response_time(self) -> pulumi.Output[Optional[int]]:
|
921
|
+
"""
|
922
|
+
The response time in milliseconds where the monitor should be considered degraded. Possible values are between `0` and `30000`. (Default `3000`).
|
923
|
+
"""
|
924
|
+
return pulumi.get(self, "degraded_response_time")
|
925
|
+
|
926
|
+
@property
|
927
|
+
@pulumi.getter
|
928
|
+
def frequency(self) -> pulumi.Output[int]:
|
929
|
+
"""
|
930
|
+
How often the monitor should run in minutes. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
|
931
|
+
"""
|
932
|
+
return pulumi.get(self, "frequency")
|
933
|
+
|
934
|
+
@property
|
935
|
+
@pulumi.getter(name="frequencyOffset")
|
936
|
+
def frequency_offset(self) -> pulumi.Output[Optional[int]]:
|
937
|
+
"""
|
938
|
+
To create a high frequency monitor, set `frequency` to `0` and `frequency_offset` to `10`, `20`, or `30`.
|
939
|
+
"""
|
940
|
+
return pulumi.get(self, "frequency_offset")
|
941
|
+
|
942
|
+
@property
|
943
|
+
@pulumi.getter(name="groupId")
|
944
|
+
def group_id(self) -> pulumi.Output[Optional[int]]:
|
945
|
+
"""
|
946
|
+
The ID of the check group that this monitor is part of.
|
947
|
+
"""
|
948
|
+
return pulumi.get(self, "group_id")
|
949
|
+
|
950
|
+
@property
|
951
|
+
@pulumi.getter(name="groupOrder")
|
952
|
+
def group_order(self) -> pulumi.Output[Optional[int]]:
|
953
|
+
"""
|
954
|
+
The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
|
955
|
+
"""
|
956
|
+
return pulumi.get(self, "group_order")
|
957
|
+
|
958
|
+
@property
|
959
|
+
@pulumi.getter
|
960
|
+
def locations(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
961
|
+
"""
|
962
|
+
An array of one or more data center locations where to run the this monitor.
|
963
|
+
"""
|
964
|
+
return pulumi.get(self, "locations")
|
965
|
+
|
966
|
+
@property
|
967
|
+
@pulumi.getter(name="maxResponseTime")
|
968
|
+
def max_response_time(self) -> pulumi.Output[Optional[int]]:
|
969
|
+
"""
|
970
|
+
The response time in milliseconds where the monitor should be considered failing. Possible values are between `0` and `30000`. (Default `5000`).
|
971
|
+
"""
|
972
|
+
return pulumi.get(self, "max_response_time")
|
973
|
+
|
974
|
+
@property
|
975
|
+
@pulumi.getter
|
976
|
+
def muted(self) -> pulumi.Output[Optional[bool]]:
|
977
|
+
"""
|
978
|
+
Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default `false`).
|
979
|
+
"""
|
980
|
+
return pulumi.get(self, "muted")
|
981
|
+
|
982
|
+
@property
|
983
|
+
@pulumi.getter
|
984
|
+
def name(self) -> pulumi.Output[str]:
|
985
|
+
"""
|
986
|
+
The name of the monitor.
|
987
|
+
"""
|
988
|
+
return pulumi.get(self, "name")
|
989
|
+
|
990
|
+
@property
|
991
|
+
@pulumi.getter(name="privateLocations")
|
992
|
+
def private_locations(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
993
|
+
"""
|
994
|
+
An array of one or more private locations slugs.
|
995
|
+
"""
|
996
|
+
return pulumi.get(self, "private_locations")
|
997
|
+
|
998
|
+
@property
|
999
|
+
@pulumi.getter
|
1000
|
+
def request(self) -> pulumi.Output['outputs.UrlMonitorRequest']:
|
1001
|
+
"""
|
1002
|
+
The parameters of the HTTP request.
|
1003
|
+
"""
|
1004
|
+
return pulumi.get(self, "request")
|
1005
|
+
|
1006
|
+
@property
|
1007
|
+
@pulumi.getter(name="retryStrategy")
|
1008
|
+
def retry_strategy(self) -> pulumi.Output['outputs.UrlMonitorRetryStrategy']:
|
1009
|
+
"""
|
1010
|
+
A strategy for retrying failed monitor runs.
|
1011
|
+
"""
|
1012
|
+
return pulumi.get(self, "retry_strategy")
|
1013
|
+
|
1014
|
+
@property
|
1015
|
+
@pulumi.getter(name="runParallel")
|
1016
|
+
def run_parallel(self) -> pulumi.Output[Optional[bool]]:
|
1017
|
+
"""
|
1018
|
+
Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default `false`).
|
1019
|
+
"""
|
1020
|
+
return pulumi.get(self, "run_parallel")
|
1021
|
+
|
1022
|
+
@property
|
1023
|
+
@pulumi.getter(name="shouldFail")
|
1024
|
+
def should_fail(self) -> pulumi.Output[Optional[bool]]:
|
1025
|
+
"""
|
1026
|
+
Allows to invert the behaviour of when the monitor is considered to fail. (Default `false`).
|
1027
|
+
"""
|
1028
|
+
return pulumi.get(self, "should_fail")
|
1029
|
+
|
1030
|
+
@property
|
1031
|
+
@pulumi.getter
|
1032
|
+
def tags(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
1033
|
+
"""
|
1034
|
+
A list of tags for organizing and filtering checks and monitors.
|
1035
|
+
"""
|
1036
|
+
return pulumi.get(self, "tags")
|
1037
|
+
|
1038
|
+
@property
|
1039
|
+
@pulumi.getter(name="useGlobalAlertSettings")
|
1040
|
+
def use_global_alert_settings(self) -> pulumi.Output[Optional[bool]]:
|
1041
|
+
"""
|
1042
|
+
When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default `true`).
|
1043
|
+
"""
|
1044
|
+
return pulumi.get(self, "use_global_alert_settings")
|
1045
|
+
|