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.
@@ -0,0 +1,1171 @@
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__ = ['TcpMonitorArgs', 'TcpMonitor']
20
+
21
+ @pulumi.input_type
22
+ class TcpMonitorArgs:
23
+ def __init__(__self__, *,
24
+ activated: pulumi.Input[bool],
25
+ frequency: pulumi.Input[int],
26
+ request: pulumi.Input['TcpMonitorRequestArgs'],
27
+ alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input['TcpMonitorAlertChannelSubscriptionArgs']]]] = None,
28
+ alert_settings: Optional[pulumi.Input['TcpMonitorAlertSettingsArgs']] = 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['TcpMonitorRetryStrategyArgs']] = None,
39
+ run_parallel: Optional[pulumi.Input[bool]] = None,
40
+ runtime_id: Optional[pulumi.Input[str]] = None,
41
+ should_fail: Optional[pulumi.Input[bool]] = None,
42
+ tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
43
+ use_global_alert_settings: Optional[pulumi.Input[bool]] = None):
44
+ """
45
+ The set of arguments for constructing a TcpMonitor resource.
46
+ :param pulumi.Input[bool] activated: Determines if the check is running or not. Possible values `true`, and `false`.
47
+ :param pulumi.Input[int] frequency: The frequency in minutes to run the check. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
48
+ :param pulumi.Input['TcpMonitorRequestArgs'] request: The parameters for the TCP connection.
49
+ :param pulumi.Input[Sequence[pulumi.Input['TcpMonitorAlertChannelSubscriptionArgs']]] 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 check, we won't be able to alert you in case something goes wrong with it.
50
+ :param pulumi.Input[int] degraded_response_time: The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 5000. (Default `4000`).
51
+ :param pulumi.Input[int] frequency_offset: To create a high frequency check, the property `frequency` must be `0` and `frequency_offset` can be `10`, `20` or `30`.
52
+ :param pulumi.Input[int] group_id: The id of the check group this check is part of.
53
+ :param pulumi.Input[int] group_order: The position of this check in a check group. It determines in what order checks 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 check. (Default ["us-east-1"])
55
+ :param pulumi.Input[int] max_response_time: The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 5000. (Default `5000`).
56
+ :param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check fails/degrades/recovers.
57
+ :param pulumi.Input[str] name: The name of the check.
58
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
59
+ :param pulumi.Input['TcpMonitorRetryStrategyArgs'] retry_strategy: A strategy for retrying failed check runs.
60
+ :param pulumi.Input[bool] run_parallel: Determines if the check should run in all selected locations in parallel or round-robin.
61
+ :param pulumi.Input[str] runtime_id: The ID of the runtime to use for this check.
62
+ :param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when a check is considered to fail.
63
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks.
64
+ :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 check.
65
+ """
66
+ pulumi.set(__self__, "activated", activated)
67
+ pulumi.set(__self__, "frequency", frequency)
68
+ pulumi.set(__self__, "request", request)
69
+ if alert_channel_subscriptions is not None:
70
+ pulumi.set(__self__, "alert_channel_subscriptions", alert_channel_subscriptions)
71
+ if alert_settings is not None:
72
+ pulumi.set(__self__, "alert_settings", alert_settings)
73
+ if degraded_response_time is not None:
74
+ pulumi.set(__self__, "degraded_response_time", degraded_response_time)
75
+ if frequency_offset is not None:
76
+ pulumi.set(__self__, "frequency_offset", frequency_offset)
77
+ if group_id is not None:
78
+ pulumi.set(__self__, "group_id", group_id)
79
+ if group_order is not None:
80
+ pulumi.set(__self__, "group_order", group_order)
81
+ if locations is not None:
82
+ pulumi.set(__self__, "locations", locations)
83
+ if max_response_time is not None:
84
+ pulumi.set(__self__, "max_response_time", max_response_time)
85
+ if muted is not None:
86
+ pulumi.set(__self__, "muted", muted)
87
+ if name is not None:
88
+ pulumi.set(__self__, "name", name)
89
+ if private_locations is not None:
90
+ pulumi.set(__self__, "private_locations", private_locations)
91
+ if retry_strategy is not None:
92
+ pulumi.set(__self__, "retry_strategy", retry_strategy)
93
+ if run_parallel is not None:
94
+ pulumi.set(__self__, "run_parallel", run_parallel)
95
+ if runtime_id is not None:
96
+ pulumi.set(__self__, "runtime_id", runtime_id)
97
+ if should_fail is not None:
98
+ pulumi.set(__self__, "should_fail", should_fail)
99
+ if tags is not None:
100
+ pulumi.set(__self__, "tags", tags)
101
+ if use_global_alert_settings is not None:
102
+ pulumi.set(__self__, "use_global_alert_settings", use_global_alert_settings)
103
+
104
+ @property
105
+ @pulumi.getter
106
+ def activated(self) -> pulumi.Input[bool]:
107
+ """
108
+ Determines if the check is running or not. Possible values `true`, and `false`.
109
+ """
110
+ return pulumi.get(self, "activated")
111
+
112
+ @activated.setter
113
+ def activated(self, value: pulumi.Input[bool]):
114
+ pulumi.set(self, "activated", value)
115
+
116
+ @property
117
+ @pulumi.getter
118
+ def frequency(self) -> pulumi.Input[int]:
119
+ """
120
+ The frequency in minutes to run the check. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
121
+ """
122
+ return pulumi.get(self, "frequency")
123
+
124
+ @frequency.setter
125
+ def frequency(self, value: pulumi.Input[int]):
126
+ pulumi.set(self, "frequency", value)
127
+
128
+ @property
129
+ @pulumi.getter
130
+ def request(self) -> pulumi.Input['TcpMonitorRequestArgs']:
131
+ """
132
+ The parameters for the TCP connection.
133
+ """
134
+ return pulumi.get(self, "request")
135
+
136
+ @request.setter
137
+ def request(self, value: pulumi.Input['TcpMonitorRequestArgs']):
138
+ pulumi.set(self, "request", value)
139
+
140
+ @property
141
+ @pulumi.getter(name="alertChannelSubscriptions")
142
+ def alert_channel_subscriptions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TcpMonitorAlertChannelSubscriptionArgs']]]]:
143
+ """
144
+ An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
145
+ """
146
+ return pulumi.get(self, "alert_channel_subscriptions")
147
+
148
+ @alert_channel_subscriptions.setter
149
+ def alert_channel_subscriptions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TcpMonitorAlertChannelSubscriptionArgs']]]]):
150
+ pulumi.set(self, "alert_channel_subscriptions", value)
151
+
152
+ @property
153
+ @pulumi.getter(name="alertSettings")
154
+ def alert_settings(self) -> Optional[pulumi.Input['TcpMonitorAlertSettingsArgs']]:
155
+ return pulumi.get(self, "alert_settings")
156
+
157
+ @alert_settings.setter
158
+ def alert_settings(self, value: Optional[pulumi.Input['TcpMonitorAlertSettingsArgs']]):
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 starting from which a check should be considered degraded. Possible values are between 0 and 5000. (Default `4000`).
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 check, the property `frequency` must be `0` and `frequency_offset` can be `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 this check 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 this check in a check group. It determines in what order checks 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 check. (Default ["us-east-1"])
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 starting from which a check should be considered failing. Possible values are between 0 and 5000. (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 a check fails/degrades/recovers.
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 check.
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['TcpMonitorRetryStrategyArgs']]:
272
+ """
273
+ A strategy for retrying failed check runs.
274
+ """
275
+ return pulumi.get(self, "retry_strategy")
276
+
277
+ @retry_strategy.setter
278
+ def retry_strategy(self, value: Optional[pulumi.Input['TcpMonitorRetryStrategyArgs']]):
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 if the check should run in all selected locations in parallel or round-robin.
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="runtimeId")
295
+ def runtime_id(self) -> Optional[pulumi.Input[str]]:
296
+ """
297
+ The ID of the runtime to use for this check.
298
+ """
299
+ return pulumi.get(self, "runtime_id")
300
+
301
+ @runtime_id.setter
302
+ def runtime_id(self, value: Optional[pulumi.Input[str]]):
303
+ pulumi.set(self, "runtime_id", value)
304
+
305
+ @property
306
+ @pulumi.getter(name="shouldFail")
307
+ def should_fail(self) -> Optional[pulumi.Input[bool]]:
308
+ """
309
+ Allows to invert the behaviour of when a check is considered to fail.
310
+ """
311
+ return pulumi.get(self, "should_fail")
312
+
313
+ @should_fail.setter
314
+ def should_fail(self, value: Optional[pulumi.Input[bool]]):
315
+ pulumi.set(self, "should_fail", value)
316
+
317
+ @property
318
+ @pulumi.getter
319
+ def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
320
+ """
321
+ A list of tags for organizing and filtering checks.
322
+ """
323
+ return pulumi.get(self, "tags")
324
+
325
+ @tags.setter
326
+ def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
327
+ pulumi.set(self, "tags", value)
328
+
329
+ @property
330
+ @pulumi.getter(name="useGlobalAlertSettings")
331
+ def use_global_alert_settings(self) -> Optional[pulumi.Input[bool]]:
332
+ """
333
+ When true, the account level alert settings will be used, not the alert setting defined on this check.
334
+ """
335
+ return pulumi.get(self, "use_global_alert_settings")
336
+
337
+ @use_global_alert_settings.setter
338
+ def use_global_alert_settings(self, value: Optional[pulumi.Input[bool]]):
339
+ pulumi.set(self, "use_global_alert_settings", value)
340
+
341
+
342
+ @pulumi.input_type
343
+ class _TcpMonitorState:
344
+ def __init__(__self__, *,
345
+ activated: Optional[pulumi.Input[bool]] = None,
346
+ alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input['TcpMonitorAlertChannelSubscriptionArgs']]]] = None,
347
+ alert_settings: Optional[pulumi.Input['TcpMonitorAlertSettingsArgs']] = None,
348
+ degraded_response_time: Optional[pulumi.Input[int]] = None,
349
+ frequency: Optional[pulumi.Input[int]] = None,
350
+ frequency_offset: Optional[pulumi.Input[int]] = None,
351
+ group_id: Optional[pulumi.Input[int]] = None,
352
+ group_order: Optional[pulumi.Input[int]] = None,
353
+ locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
354
+ max_response_time: Optional[pulumi.Input[int]] = None,
355
+ muted: Optional[pulumi.Input[bool]] = None,
356
+ name: Optional[pulumi.Input[str]] = None,
357
+ private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
358
+ request: Optional[pulumi.Input['TcpMonitorRequestArgs']] = None,
359
+ retry_strategy: Optional[pulumi.Input['TcpMonitorRetryStrategyArgs']] = None,
360
+ run_parallel: Optional[pulumi.Input[bool]] = None,
361
+ runtime_id: Optional[pulumi.Input[str]] = None,
362
+ should_fail: Optional[pulumi.Input[bool]] = None,
363
+ tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
364
+ use_global_alert_settings: Optional[pulumi.Input[bool]] = None):
365
+ """
366
+ Input properties used for looking up and filtering TcpMonitor resources.
367
+ :param pulumi.Input[bool] activated: Determines if the check is running or not. Possible values `true`, and `false`.
368
+ :param pulumi.Input[Sequence[pulumi.Input['TcpMonitorAlertChannelSubscriptionArgs']]] 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 check, we won't be able to alert you in case something goes wrong with it.
369
+ :param pulumi.Input[int] degraded_response_time: The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 5000. (Default `4000`).
370
+ :param pulumi.Input[int] frequency: The frequency in minutes to run the check. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
371
+ :param pulumi.Input[int] frequency_offset: To create a high frequency check, the property `frequency` must be `0` and `frequency_offset` can be `10`, `20` or `30`.
372
+ :param pulumi.Input[int] group_id: The id of the check group this check is part of.
373
+ :param pulumi.Input[int] group_order: The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
374
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
375
+ :param pulumi.Input[int] max_response_time: The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 5000. (Default `5000`).
376
+ :param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check fails/degrades/recovers.
377
+ :param pulumi.Input[str] name: The name of the check.
378
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
379
+ :param pulumi.Input['TcpMonitorRequestArgs'] request: The parameters for the TCP connection.
380
+ :param pulumi.Input['TcpMonitorRetryStrategyArgs'] retry_strategy: A strategy for retrying failed check runs.
381
+ :param pulumi.Input[bool] run_parallel: Determines if the check should run in all selected locations in parallel or round-robin.
382
+ :param pulumi.Input[str] runtime_id: The ID of the runtime to use for this check.
383
+ :param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when a check is considered to fail.
384
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks.
385
+ :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 check.
386
+ """
387
+ if activated is not None:
388
+ pulumi.set(__self__, "activated", activated)
389
+ if alert_channel_subscriptions is not None:
390
+ pulumi.set(__self__, "alert_channel_subscriptions", alert_channel_subscriptions)
391
+ if alert_settings is not None:
392
+ pulumi.set(__self__, "alert_settings", alert_settings)
393
+ if degraded_response_time is not None:
394
+ pulumi.set(__self__, "degraded_response_time", degraded_response_time)
395
+ if frequency is not None:
396
+ pulumi.set(__self__, "frequency", frequency)
397
+ if frequency_offset is not None:
398
+ pulumi.set(__self__, "frequency_offset", frequency_offset)
399
+ if group_id is not None:
400
+ pulumi.set(__self__, "group_id", group_id)
401
+ if group_order is not None:
402
+ pulumi.set(__self__, "group_order", group_order)
403
+ if locations is not None:
404
+ pulumi.set(__self__, "locations", locations)
405
+ if max_response_time is not None:
406
+ pulumi.set(__self__, "max_response_time", max_response_time)
407
+ if muted is not None:
408
+ pulumi.set(__self__, "muted", muted)
409
+ if name is not None:
410
+ pulumi.set(__self__, "name", name)
411
+ if private_locations is not None:
412
+ pulumi.set(__self__, "private_locations", private_locations)
413
+ if request is not None:
414
+ pulumi.set(__self__, "request", request)
415
+ if retry_strategy is not None:
416
+ pulumi.set(__self__, "retry_strategy", retry_strategy)
417
+ if run_parallel is not None:
418
+ pulumi.set(__self__, "run_parallel", run_parallel)
419
+ if runtime_id is not None:
420
+ pulumi.set(__self__, "runtime_id", runtime_id)
421
+ if should_fail is not None:
422
+ pulumi.set(__self__, "should_fail", should_fail)
423
+ if tags is not None:
424
+ pulumi.set(__self__, "tags", tags)
425
+ if use_global_alert_settings is not None:
426
+ pulumi.set(__self__, "use_global_alert_settings", use_global_alert_settings)
427
+
428
+ @property
429
+ @pulumi.getter
430
+ def activated(self) -> Optional[pulumi.Input[bool]]:
431
+ """
432
+ Determines if the check is running or not. Possible values `true`, and `false`.
433
+ """
434
+ return pulumi.get(self, "activated")
435
+
436
+ @activated.setter
437
+ def activated(self, value: Optional[pulumi.Input[bool]]):
438
+ pulumi.set(self, "activated", value)
439
+
440
+ @property
441
+ @pulumi.getter(name="alertChannelSubscriptions")
442
+ def alert_channel_subscriptions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TcpMonitorAlertChannelSubscriptionArgs']]]]:
443
+ """
444
+ An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
445
+ """
446
+ return pulumi.get(self, "alert_channel_subscriptions")
447
+
448
+ @alert_channel_subscriptions.setter
449
+ def alert_channel_subscriptions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TcpMonitorAlertChannelSubscriptionArgs']]]]):
450
+ pulumi.set(self, "alert_channel_subscriptions", value)
451
+
452
+ @property
453
+ @pulumi.getter(name="alertSettings")
454
+ def alert_settings(self) -> Optional[pulumi.Input['TcpMonitorAlertSettingsArgs']]:
455
+ return pulumi.get(self, "alert_settings")
456
+
457
+ @alert_settings.setter
458
+ def alert_settings(self, value: Optional[pulumi.Input['TcpMonitorAlertSettingsArgs']]):
459
+ pulumi.set(self, "alert_settings", value)
460
+
461
+ @property
462
+ @pulumi.getter(name="degradedResponseTime")
463
+ def degraded_response_time(self) -> Optional[pulumi.Input[int]]:
464
+ """
465
+ The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 5000. (Default `4000`).
466
+ """
467
+ return pulumi.get(self, "degraded_response_time")
468
+
469
+ @degraded_response_time.setter
470
+ def degraded_response_time(self, value: Optional[pulumi.Input[int]]):
471
+ pulumi.set(self, "degraded_response_time", value)
472
+
473
+ @property
474
+ @pulumi.getter
475
+ def frequency(self) -> Optional[pulumi.Input[int]]:
476
+ """
477
+ The frequency in minutes to run the check. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
478
+ """
479
+ return pulumi.get(self, "frequency")
480
+
481
+ @frequency.setter
482
+ def frequency(self, value: Optional[pulumi.Input[int]]):
483
+ pulumi.set(self, "frequency", value)
484
+
485
+ @property
486
+ @pulumi.getter(name="frequencyOffset")
487
+ def frequency_offset(self) -> Optional[pulumi.Input[int]]:
488
+ """
489
+ To create a high frequency check, the property `frequency` must be `0` and `frequency_offset` can be `10`, `20` or `30`.
490
+ """
491
+ return pulumi.get(self, "frequency_offset")
492
+
493
+ @frequency_offset.setter
494
+ def frequency_offset(self, value: Optional[pulumi.Input[int]]):
495
+ pulumi.set(self, "frequency_offset", value)
496
+
497
+ @property
498
+ @pulumi.getter(name="groupId")
499
+ def group_id(self) -> Optional[pulumi.Input[int]]:
500
+ """
501
+ The id of the check group this check is part of.
502
+ """
503
+ return pulumi.get(self, "group_id")
504
+
505
+ @group_id.setter
506
+ def group_id(self, value: Optional[pulumi.Input[int]]):
507
+ pulumi.set(self, "group_id", value)
508
+
509
+ @property
510
+ @pulumi.getter(name="groupOrder")
511
+ def group_order(self) -> Optional[pulumi.Input[int]]:
512
+ """
513
+ The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
514
+ """
515
+ return pulumi.get(self, "group_order")
516
+
517
+ @group_order.setter
518
+ def group_order(self, value: Optional[pulumi.Input[int]]):
519
+ pulumi.set(self, "group_order", value)
520
+
521
+ @property
522
+ @pulumi.getter
523
+ def locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
524
+ """
525
+ An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
526
+ """
527
+ return pulumi.get(self, "locations")
528
+
529
+ @locations.setter
530
+ def locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
531
+ pulumi.set(self, "locations", value)
532
+
533
+ @property
534
+ @pulumi.getter(name="maxResponseTime")
535
+ def max_response_time(self) -> Optional[pulumi.Input[int]]:
536
+ """
537
+ The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 5000. (Default `5000`).
538
+ """
539
+ return pulumi.get(self, "max_response_time")
540
+
541
+ @max_response_time.setter
542
+ def max_response_time(self, value: Optional[pulumi.Input[int]]):
543
+ pulumi.set(self, "max_response_time", value)
544
+
545
+ @property
546
+ @pulumi.getter
547
+ def muted(self) -> Optional[pulumi.Input[bool]]:
548
+ """
549
+ Determines if any notifications will be sent out when a check fails/degrades/recovers.
550
+ """
551
+ return pulumi.get(self, "muted")
552
+
553
+ @muted.setter
554
+ def muted(self, value: Optional[pulumi.Input[bool]]):
555
+ pulumi.set(self, "muted", value)
556
+
557
+ @property
558
+ @pulumi.getter
559
+ def name(self) -> Optional[pulumi.Input[str]]:
560
+ """
561
+ The name of the check.
562
+ """
563
+ return pulumi.get(self, "name")
564
+
565
+ @name.setter
566
+ def name(self, value: Optional[pulumi.Input[str]]):
567
+ pulumi.set(self, "name", value)
568
+
569
+ @property
570
+ @pulumi.getter(name="privateLocations")
571
+ def private_locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
572
+ """
573
+ An array of one or more private locations slugs.
574
+ """
575
+ return pulumi.get(self, "private_locations")
576
+
577
+ @private_locations.setter
578
+ def private_locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
579
+ pulumi.set(self, "private_locations", value)
580
+
581
+ @property
582
+ @pulumi.getter
583
+ def request(self) -> Optional[pulumi.Input['TcpMonitorRequestArgs']]:
584
+ """
585
+ The parameters for the TCP connection.
586
+ """
587
+ return pulumi.get(self, "request")
588
+
589
+ @request.setter
590
+ def request(self, value: Optional[pulumi.Input['TcpMonitorRequestArgs']]):
591
+ pulumi.set(self, "request", value)
592
+
593
+ @property
594
+ @pulumi.getter(name="retryStrategy")
595
+ def retry_strategy(self) -> Optional[pulumi.Input['TcpMonitorRetryStrategyArgs']]:
596
+ """
597
+ A strategy for retrying failed check runs.
598
+ """
599
+ return pulumi.get(self, "retry_strategy")
600
+
601
+ @retry_strategy.setter
602
+ def retry_strategy(self, value: Optional[pulumi.Input['TcpMonitorRetryStrategyArgs']]):
603
+ pulumi.set(self, "retry_strategy", value)
604
+
605
+ @property
606
+ @pulumi.getter(name="runParallel")
607
+ def run_parallel(self) -> Optional[pulumi.Input[bool]]:
608
+ """
609
+ Determines if the check should run in all selected locations in parallel or round-robin.
610
+ """
611
+ return pulumi.get(self, "run_parallel")
612
+
613
+ @run_parallel.setter
614
+ def run_parallel(self, value: Optional[pulumi.Input[bool]]):
615
+ pulumi.set(self, "run_parallel", value)
616
+
617
+ @property
618
+ @pulumi.getter(name="runtimeId")
619
+ def runtime_id(self) -> Optional[pulumi.Input[str]]:
620
+ """
621
+ The ID of the runtime to use for this check.
622
+ """
623
+ return pulumi.get(self, "runtime_id")
624
+
625
+ @runtime_id.setter
626
+ def runtime_id(self, value: Optional[pulumi.Input[str]]):
627
+ pulumi.set(self, "runtime_id", value)
628
+
629
+ @property
630
+ @pulumi.getter(name="shouldFail")
631
+ def should_fail(self) -> Optional[pulumi.Input[bool]]:
632
+ """
633
+ Allows to invert the behaviour of when a check is considered to fail.
634
+ """
635
+ return pulumi.get(self, "should_fail")
636
+
637
+ @should_fail.setter
638
+ def should_fail(self, value: Optional[pulumi.Input[bool]]):
639
+ pulumi.set(self, "should_fail", value)
640
+
641
+ @property
642
+ @pulumi.getter
643
+ def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
644
+ """
645
+ A list of tags for organizing and filtering checks.
646
+ """
647
+ return pulumi.get(self, "tags")
648
+
649
+ @tags.setter
650
+ def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
651
+ pulumi.set(self, "tags", value)
652
+
653
+ @property
654
+ @pulumi.getter(name="useGlobalAlertSettings")
655
+ def use_global_alert_settings(self) -> Optional[pulumi.Input[bool]]:
656
+ """
657
+ When true, the account level alert settings will be used, not the alert setting defined on this check.
658
+ """
659
+ return pulumi.get(self, "use_global_alert_settings")
660
+
661
+ @use_global_alert_settings.setter
662
+ def use_global_alert_settings(self, value: Optional[pulumi.Input[bool]]):
663
+ pulumi.set(self, "use_global_alert_settings", value)
664
+
665
+
666
+ class TcpMonitor(pulumi.CustomResource):
667
+ @overload
668
+ def __init__(__self__,
669
+ resource_name: str,
670
+ opts: Optional[pulumi.ResourceOptions] = None,
671
+ activated: Optional[pulumi.Input[bool]] = None,
672
+ alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TcpMonitorAlertChannelSubscriptionArgs', 'TcpMonitorAlertChannelSubscriptionArgsDict']]]]] = None,
673
+ alert_settings: Optional[pulumi.Input[Union['TcpMonitorAlertSettingsArgs', 'TcpMonitorAlertSettingsArgsDict']]] = None,
674
+ degraded_response_time: Optional[pulumi.Input[int]] = None,
675
+ frequency: Optional[pulumi.Input[int]] = None,
676
+ frequency_offset: Optional[pulumi.Input[int]] = None,
677
+ group_id: Optional[pulumi.Input[int]] = None,
678
+ group_order: Optional[pulumi.Input[int]] = None,
679
+ locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
680
+ max_response_time: Optional[pulumi.Input[int]] = None,
681
+ muted: Optional[pulumi.Input[bool]] = None,
682
+ name: Optional[pulumi.Input[str]] = None,
683
+ private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
684
+ request: Optional[pulumi.Input[Union['TcpMonitorRequestArgs', 'TcpMonitorRequestArgsDict']]] = None,
685
+ retry_strategy: Optional[pulumi.Input[Union['TcpMonitorRetryStrategyArgs', 'TcpMonitorRetryStrategyArgsDict']]] = None,
686
+ run_parallel: Optional[pulumi.Input[bool]] = None,
687
+ runtime_id: Optional[pulumi.Input[str]] = None,
688
+ should_fail: Optional[pulumi.Input[bool]] = None,
689
+ tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
690
+ use_global_alert_settings: Optional[pulumi.Input[bool]] = None,
691
+ __props__=None):
692
+ """
693
+ TCP checks allow you to monitor remote endpoints at a lower level.
694
+
695
+ ## Example Usage
696
+
697
+ ```python
698
+ import pulumi
699
+ import pulumi_checkly as checkly
700
+
701
+ # Basic TCP monitor
702
+ example_tcp_monitor = checkly.TcpMonitor("example-tcp-monitor",
703
+ name="Example TCP monitor",
704
+ activated=True,
705
+ should_fail=False,
706
+ frequency=1,
707
+ use_global_alert_settings=True,
708
+ locations=["us-west-1"],
709
+ request={
710
+ "hostname": "api.checklyhq.com",
711
+ "port": 80,
712
+ })
713
+ # A more complex example using assertions and setting alerts
714
+ example_tcp_monitor_2 = checkly.TcpMonitor("example-tcp-monitor-2",
715
+ name="Example TCP monitor 2",
716
+ activated=True,
717
+ should_fail=True,
718
+ frequency=1,
719
+ degraded_response_time=5000,
720
+ max_response_time=10000,
721
+ locations=[
722
+ "us-west-1",
723
+ "ap-northeast-1",
724
+ "ap-south-1",
725
+ ],
726
+ alert_settings={
727
+ "escalation_type": "RUN_BASED",
728
+ "run_based_escalations": [{
729
+ "failed_run_threshold": 1,
730
+ }],
731
+ "reminders": [{
732
+ "amount": 1,
733
+ }],
734
+ },
735
+ retry_strategy={
736
+ "type": "FIXED",
737
+ "base_backoff_seconds": 60,
738
+ "max_duration_seconds": 600,
739
+ "max_retries": 3,
740
+ "same_region": False,
741
+ },
742
+ request={
743
+ "hostname": "api.checklyhq.com",
744
+ "port": 80,
745
+ "data": "hello",
746
+ "assertions": [
747
+ {
748
+ "source": "RESPONSE_DATA",
749
+ "property": "",
750
+ "comparison": "CONTAINS",
751
+ "target": "welcome",
752
+ },
753
+ {
754
+ "source": "RESPONSE_TIME",
755
+ "property": "",
756
+ "comparison": "LESS_THAN",
757
+ "target": "2000",
758
+ },
759
+ ],
760
+ })
761
+ ```
762
+
763
+ :param str resource_name: The name of the resource.
764
+ :param pulumi.ResourceOptions opts: Options for the resource.
765
+ :param pulumi.Input[bool] activated: Determines if the check is running or not. Possible values `true`, and `false`.
766
+ :param pulumi.Input[Sequence[pulumi.Input[Union['TcpMonitorAlertChannelSubscriptionArgs', 'TcpMonitorAlertChannelSubscriptionArgsDict']]]] 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 check, we won't be able to alert you in case something goes wrong with it.
767
+ :param pulumi.Input[int] degraded_response_time: The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 5000. (Default `4000`).
768
+ :param pulumi.Input[int] frequency: The frequency in minutes to run the check. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
769
+ :param pulumi.Input[int] frequency_offset: To create a high frequency check, the property `frequency` must be `0` and `frequency_offset` can be `10`, `20` or `30`.
770
+ :param pulumi.Input[int] group_id: The id of the check group this check is part of.
771
+ :param pulumi.Input[int] group_order: The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
772
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
773
+ :param pulumi.Input[int] max_response_time: The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 5000. (Default `5000`).
774
+ :param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check fails/degrades/recovers.
775
+ :param pulumi.Input[str] name: The name of the check.
776
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
777
+ :param pulumi.Input[Union['TcpMonitorRequestArgs', 'TcpMonitorRequestArgsDict']] request: The parameters for the TCP connection.
778
+ :param pulumi.Input[Union['TcpMonitorRetryStrategyArgs', 'TcpMonitorRetryStrategyArgsDict']] retry_strategy: A strategy for retrying failed check runs.
779
+ :param pulumi.Input[bool] run_parallel: Determines if the check should run in all selected locations in parallel or round-robin.
780
+ :param pulumi.Input[str] runtime_id: The ID of the runtime to use for this check.
781
+ :param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when a check is considered to fail.
782
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks.
783
+ :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 check.
784
+ """
785
+ ...
786
+ @overload
787
+ def __init__(__self__,
788
+ resource_name: str,
789
+ args: TcpMonitorArgs,
790
+ opts: Optional[pulumi.ResourceOptions] = None):
791
+ """
792
+ TCP checks allow you to monitor remote endpoints at a lower level.
793
+
794
+ ## Example Usage
795
+
796
+ ```python
797
+ import pulumi
798
+ import pulumi_checkly as checkly
799
+
800
+ # Basic TCP monitor
801
+ example_tcp_monitor = checkly.TcpMonitor("example-tcp-monitor",
802
+ name="Example TCP monitor",
803
+ activated=True,
804
+ should_fail=False,
805
+ frequency=1,
806
+ use_global_alert_settings=True,
807
+ locations=["us-west-1"],
808
+ request={
809
+ "hostname": "api.checklyhq.com",
810
+ "port": 80,
811
+ })
812
+ # A more complex example using assertions and setting alerts
813
+ example_tcp_monitor_2 = checkly.TcpMonitor("example-tcp-monitor-2",
814
+ name="Example TCP monitor 2",
815
+ activated=True,
816
+ should_fail=True,
817
+ frequency=1,
818
+ degraded_response_time=5000,
819
+ max_response_time=10000,
820
+ locations=[
821
+ "us-west-1",
822
+ "ap-northeast-1",
823
+ "ap-south-1",
824
+ ],
825
+ alert_settings={
826
+ "escalation_type": "RUN_BASED",
827
+ "run_based_escalations": [{
828
+ "failed_run_threshold": 1,
829
+ }],
830
+ "reminders": [{
831
+ "amount": 1,
832
+ }],
833
+ },
834
+ retry_strategy={
835
+ "type": "FIXED",
836
+ "base_backoff_seconds": 60,
837
+ "max_duration_seconds": 600,
838
+ "max_retries": 3,
839
+ "same_region": False,
840
+ },
841
+ request={
842
+ "hostname": "api.checklyhq.com",
843
+ "port": 80,
844
+ "data": "hello",
845
+ "assertions": [
846
+ {
847
+ "source": "RESPONSE_DATA",
848
+ "property": "",
849
+ "comparison": "CONTAINS",
850
+ "target": "welcome",
851
+ },
852
+ {
853
+ "source": "RESPONSE_TIME",
854
+ "property": "",
855
+ "comparison": "LESS_THAN",
856
+ "target": "2000",
857
+ },
858
+ ],
859
+ })
860
+ ```
861
+
862
+ :param str resource_name: The name of the resource.
863
+ :param TcpMonitorArgs args: The arguments to use to populate this resource's properties.
864
+ :param pulumi.ResourceOptions opts: Options for the resource.
865
+ """
866
+ ...
867
+ def __init__(__self__, resource_name: str, *args, **kwargs):
868
+ resource_args, opts = _utilities.get_resource_args_opts(TcpMonitorArgs, pulumi.ResourceOptions, *args, **kwargs)
869
+ if resource_args is not None:
870
+ __self__._internal_init(resource_name, opts, **resource_args.__dict__)
871
+ else:
872
+ __self__._internal_init(resource_name, *args, **kwargs)
873
+
874
+ def _internal_init(__self__,
875
+ resource_name: str,
876
+ opts: Optional[pulumi.ResourceOptions] = None,
877
+ activated: Optional[pulumi.Input[bool]] = None,
878
+ alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TcpMonitorAlertChannelSubscriptionArgs', 'TcpMonitorAlertChannelSubscriptionArgsDict']]]]] = None,
879
+ alert_settings: Optional[pulumi.Input[Union['TcpMonitorAlertSettingsArgs', 'TcpMonitorAlertSettingsArgsDict']]] = None,
880
+ degraded_response_time: Optional[pulumi.Input[int]] = None,
881
+ frequency: Optional[pulumi.Input[int]] = None,
882
+ frequency_offset: Optional[pulumi.Input[int]] = None,
883
+ group_id: Optional[pulumi.Input[int]] = None,
884
+ group_order: Optional[pulumi.Input[int]] = None,
885
+ locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
886
+ max_response_time: Optional[pulumi.Input[int]] = None,
887
+ muted: Optional[pulumi.Input[bool]] = None,
888
+ name: Optional[pulumi.Input[str]] = None,
889
+ private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
890
+ request: Optional[pulumi.Input[Union['TcpMonitorRequestArgs', 'TcpMonitorRequestArgsDict']]] = None,
891
+ retry_strategy: Optional[pulumi.Input[Union['TcpMonitorRetryStrategyArgs', 'TcpMonitorRetryStrategyArgsDict']]] = None,
892
+ run_parallel: Optional[pulumi.Input[bool]] = None,
893
+ runtime_id: Optional[pulumi.Input[str]] = None,
894
+ should_fail: Optional[pulumi.Input[bool]] = None,
895
+ tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
896
+ use_global_alert_settings: Optional[pulumi.Input[bool]] = None,
897
+ __props__=None):
898
+ opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
899
+ if not isinstance(opts, pulumi.ResourceOptions):
900
+ raise TypeError('Expected resource options to be a ResourceOptions instance')
901
+ if opts.id is None:
902
+ if __props__ is not None:
903
+ raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
904
+ __props__ = TcpMonitorArgs.__new__(TcpMonitorArgs)
905
+
906
+ if activated is None and not opts.urn:
907
+ raise TypeError("Missing required property 'activated'")
908
+ __props__.__dict__["activated"] = activated
909
+ __props__.__dict__["alert_channel_subscriptions"] = alert_channel_subscriptions
910
+ __props__.__dict__["alert_settings"] = alert_settings
911
+ __props__.__dict__["degraded_response_time"] = degraded_response_time
912
+ if frequency is None and not opts.urn:
913
+ raise TypeError("Missing required property 'frequency'")
914
+ __props__.__dict__["frequency"] = frequency
915
+ __props__.__dict__["frequency_offset"] = frequency_offset
916
+ __props__.__dict__["group_id"] = group_id
917
+ __props__.__dict__["group_order"] = group_order
918
+ __props__.__dict__["locations"] = locations
919
+ __props__.__dict__["max_response_time"] = max_response_time
920
+ __props__.__dict__["muted"] = muted
921
+ __props__.__dict__["name"] = name
922
+ __props__.__dict__["private_locations"] = private_locations
923
+ if request is None and not opts.urn:
924
+ raise TypeError("Missing required property 'request'")
925
+ __props__.__dict__["request"] = request
926
+ __props__.__dict__["retry_strategy"] = retry_strategy
927
+ __props__.__dict__["run_parallel"] = run_parallel
928
+ __props__.__dict__["runtime_id"] = runtime_id
929
+ __props__.__dict__["should_fail"] = should_fail
930
+ __props__.__dict__["tags"] = tags
931
+ __props__.__dict__["use_global_alert_settings"] = use_global_alert_settings
932
+ super(TcpMonitor, __self__).__init__(
933
+ 'checkly:index/tcpMonitor:TcpMonitor',
934
+ resource_name,
935
+ __props__,
936
+ opts)
937
+
938
+ @staticmethod
939
+ def get(resource_name: str,
940
+ id: pulumi.Input[str],
941
+ opts: Optional[pulumi.ResourceOptions] = None,
942
+ activated: Optional[pulumi.Input[bool]] = None,
943
+ alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TcpMonitorAlertChannelSubscriptionArgs', 'TcpMonitorAlertChannelSubscriptionArgsDict']]]]] = None,
944
+ alert_settings: Optional[pulumi.Input[Union['TcpMonitorAlertSettingsArgs', 'TcpMonitorAlertSettingsArgsDict']]] = None,
945
+ degraded_response_time: Optional[pulumi.Input[int]] = None,
946
+ frequency: Optional[pulumi.Input[int]] = None,
947
+ frequency_offset: Optional[pulumi.Input[int]] = None,
948
+ group_id: Optional[pulumi.Input[int]] = None,
949
+ group_order: Optional[pulumi.Input[int]] = None,
950
+ locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
951
+ max_response_time: Optional[pulumi.Input[int]] = None,
952
+ muted: Optional[pulumi.Input[bool]] = None,
953
+ name: Optional[pulumi.Input[str]] = None,
954
+ private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
955
+ request: Optional[pulumi.Input[Union['TcpMonitorRequestArgs', 'TcpMonitorRequestArgsDict']]] = None,
956
+ retry_strategy: Optional[pulumi.Input[Union['TcpMonitorRetryStrategyArgs', 'TcpMonitorRetryStrategyArgsDict']]] = None,
957
+ run_parallel: Optional[pulumi.Input[bool]] = None,
958
+ runtime_id: Optional[pulumi.Input[str]] = None,
959
+ should_fail: Optional[pulumi.Input[bool]] = None,
960
+ tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
961
+ use_global_alert_settings: Optional[pulumi.Input[bool]] = None) -> 'TcpMonitor':
962
+ """
963
+ Get an existing TcpMonitor resource's state with the given name, id, and optional extra
964
+ properties used to qualify the lookup.
965
+
966
+ :param str resource_name: The unique name of the resulting resource.
967
+ :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
968
+ :param pulumi.ResourceOptions opts: Options for the resource.
969
+ :param pulumi.Input[bool] activated: Determines if the check is running or not. Possible values `true`, and `false`.
970
+ :param pulumi.Input[Sequence[pulumi.Input[Union['TcpMonitorAlertChannelSubscriptionArgs', 'TcpMonitorAlertChannelSubscriptionArgsDict']]]] 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 check, we won't be able to alert you in case something goes wrong with it.
971
+ :param pulumi.Input[int] degraded_response_time: The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 5000. (Default `4000`).
972
+ :param pulumi.Input[int] frequency: The frequency in minutes to run the check. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
973
+ :param pulumi.Input[int] frequency_offset: To create a high frequency check, the property `frequency` must be `0` and `frequency_offset` can be `10`, `20` or `30`.
974
+ :param pulumi.Input[int] group_id: The id of the check group this check is part of.
975
+ :param pulumi.Input[int] group_order: The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
976
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
977
+ :param pulumi.Input[int] max_response_time: The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 5000. (Default `5000`).
978
+ :param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check fails/degrades/recovers.
979
+ :param pulumi.Input[str] name: The name of the check.
980
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
981
+ :param pulumi.Input[Union['TcpMonitorRequestArgs', 'TcpMonitorRequestArgsDict']] request: The parameters for the TCP connection.
982
+ :param pulumi.Input[Union['TcpMonitorRetryStrategyArgs', 'TcpMonitorRetryStrategyArgsDict']] retry_strategy: A strategy for retrying failed check runs.
983
+ :param pulumi.Input[bool] run_parallel: Determines if the check should run in all selected locations in parallel or round-robin.
984
+ :param pulumi.Input[str] runtime_id: The ID of the runtime to use for this check.
985
+ :param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when a check is considered to fail.
986
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks.
987
+ :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 check.
988
+ """
989
+ opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
990
+
991
+ __props__ = _TcpMonitorState.__new__(_TcpMonitorState)
992
+
993
+ __props__.__dict__["activated"] = activated
994
+ __props__.__dict__["alert_channel_subscriptions"] = alert_channel_subscriptions
995
+ __props__.__dict__["alert_settings"] = alert_settings
996
+ __props__.__dict__["degraded_response_time"] = degraded_response_time
997
+ __props__.__dict__["frequency"] = frequency
998
+ __props__.__dict__["frequency_offset"] = frequency_offset
999
+ __props__.__dict__["group_id"] = group_id
1000
+ __props__.__dict__["group_order"] = group_order
1001
+ __props__.__dict__["locations"] = locations
1002
+ __props__.__dict__["max_response_time"] = max_response_time
1003
+ __props__.__dict__["muted"] = muted
1004
+ __props__.__dict__["name"] = name
1005
+ __props__.__dict__["private_locations"] = private_locations
1006
+ __props__.__dict__["request"] = request
1007
+ __props__.__dict__["retry_strategy"] = retry_strategy
1008
+ __props__.__dict__["run_parallel"] = run_parallel
1009
+ __props__.__dict__["runtime_id"] = runtime_id
1010
+ __props__.__dict__["should_fail"] = should_fail
1011
+ __props__.__dict__["tags"] = tags
1012
+ __props__.__dict__["use_global_alert_settings"] = use_global_alert_settings
1013
+ return TcpMonitor(resource_name, opts=opts, __props__=__props__)
1014
+
1015
+ @property
1016
+ @pulumi.getter
1017
+ def activated(self) -> pulumi.Output[bool]:
1018
+ """
1019
+ Determines if the check is running or not. Possible values `true`, and `false`.
1020
+ """
1021
+ return pulumi.get(self, "activated")
1022
+
1023
+ @property
1024
+ @pulumi.getter(name="alertChannelSubscriptions")
1025
+ def alert_channel_subscriptions(self) -> pulumi.Output[Optional[Sequence['outputs.TcpMonitorAlertChannelSubscription']]]:
1026
+ """
1027
+ An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
1028
+ """
1029
+ return pulumi.get(self, "alert_channel_subscriptions")
1030
+
1031
+ @property
1032
+ @pulumi.getter(name="alertSettings")
1033
+ def alert_settings(self) -> pulumi.Output['outputs.TcpMonitorAlertSettings']:
1034
+ return pulumi.get(self, "alert_settings")
1035
+
1036
+ @property
1037
+ @pulumi.getter(name="degradedResponseTime")
1038
+ def degraded_response_time(self) -> pulumi.Output[Optional[int]]:
1039
+ """
1040
+ The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 5000. (Default `4000`).
1041
+ """
1042
+ return pulumi.get(self, "degraded_response_time")
1043
+
1044
+ @property
1045
+ @pulumi.getter
1046
+ def frequency(self) -> pulumi.Output[int]:
1047
+ """
1048
+ The frequency in minutes to run the check. Possible values are `0`, `1`, `2`, `5`, `10`, `15`, `30`, `60`, `120`, `180`, `360`, `720`, and `1440`.
1049
+ """
1050
+ return pulumi.get(self, "frequency")
1051
+
1052
+ @property
1053
+ @pulumi.getter(name="frequencyOffset")
1054
+ def frequency_offset(self) -> pulumi.Output[Optional[int]]:
1055
+ """
1056
+ To create a high frequency check, the property `frequency` must be `0` and `frequency_offset` can be `10`, `20` or `30`.
1057
+ """
1058
+ return pulumi.get(self, "frequency_offset")
1059
+
1060
+ @property
1061
+ @pulumi.getter(name="groupId")
1062
+ def group_id(self) -> pulumi.Output[Optional[int]]:
1063
+ """
1064
+ The id of the check group this check is part of.
1065
+ """
1066
+ return pulumi.get(self, "group_id")
1067
+
1068
+ @property
1069
+ @pulumi.getter(name="groupOrder")
1070
+ def group_order(self) -> pulumi.Output[Optional[int]]:
1071
+ """
1072
+ The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
1073
+ """
1074
+ return pulumi.get(self, "group_order")
1075
+
1076
+ @property
1077
+ @pulumi.getter
1078
+ def locations(self) -> pulumi.Output[Optional[Sequence[str]]]:
1079
+ """
1080
+ An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
1081
+ """
1082
+ return pulumi.get(self, "locations")
1083
+
1084
+ @property
1085
+ @pulumi.getter(name="maxResponseTime")
1086
+ def max_response_time(self) -> pulumi.Output[Optional[int]]:
1087
+ """
1088
+ The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 5000. (Default `5000`).
1089
+ """
1090
+ return pulumi.get(self, "max_response_time")
1091
+
1092
+ @property
1093
+ @pulumi.getter
1094
+ def muted(self) -> pulumi.Output[Optional[bool]]:
1095
+ """
1096
+ Determines if any notifications will be sent out when a check fails/degrades/recovers.
1097
+ """
1098
+ return pulumi.get(self, "muted")
1099
+
1100
+ @property
1101
+ @pulumi.getter
1102
+ def name(self) -> pulumi.Output[str]:
1103
+ """
1104
+ The name of the check.
1105
+ """
1106
+ return pulumi.get(self, "name")
1107
+
1108
+ @property
1109
+ @pulumi.getter(name="privateLocations")
1110
+ def private_locations(self) -> pulumi.Output[Optional[Sequence[str]]]:
1111
+ """
1112
+ An array of one or more private locations slugs.
1113
+ """
1114
+ return pulumi.get(self, "private_locations")
1115
+
1116
+ @property
1117
+ @pulumi.getter
1118
+ def request(self) -> pulumi.Output['outputs.TcpMonitorRequest']:
1119
+ """
1120
+ The parameters for the TCP connection.
1121
+ """
1122
+ return pulumi.get(self, "request")
1123
+
1124
+ @property
1125
+ @pulumi.getter(name="retryStrategy")
1126
+ def retry_strategy(self) -> pulumi.Output['outputs.TcpMonitorRetryStrategy']:
1127
+ """
1128
+ A strategy for retrying failed check runs.
1129
+ """
1130
+ return pulumi.get(self, "retry_strategy")
1131
+
1132
+ @property
1133
+ @pulumi.getter(name="runParallel")
1134
+ def run_parallel(self) -> pulumi.Output[Optional[bool]]:
1135
+ """
1136
+ Determines if the check should run in all selected locations in parallel or round-robin.
1137
+ """
1138
+ return pulumi.get(self, "run_parallel")
1139
+
1140
+ @property
1141
+ @pulumi.getter(name="runtimeId")
1142
+ def runtime_id(self) -> pulumi.Output[Optional[str]]:
1143
+ """
1144
+ The ID of the runtime to use for this check.
1145
+ """
1146
+ return pulumi.get(self, "runtime_id")
1147
+
1148
+ @property
1149
+ @pulumi.getter(name="shouldFail")
1150
+ def should_fail(self) -> pulumi.Output[Optional[bool]]:
1151
+ """
1152
+ Allows to invert the behaviour of when a check is considered to fail.
1153
+ """
1154
+ return pulumi.get(self, "should_fail")
1155
+
1156
+ @property
1157
+ @pulumi.getter
1158
+ def tags(self) -> pulumi.Output[Optional[Sequence[str]]]:
1159
+ """
1160
+ A list of tags for organizing and filtering checks.
1161
+ """
1162
+ return pulumi.get(self, "tags")
1163
+
1164
+ @property
1165
+ @pulumi.getter(name="useGlobalAlertSettings")
1166
+ def use_global_alert_settings(self) -> pulumi.Output[Optional[bool]]:
1167
+ """
1168
+ When true, the account level alert settings will be used, not the alert setting defined on this check.
1169
+ """
1170
+ return pulumi.get(self, "use_global_alert_settings")
1171
+