pulumi-checkly 2.0.0__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,1073 @@
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__ = ['CheckGroupArgs', 'CheckGroup']
20
+
21
+ @pulumi.input_type
22
+ class CheckGroupArgs:
23
+ def __init__(__self__, *,
24
+ activated: pulumi.Input[bool],
25
+ concurrency: pulumi.Input[int],
26
+ alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupAlertChannelSubscriptionArgs']]]] = None,
27
+ alert_settings: Optional[pulumi.Input['CheckGroupAlertSettingsArgs']] = None,
28
+ api_check_defaults: Optional[pulumi.Input['CheckGroupApiCheckDefaultsArgs']] = None,
29
+ double_check: Optional[pulumi.Input[bool]] = None,
30
+ environment_variable: Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupEnvironmentVariableArgs']]]] = None,
31
+ environment_variables: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
32
+ local_setup_script: Optional[pulumi.Input[str]] = None,
33
+ local_teardown_script: Optional[pulumi.Input[str]] = None,
34
+ locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = 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['CheckGroupRetryStrategyArgs']] = None,
39
+ run_parallel: Optional[pulumi.Input[bool]] = None,
40
+ runtime_id: Optional[pulumi.Input[str]] = None,
41
+ setup_snippet_id: Optional[pulumi.Input[int]] = None,
42
+ tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
43
+ teardown_snippet_id: Optional[pulumi.Input[int]] = None,
44
+ use_global_alert_settings: Optional[pulumi.Input[bool]] = None):
45
+ """
46
+ The set of arguments for constructing a CheckGroup resource.
47
+ :param pulumi.Input[bool] activated: Determines if the checks in the group are running or not.
48
+ :param pulumi.Input[int] concurrency: Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
49
+ :param pulumi.Input[bool] double_check: Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.
50
+ :param pulumi.Input[Sequence[pulumi.Input['CheckGroupEnvironmentVariableArgs']]] environment_variable: Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
51
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] environment_variables: Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.
52
+ :param pulumi.Input[str] local_setup_script: A valid piece of Node.js code to run in the setup phase of an API check in this group.
53
+ :param pulumi.Input[str] local_teardown_script: A valid piece of Node.js code to run in the teardown phase of an API check in this group.
54
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the checks.
55
+ :param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check in this group fails and/or recovers.
56
+ :param pulumi.Input[str] name: The name of the check group.
57
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
58
+ :param pulumi.Input['CheckGroupRetryStrategyArgs'] retry_strategy: A strategy for retrying failed check runs.
59
+ :param pulumi.Input[bool] run_parallel: Determines if the checks in the group should run in all selected locations in parallel or round-robin.
60
+ :param pulumi.Input[str] runtime_id: The id of the runtime to use for this group.
61
+ :param pulumi.Input[int] setup_snippet_id: An ID reference to a snippet to use in the setup phase of an API check.
62
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: Tags for organizing and filtering checks.
63
+ :param pulumi.Input[int] teardown_snippet_id: An ID reference to a snippet to use in the teardown phase of an API check.
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 group.
65
+ """
66
+ pulumi.set(__self__, "activated", activated)
67
+ pulumi.set(__self__, "concurrency", concurrency)
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 api_check_defaults is not None:
73
+ pulumi.set(__self__, "api_check_defaults", api_check_defaults)
74
+ if double_check is not None:
75
+ warnings.warn("""The property `double_check` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retry_strategy` property instead.""", DeprecationWarning)
76
+ pulumi.log.warn("""double_check is deprecated: The property `double_check` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retry_strategy` property instead.""")
77
+ if double_check is not None:
78
+ pulumi.set(__self__, "double_check", double_check)
79
+ if environment_variable is not None:
80
+ pulumi.set(__self__, "environment_variable", environment_variable)
81
+ if environment_variables is not None:
82
+ warnings.warn("""The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""", DeprecationWarning)
83
+ pulumi.log.warn("""environment_variables is deprecated: The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""")
84
+ if environment_variables is not None:
85
+ pulumi.set(__self__, "environment_variables", environment_variables)
86
+ if local_setup_script is not None:
87
+ pulumi.set(__self__, "local_setup_script", local_setup_script)
88
+ if local_teardown_script is not None:
89
+ pulumi.set(__self__, "local_teardown_script", local_teardown_script)
90
+ if locations is not None:
91
+ pulumi.set(__self__, "locations", locations)
92
+ if muted is not None:
93
+ pulumi.set(__self__, "muted", muted)
94
+ if name is not None:
95
+ pulumi.set(__self__, "name", name)
96
+ if private_locations is not None:
97
+ pulumi.set(__self__, "private_locations", private_locations)
98
+ if retry_strategy is not None:
99
+ pulumi.set(__self__, "retry_strategy", retry_strategy)
100
+ if run_parallel is not None:
101
+ pulumi.set(__self__, "run_parallel", run_parallel)
102
+ if runtime_id is not None:
103
+ pulumi.set(__self__, "runtime_id", runtime_id)
104
+ if setup_snippet_id is not None:
105
+ pulumi.set(__self__, "setup_snippet_id", setup_snippet_id)
106
+ if tags is not None:
107
+ pulumi.set(__self__, "tags", tags)
108
+ if teardown_snippet_id is not None:
109
+ pulumi.set(__self__, "teardown_snippet_id", teardown_snippet_id)
110
+ if use_global_alert_settings is not None:
111
+ pulumi.set(__self__, "use_global_alert_settings", use_global_alert_settings)
112
+
113
+ @property
114
+ @pulumi.getter
115
+ def activated(self) -> pulumi.Input[bool]:
116
+ """
117
+ Determines if the checks in the group are running or not.
118
+ """
119
+ return pulumi.get(self, "activated")
120
+
121
+ @activated.setter
122
+ def activated(self, value: pulumi.Input[bool]):
123
+ pulumi.set(self, "activated", value)
124
+
125
+ @property
126
+ @pulumi.getter
127
+ def concurrency(self) -> pulumi.Input[int]:
128
+ """
129
+ Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
130
+ """
131
+ return pulumi.get(self, "concurrency")
132
+
133
+ @concurrency.setter
134
+ def concurrency(self, value: pulumi.Input[int]):
135
+ pulumi.set(self, "concurrency", value)
136
+
137
+ @property
138
+ @pulumi.getter(name="alertChannelSubscriptions")
139
+ def alert_channel_subscriptions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupAlertChannelSubscriptionArgs']]]]:
140
+ return pulumi.get(self, "alert_channel_subscriptions")
141
+
142
+ @alert_channel_subscriptions.setter
143
+ def alert_channel_subscriptions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupAlertChannelSubscriptionArgs']]]]):
144
+ pulumi.set(self, "alert_channel_subscriptions", value)
145
+
146
+ @property
147
+ @pulumi.getter(name="alertSettings")
148
+ def alert_settings(self) -> Optional[pulumi.Input['CheckGroupAlertSettingsArgs']]:
149
+ return pulumi.get(self, "alert_settings")
150
+
151
+ @alert_settings.setter
152
+ def alert_settings(self, value: Optional[pulumi.Input['CheckGroupAlertSettingsArgs']]):
153
+ pulumi.set(self, "alert_settings", value)
154
+
155
+ @property
156
+ @pulumi.getter(name="apiCheckDefaults")
157
+ def api_check_defaults(self) -> Optional[pulumi.Input['CheckGroupApiCheckDefaultsArgs']]:
158
+ return pulumi.get(self, "api_check_defaults")
159
+
160
+ @api_check_defaults.setter
161
+ def api_check_defaults(self, value: Optional[pulumi.Input['CheckGroupApiCheckDefaultsArgs']]):
162
+ pulumi.set(self, "api_check_defaults", value)
163
+
164
+ @property
165
+ @pulumi.getter(name="doubleCheck")
166
+ @_utilities.deprecated("""The property `double_check` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retry_strategy` property instead.""")
167
+ def double_check(self) -> Optional[pulumi.Input[bool]]:
168
+ """
169
+ Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.
170
+ """
171
+ return pulumi.get(self, "double_check")
172
+
173
+ @double_check.setter
174
+ def double_check(self, value: Optional[pulumi.Input[bool]]):
175
+ pulumi.set(self, "double_check", value)
176
+
177
+ @property
178
+ @pulumi.getter(name="environmentVariable")
179
+ def environment_variable(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupEnvironmentVariableArgs']]]]:
180
+ """
181
+ Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
182
+ """
183
+ return pulumi.get(self, "environment_variable")
184
+
185
+ @environment_variable.setter
186
+ def environment_variable(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupEnvironmentVariableArgs']]]]):
187
+ pulumi.set(self, "environment_variable", value)
188
+
189
+ @property
190
+ @pulumi.getter(name="environmentVariables")
191
+ @_utilities.deprecated("""The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""")
192
+ def environment_variables(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
193
+ """
194
+ Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.
195
+ """
196
+ return pulumi.get(self, "environment_variables")
197
+
198
+ @environment_variables.setter
199
+ def environment_variables(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
200
+ pulumi.set(self, "environment_variables", value)
201
+
202
+ @property
203
+ @pulumi.getter(name="localSetupScript")
204
+ def local_setup_script(self) -> Optional[pulumi.Input[str]]:
205
+ """
206
+ A valid piece of Node.js code to run in the setup phase of an API check in this group.
207
+ """
208
+ return pulumi.get(self, "local_setup_script")
209
+
210
+ @local_setup_script.setter
211
+ def local_setup_script(self, value: Optional[pulumi.Input[str]]):
212
+ pulumi.set(self, "local_setup_script", value)
213
+
214
+ @property
215
+ @pulumi.getter(name="localTeardownScript")
216
+ def local_teardown_script(self) -> Optional[pulumi.Input[str]]:
217
+ """
218
+ A valid piece of Node.js code to run in the teardown phase of an API check in this group.
219
+ """
220
+ return pulumi.get(self, "local_teardown_script")
221
+
222
+ @local_teardown_script.setter
223
+ def local_teardown_script(self, value: Optional[pulumi.Input[str]]):
224
+ pulumi.set(self, "local_teardown_script", value)
225
+
226
+ @property
227
+ @pulumi.getter
228
+ def locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
229
+ """
230
+ An array of one or more data center locations where to run the checks.
231
+ """
232
+ return pulumi.get(self, "locations")
233
+
234
+ @locations.setter
235
+ def locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
236
+ pulumi.set(self, "locations", value)
237
+
238
+ @property
239
+ @pulumi.getter
240
+ def muted(self) -> Optional[pulumi.Input[bool]]:
241
+ """
242
+ Determines if any notifications will be sent out when a check in this group fails and/or recovers.
243
+ """
244
+ return pulumi.get(self, "muted")
245
+
246
+ @muted.setter
247
+ def muted(self, value: Optional[pulumi.Input[bool]]):
248
+ pulumi.set(self, "muted", value)
249
+
250
+ @property
251
+ @pulumi.getter
252
+ def name(self) -> Optional[pulumi.Input[str]]:
253
+ """
254
+ The name of the check group.
255
+ """
256
+ return pulumi.get(self, "name")
257
+
258
+ @name.setter
259
+ def name(self, value: Optional[pulumi.Input[str]]):
260
+ pulumi.set(self, "name", value)
261
+
262
+ @property
263
+ @pulumi.getter(name="privateLocations")
264
+ def private_locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
265
+ """
266
+ An array of one or more private locations slugs.
267
+ """
268
+ return pulumi.get(self, "private_locations")
269
+
270
+ @private_locations.setter
271
+ def private_locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
272
+ pulumi.set(self, "private_locations", value)
273
+
274
+ @property
275
+ @pulumi.getter(name="retryStrategy")
276
+ def retry_strategy(self) -> Optional[pulumi.Input['CheckGroupRetryStrategyArgs']]:
277
+ """
278
+ A strategy for retrying failed check runs.
279
+ """
280
+ return pulumi.get(self, "retry_strategy")
281
+
282
+ @retry_strategy.setter
283
+ def retry_strategy(self, value: Optional[pulumi.Input['CheckGroupRetryStrategyArgs']]):
284
+ pulumi.set(self, "retry_strategy", value)
285
+
286
+ @property
287
+ @pulumi.getter(name="runParallel")
288
+ def run_parallel(self) -> Optional[pulumi.Input[bool]]:
289
+ """
290
+ Determines if the checks in the group should run in all selected locations in parallel or round-robin.
291
+ """
292
+ return pulumi.get(self, "run_parallel")
293
+
294
+ @run_parallel.setter
295
+ def run_parallel(self, value: Optional[pulumi.Input[bool]]):
296
+ pulumi.set(self, "run_parallel", value)
297
+
298
+ @property
299
+ @pulumi.getter(name="runtimeId")
300
+ def runtime_id(self) -> Optional[pulumi.Input[str]]:
301
+ """
302
+ The id of the runtime to use for this group.
303
+ """
304
+ return pulumi.get(self, "runtime_id")
305
+
306
+ @runtime_id.setter
307
+ def runtime_id(self, value: Optional[pulumi.Input[str]]):
308
+ pulumi.set(self, "runtime_id", value)
309
+
310
+ @property
311
+ @pulumi.getter(name="setupSnippetId")
312
+ def setup_snippet_id(self) -> Optional[pulumi.Input[int]]:
313
+ """
314
+ An ID reference to a snippet to use in the setup phase of an API check.
315
+ """
316
+ return pulumi.get(self, "setup_snippet_id")
317
+
318
+ @setup_snippet_id.setter
319
+ def setup_snippet_id(self, value: Optional[pulumi.Input[int]]):
320
+ pulumi.set(self, "setup_snippet_id", value)
321
+
322
+ @property
323
+ @pulumi.getter
324
+ def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
325
+ """
326
+ Tags for organizing and filtering checks.
327
+ """
328
+ return pulumi.get(self, "tags")
329
+
330
+ @tags.setter
331
+ def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
332
+ pulumi.set(self, "tags", value)
333
+
334
+ @property
335
+ @pulumi.getter(name="teardownSnippetId")
336
+ def teardown_snippet_id(self) -> Optional[pulumi.Input[int]]:
337
+ """
338
+ An ID reference to a snippet to use in the teardown phase of an API check.
339
+ """
340
+ return pulumi.get(self, "teardown_snippet_id")
341
+
342
+ @teardown_snippet_id.setter
343
+ def teardown_snippet_id(self, value: Optional[pulumi.Input[int]]):
344
+ pulumi.set(self, "teardown_snippet_id", value)
345
+
346
+ @property
347
+ @pulumi.getter(name="useGlobalAlertSettings")
348
+ def use_global_alert_settings(self) -> Optional[pulumi.Input[bool]]:
349
+ """
350
+ When true, the account level alert settings will be used, not the alert setting defined on this check group.
351
+ """
352
+ return pulumi.get(self, "use_global_alert_settings")
353
+
354
+ @use_global_alert_settings.setter
355
+ def use_global_alert_settings(self, value: Optional[pulumi.Input[bool]]):
356
+ pulumi.set(self, "use_global_alert_settings", value)
357
+
358
+
359
+ @pulumi.input_type
360
+ class _CheckGroupState:
361
+ def __init__(__self__, *,
362
+ activated: Optional[pulumi.Input[bool]] = None,
363
+ alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupAlertChannelSubscriptionArgs']]]] = None,
364
+ alert_settings: Optional[pulumi.Input['CheckGroupAlertSettingsArgs']] = None,
365
+ api_check_defaults: Optional[pulumi.Input['CheckGroupApiCheckDefaultsArgs']] = None,
366
+ concurrency: Optional[pulumi.Input[int]] = None,
367
+ double_check: Optional[pulumi.Input[bool]] = None,
368
+ environment_variable: Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupEnvironmentVariableArgs']]]] = None,
369
+ environment_variables: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
370
+ local_setup_script: Optional[pulumi.Input[str]] = None,
371
+ local_teardown_script: Optional[pulumi.Input[str]] = None,
372
+ locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
373
+ muted: Optional[pulumi.Input[bool]] = None,
374
+ name: Optional[pulumi.Input[str]] = None,
375
+ private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
376
+ retry_strategy: Optional[pulumi.Input['CheckGroupRetryStrategyArgs']] = None,
377
+ run_parallel: Optional[pulumi.Input[bool]] = None,
378
+ runtime_id: Optional[pulumi.Input[str]] = None,
379
+ setup_snippet_id: Optional[pulumi.Input[int]] = None,
380
+ tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
381
+ teardown_snippet_id: Optional[pulumi.Input[int]] = None,
382
+ use_global_alert_settings: Optional[pulumi.Input[bool]] = None):
383
+ """
384
+ Input properties used for looking up and filtering CheckGroup resources.
385
+ :param pulumi.Input[bool] activated: Determines if the checks in the group are running or not.
386
+ :param pulumi.Input[int] concurrency: Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
387
+ :param pulumi.Input[bool] double_check: Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.
388
+ :param pulumi.Input[Sequence[pulumi.Input['CheckGroupEnvironmentVariableArgs']]] environment_variable: Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
389
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] environment_variables: Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.
390
+ :param pulumi.Input[str] local_setup_script: A valid piece of Node.js code to run in the setup phase of an API check in this group.
391
+ :param pulumi.Input[str] local_teardown_script: A valid piece of Node.js code to run in the teardown phase of an API check in this group.
392
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the checks.
393
+ :param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check in this group fails and/or recovers.
394
+ :param pulumi.Input[str] name: The name of the check group.
395
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
396
+ :param pulumi.Input['CheckGroupRetryStrategyArgs'] retry_strategy: A strategy for retrying failed check runs.
397
+ :param pulumi.Input[bool] run_parallel: Determines if the checks in the group should run in all selected locations in parallel or round-robin.
398
+ :param pulumi.Input[str] runtime_id: The id of the runtime to use for this group.
399
+ :param pulumi.Input[int] setup_snippet_id: An ID reference to a snippet to use in the setup phase of an API check.
400
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: Tags for organizing and filtering checks.
401
+ :param pulumi.Input[int] teardown_snippet_id: An ID reference to a snippet to use in the teardown phase of an API check.
402
+ :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 group.
403
+ """
404
+ if activated is not None:
405
+ pulumi.set(__self__, "activated", activated)
406
+ if alert_channel_subscriptions is not None:
407
+ pulumi.set(__self__, "alert_channel_subscriptions", alert_channel_subscriptions)
408
+ if alert_settings is not None:
409
+ pulumi.set(__self__, "alert_settings", alert_settings)
410
+ if api_check_defaults is not None:
411
+ pulumi.set(__self__, "api_check_defaults", api_check_defaults)
412
+ if concurrency is not None:
413
+ pulumi.set(__self__, "concurrency", concurrency)
414
+ if double_check is not None:
415
+ warnings.warn("""The property `double_check` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retry_strategy` property instead.""", DeprecationWarning)
416
+ pulumi.log.warn("""double_check is deprecated: The property `double_check` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retry_strategy` property instead.""")
417
+ if double_check is not None:
418
+ pulumi.set(__self__, "double_check", double_check)
419
+ if environment_variable is not None:
420
+ pulumi.set(__self__, "environment_variable", environment_variable)
421
+ if environment_variables is not None:
422
+ warnings.warn("""The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""", DeprecationWarning)
423
+ pulumi.log.warn("""environment_variables is deprecated: The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""")
424
+ if environment_variables is not None:
425
+ pulumi.set(__self__, "environment_variables", environment_variables)
426
+ if local_setup_script is not None:
427
+ pulumi.set(__self__, "local_setup_script", local_setup_script)
428
+ if local_teardown_script is not None:
429
+ pulumi.set(__self__, "local_teardown_script", local_teardown_script)
430
+ if locations is not None:
431
+ pulumi.set(__self__, "locations", locations)
432
+ if muted is not None:
433
+ pulumi.set(__self__, "muted", muted)
434
+ if name is not None:
435
+ pulumi.set(__self__, "name", name)
436
+ if private_locations is not None:
437
+ pulumi.set(__self__, "private_locations", private_locations)
438
+ if retry_strategy is not None:
439
+ pulumi.set(__self__, "retry_strategy", retry_strategy)
440
+ if run_parallel is not None:
441
+ pulumi.set(__self__, "run_parallel", run_parallel)
442
+ if runtime_id is not None:
443
+ pulumi.set(__self__, "runtime_id", runtime_id)
444
+ if setup_snippet_id is not None:
445
+ pulumi.set(__self__, "setup_snippet_id", setup_snippet_id)
446
+ if tags is not None:
447
+ pulumi.set(__self__, "tags", tags)
448
+ if teardown_snippet_id is not None:
449
+ pulumi.set(__self__, "teardown_snippet_id", teardown_snippet_id)
450
+ if use_global_alert_settings is not None:
451
+ pulumi.set(__self__, "use_global_alert_settings", use_global_alert_settings)
452
+
453
+ @property
454
+ @pulumi.getter
455
+ def activated(self) -> Optional[pulumi.Input[bool]]:
456
+ """
457
+ Determines if the checks in the group are running or not.
458
+ """
459
+ return pulumi.get(self, "activated")
460
+
461
+ @activated.setter
462
+ def activated(self, value: Optional[pulumi.Input[bool]]):
463
+ pulumi.set(self, "activated", value)
464
+
465
+ @property
466
+ @pulumi.getter(name="alertChannelSubscriptions")
467
+ def alert_channel_subscriptions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupAlertChannelSubscriptionArgs']]]]:
468
+ return pulumi.get(self, "alert_channel_subscriptions")
469
+
470
+ @alert_channel_subscriptions.setter
471
+ def alert_channel_subscriptions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupAlertChannelSubscriptionArgs']]]]):
472
+ pulumi.set(self, "alert_channel_subscriptions", value)
473
+
474
+ @property
475
+ @pulumi.getter(name="alertSettings")
476
+ def alert_settings(self) -> Optional[pulumi.Input['CheckGroupAlertSettingsArgs']]:
477
+ return pulumi.get(self, "alert_settings")
478
+
479
+ @alert_settings.setter
480
+ def alert_settings(self, value: Optional[pulumi.Input['CheckGroupAlertSettingsArgs']]):
481
+ pulumi.set(self, "alert_settings", value)
482
+
483
+ @property
484
+ @pulumi.getter(name="apiCheckDefaults")
485
+ def api_check_defaults(self) -> Optional[pulumi.Input['CheckGroupApiCheckDefaultsArgs']]:
486
+ return pulumi.get(self, "api_check_defaults")
487
+
488
+ @api_check_defaults.setter
489
+ def api_check_defaults(self, value: Optional[pulumi.Input['CheckGroupApiCheckDefaultsArgs']]):
490
+ pulumi.set(self, "api_check_defaults", value)
491
+
492
+ @property
493
+ @pulumi.getter
494
+ def concurrency(self) -> Optional[pulumi.Input[int]]:
495
+ """
496
+ Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
497
+ """
498
+ return pulumi.get(self, "concurrency")
499
+
500
+ @concurrency.setter
501
+ def concurrency(self, value: Optional[pulumi.Input[int]]):
502
+ pulumi.set(self, "concurrency", value)
503
+
504
+ @property
505
+ @pulumi.getter(name="doubleCheck")
506
+ @_utilities.deprecated("""The property `double_check` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retry_strategy` property instead.""")
507
+ def double_check(self) -> Optional[pulumi.Input[bool]]:
508
+ """
509
+ Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.
510
+ """
511
+ return pulumi.get(self, "double_check")
512
+
513
+ @double_check.setter
514
+ def double_check(self, value: Optional[pulumi.Input[bool]]):
515
+ pulumi.set(self, "double_check", value)
516
+
517
+ @property
518
+ @pulumi.getter(name="environmentVariable")
519
+ def environment_variable(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupEnvironmentVariableArgs']]]]:
520
+ """
521
+ Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
522
+ """
523
+ return pulumi.get(self, "environment_variable")
524
+
525
+ @environment_variable.setter
526
+ def environment_variable(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CheckGroupEnvironmentVariableArgs']]]]):
527
+ pulumi.set(self, "environment_variable", value)
528
+
529
+ @property
530
+ @pulumi.getter(name="environmentVariables")
531
+ @_utilities.deprecated("""The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""")
532
+ def environment_variables(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
533
+ """
534
+ Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.
535
+ """
536
+ return pulumi.get(self, "environment_variables")
537
+
538
+ @environment_variables.setter
539
+ def environment_variables(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
540
+ pulumi.set(self, "environment_variables", value)
541
+
542
+ @property
543
+ @pulumi.getter(name="localSetupScript")
544
+ def local_setup_script(self) -> Optional[pulumi.Input[str]]:
545
+ """
546
+ A valid piece of Node.js code to run in the setup phase of an API check in this group.
547
+ """
548
+ return pulumi.get(self, "local_setup_script")
549
+
550
+ @local_setup_script.setter
551
+ def local_setup_script(self, value: Optional[pulumi.Input[str]]):
552
+ pulumi.set(self, "local_setup_script", value)
553
+
554
+ @property
555
+ @pulumi.getter(name="localTeardownScript")
556
+ def local_teardown_script(self) -> Optional[pulumi.Input[str]]:
557
+ """
558
+ A valid piece of Node.js code to run in the teardown phase of an API check in this group.
559
+ """
560
+ return pulumi.get(self, "local_teardown_script")
561
+
562
+ @local_teardown_script.setter
563
+ def local_teardown_script(self, value: Optional[pulumi.Input[str]]):
564
+ pulumi.set(self, "local_teardown_script", value)
565
+
566
+ @property
567
+ @pulumi.getter
568
+ def locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
569
+ """
570
+ An array of one or more data center locations where to run the checks.
571
+ """
572
+ return pulumi.get(self, "locations")
573
+
574
+ @locations.setter
575
+ def locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
576
+ pulumi.set(self, "locations", value)
577
+
578
+ @property
579
+ @pulumi.getter
580
+ def muted(self) -> Optional[pulumi.Input[bool]]:
581
+ """
582
+ Determines if any notifications will be sent out when a check in this group fails and/or recovers.
583
+ """
584
+ return pulumi.get(self, "muted")
585
+
586
+ @muted.setter
587
+ def muted(self, value: Optional[pulumi.Input[bool]]):
588
+ pulumi.set(self, "muted", value)
589
+
590
+ @property
591
+ @pulumi.getter
592
+ def name(self) -> Optional[pulumi.Input[str]]:
593
+ """
594
+ The name of the check group.
595
+ """
596
+ return pulumi.get(self, "name")
597
+
598
+ @name.setter
599
+ def name(self, value: Optional[pulumi.Input[str]]):
600
+ pulumi.set(self, "name", value)
601
+
602
+ @property
603
+ @pulumi.getter(name="privateLocations")
604
+ def private_locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
605
+ """
606
+ An array of one or more private locations slugs.
607
+ """
608
+ return pulumi.get(self, "private_locations")
609
+
610
+ @private_locations.setter
611
+ def private_locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
612
+ pulumi.set(self, "private_locations", value)
613
+
614
+ @property
615
+ @pulumi.getter(name="retryStrategy")
616
+ def retry_strategy(self) -> Optional[pulumi.Input['CheckGroupRetryStrategyArgs']]:
617
+ """
618
+ A strategy for retrying failed check runs.
619
+ """
620
+ return pulumi.get(self, "retry_strategy")
621
+
622
+ @retry_strategy.setter
623
+ def retry_strategy(self, value: Optional[pulumi.Input['CheckGroupRetryStrategyArgs']]):
624
+ pulumi.set(self, "retry_strategy", value)
625
+
626
+ @property
627
+ @pulumi.getter(name="runParallel")
628
+ def run_parallel(self) -> Optional[pulumi.Input[bool]]:
629
+ """
630
+ Determines if the checks in the group should run in all selected locations in parallel or round-robin.
631
+ """
632
+ return pulumi.get(self, "run_parallel")
633
+
634
+ @run_parallel.setter
635
+ def run_parallel(self, value: Optional[pulumi.Input[bool]]):
636
+ pulumi.set(self, "run_parallel", value)
637
+
638
+ @property
639
+ @pulumi.getter(name="runtimeId")
640
+ def runtime_id(self) -> Optional[pulumi.Input[str]]:
641
+ """
642
+ The id of the runtime to use for this group.
643
+ """
644
+ return pulumi.get(self, "runtime_id")
645
+
646
+ @runtime_id.setter
647
+ def runtime_id(self, value: Optional[pulumi.Input[str]]):
648
+ pulumi.set(self, "runtime_id", value)
649
+
650
+ @property
651
+ @pulumi.getter(name="setupSnippetId")
652
+ def setup_snippet_id(self) -> Optional[pulumi.Input[int]]:
653
+ """
654
+ An ID reference to a snippet to use in the setup phase of an API check.
655
+ """
656
+ return pulumi.get(self, "setup_snippet_id")
657
+
658
+ @setup_snippet_id.setter
659
+ def setup_snippet_id(self, value: Optional[pulumi.Input[int]]):
660
+ pulumi.set(self, "setup_snippet_id", value)
661
+
662
+ @property
663
+ @pulumi.getter
664
+ def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
665
+ """
666
+ Tags for organizing and filtering checks.
667
+ """
668
+ return pulumi.get(self, "tags")
669
+
670
+ @tags.setter
671
+ def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
672
+ pulumi.set(self, "tags", value)
673
+
674
+ @property
675
+ @pulumi.getter(name="teardownSnippetId")
676
+ def teardown_snippet_id(self) -> Optional[pulumi.Input[int]]:
677
+ """
678
+ An ID reference to a snippet to use in the teardown phase of an API check.
679
+ """
680
+ return pulumi.get(self, "teardown_snippet_id")
681
+
682
+ @teardown_snippet_id.setter
683
+ def teardown_snippet_id(self, value: Optional[pulumi.Input[int]]):
684
+ pulumi.set(self, "teardown_snippet_id", value)
685
+
686
+ @property
687
+ @pulumi.getter(name="useGlobalAlertSettings")
688
+ def use_global_alert_settings(self) -> Optional[pulumi.Input[bool]]:
689
+ """
690
+ When true, the account level alert settings will be used, not the alert setting defined on this check group.
691
+ """
692
+ return pulumi.get(self, "use_global_alert_settings")
693
+
694
+ @use_global_alert_settings.setter
695
+ def use_global_alert_settings(self, value: Optional[pulumi.Input[bool]]):
696
+ pulumi.set(self, "use_global_alert_settings", value)
697
+
698
+
699
+ class CheckGroup(pulumi.CustomResource):
700
+ @overload
701
+ def __init__(__self__,
702
+ resource_name: str,
703
+ opts: Optional[pulumi.ResourceOptions] = None,
704
+ activated: Optional[pulumi.Input[bool]] = None,
705
+ alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckGroupAlertChannelSubscriptionArgs', 'CheckGroupAlertChannelSubscriptionArgsDict']]]]] = None,
706
+ alert_settings: Optional[pulumi.Input[Union['CheckGroupAlertSettingsArgs', 'CheckGroupAlertSettingsArgsDict']]] = None,
707
+ api_check_defaults: Optional[pulumi.Input[Union['CheckGroupApiCheckDefaultsArgs', 'CheckGroupApiCheckDefaultsArgsDict']]] = None,
708
+ concurrency: Optional[pulumi.Input[int]] = None,
709
+ double_check: Optional[pulumi.Input[bool]] = None,
710
+ environment_variable: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckGroupEnvironmentVariableArgs', 'CheckGroupEnvironmentVariableArgsDict']]]]] = None,
711
+ environment_variables: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
712
+ local_setup_script: Optional[pulumi.Input[str]] = None,
713
+ local_teardown_script: Optional[pulumi.Input[str]] = None,
714
+ locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
715
+ muted: Optional[pulumi.Input[bool]] = None,
716
+ name: Optional[pulumi.Input[str]] = None,
717
+ private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
718
+ retry_strategy: Optional[pulumi.Input[Union['CheckGroupRetryStrategyArgs', 'CheckGroupRetryStrategyArgsDict']]] = None,
719
+ run_parallel: Optional[pulumi.Input[bool]] = None,
720
+ runtime_id: Optional[pulumi.Input[str]] = None,
721
+ setup_snippet_id: Optional[pulumi.Input[int]] = None,
722
+ tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
723
+ teardown_snippet_id: Optional[pulumi.Input[int]] = None,
724
+ use_global_alert_settings: Optional[pulumi.Input[bool]] = None,
725
+ __props__=None):
726
+ """
727
+ Check groups allow you to group together a set of related checks, which can also share default settings for various attributes.
728
+
729
+ :param str resource_name: The name of the resource.
730
+ :param pulumi.ResourceOptions opts: Options for the resource.
731
+ :param pulumi.Input[bool] activated: Determines if the checks in the group are running or not.
732
+ :param pulumi.Input[int] concurrency: Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
733
+ :param pulumi.Input[bool] double_check: Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.
734
+ :param pulumi.Input[Sequence[pulumi.Input[Union['CheckGroupEnvironmentVariableArgs', 'CheckGroupEnvironmentVariableArgsDict']]]] environment_variable: Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
735
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] environment_variables: Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.
736
+ :param pulumi.Input[str] local_setup_script: A valid piece of Node.js code to run in the setup phase of an API check in this group.
737
+ :param pulumi.Input[str] local_teardown_script: A valid piece of Node.js code to run in the teardown phase of an API check in this group.
738
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the checks.
739
+ :param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check in this group fails and/or recovers.
740
+ :param pulumi.Input[str] name: The name of the check group.
741
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
742
+ :param pulumi.Input[Union['CheckGroupRetryStrategyArgs', 'CheckGroupRetryStrategyArgsDict']] retry_strategy: A strategy for retrying failed check runs.
743
+ :param pulumi.Input[bool] run_parallel: Determines if the checks in the group should run in all selected locations in parallel or round-robin.
744
+ :param pulumi.Input[str] runtime_id: The id of the runtime to use for this group.
745
+ :param pulumi.Input[int] setup_snippet_id: An ID reference to a snippet to use in the setup phase of an API check.
746
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: Tags for organizing and filtering checks.
747
+ :param pulumi.Input[int] teardown_snippet_id: An ID reference to a snippet to use in the teardown phase of an API check.
748
+ :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 group.
749
+ """
750
+ ...
751
+ @overload
752
+ def __init__(__self__,
753
+ resource_name: str,
754
+ args: CheckGroupArgs,
755
+ opts: Optional[pulumi.ResourceOptions] = None):
756
+ """
757
+ Check groups allow you to group together a set of related checks, which can also share default settings for various attributes.
758
+
759
+ :param str resource_name: The name of the resource.
760
+ :param CheckGroupArgs args: The arguments to use to populate this resource's properties.
761
+ :param pulumi.ResourceOptions opts: Options for the resource.
762
+ """
763
+ ...
764
+ def __init__(__self__, resource_name: str, *args, **kwargs):
765
+ resource_args, opts = _utilities.get_resource_args_opts(CheckGroupArgs, pulumi.ResourceOptions, *args, **kwargs)
766
+ if resource_args is not None:
767
+ __self__._internal_init(resource_name, opts, **resource_args.__dict__)
768
+ else:
769
+ __self__._internal_init(resource_name, *args, **kwargs)
770
+
771
+ def _internal_init(__self__,
772
+ resource_name: str,
773
+ opts: Optional[pulumi.ResourceOptions] = None,
774
+ activated: Optional[pulumi.Input[bool]] = None,
775
+ alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckGroupAlertChannelSubscriptionArgs', 'CheckGroupAlertChannelSubscriptionArgsDict']]]]] = None,
776
+ alert_settings: Optional[pulumi.Input[Union['CheckGroupAlertSettingsArgs', 'CheckGroupAlertSettingsArgsDict']]] = None,
777
+ api_check_defaults: Optional[pulumi.Input[Union['CheckGroupApiCheckDefaultsArgs', 'CheckGroupApiCheckDefaultsArgsDict']]] = None,
778
+ concurrency: Optional[pulumi.Input[int]] = None,
779
+ double_check: Optional[pulumi.Input[bool]] = None,
780
+ environment_variable: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckGroupEnvironmentVariableArgs', 'CheckGroupEnvironmentVariableArgsDict']]]]] = None,
781
+ environment_variables: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
782
+ local_setup_script: Optional[pulumi.Input[str]] = None,
783
+ local_teardown_script: Optional[pulumi.Input[str]] = None,
784
+ locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
785
+ muted: Optional[pulumi.Input[bool]] = None,
786
+ name: Optional[pulumi.Input[str]] = None,
787
+ private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
788
+ retry_strategy: Optional[pulumi.Input[Union['CheckGroupRetryStrategyArgs', 'CheckGroupRetryStrategyArgsDict']]] = None,
789
+ run_parallel: Optional[pulumi.Input[bool]] = None,
790
+ runtime_id: Optional[pulumi.Input[str]] = None,
791
+ setup_snippet_id: Optional[pulumi.Input[int]] = None,
792
+ tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
793
+ teardown_snippet_id: Optional[pulumi.Input[int]] = None,
794
+ use_global_alert_settings: Optional[pulumi.Input[bool]] = None,
795
+ __props__=None):
796
+ opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
797
+ if not isinstance(opts, pulumi.ResourceOptions):
798
+ raise TypeError('Expected resource options to be a ResourceOptions instance')
799
+ if opts.id is None:
800
+ if __props__ is not None:
801
+ raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
802
+ __props__ = CheckGroupArgs.__new__(CheckGroupArgs)
803
+
804
+ if activated is None and not opts.urn:
805
+ raise TypeError("Missing required property 'activated'")
806
+ __props__.__dict__["activated"] = activated
807
+ __props__.__dict__["alert_channel_subscriptions"] = alert_channel_subscriptions
808
+ __props__.__dict__["alert_settings"] = alert_settings
809
+ __props__.__dict__["api_check_defaults"] = api_check_defaults
810
+ if concurrency is None and not opts.urn:
811
+ raise TypeError("Missing required property 'concurrency'")
812
+ __props__.__dict__["concurrency"] = concurrency
813
+ __props__.__dict__["double_check"] = double_check
814
+ __props__.__dict__["environment_variable"] = environment_variable
815
+ __props__.__dict__["environment_variables"] = environment_variables
816
+ __props__.__dict__["local_setup_script"] = local_setup_script
817
+ __props__.__dict__["local_teardown_script"] = local_teardown_script
818
+ __props__.__dict__["locations"] = locations
819
+ __props__.__dict__["muted"] = muted
820
+ __props__.__dict__["name"] = name
821
+ __props__.__dict__["private_locations"] = private_locations
822
+ __props__.__dict__["retry_strategy"] = retry_strategy
823
+ __props__.__dict__["run_parallel"] = run_parallel
824
+ __props__.__dict__["runtime_id"] = runtime_id
825
+ __props__.__dict__["setup_snippet_id"] = setup_snippet_id
826
+ __props__.__dict__["tags"] = tags
827
+ __props__.__dict__["teardown_snippet_id"] = teardown_snippet_id
828
+ __props__.__dict__["use_global_alert_settings"] = use_global_alert_settings
829
+ super(CheckGroup, __self__).__init__(
830
+ 'checkly:index/checkGroup:CheckGroup',
831
+ resource_name,
832
+ __props__,
833
+ opts)
834
+
835
+ @staticmethod
836
+ def get(resource_name: str,
837
+ id: pulumi.Input[str],
838
+ opts: Optional[pulumi.ResourceOptions] = None,
839
+ activated: Optional[pulumi.Input[bool]] = None,
840
+ alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckGroupAlertChannelSubscriptionArgs', 'CheckGroupAlertChannelSubscriptionArgsDict']]]]] = None,
841
+ alert_settings: Optional[pulumi.Input[Union['CheckGroupAlertSettingsArgs', 'CheckGroupAlertSettingsArgsDict']]] = None,
842
+ api_check_defaults: Optional[pulumi.Input[Union['CheckGroupApiCheckDefaultsArgs', 'CheckGroupApiCheckDefaultsArgsDict']]] = None,
843
+ concurrency: Optional[pulumi.Input[int]] = None,
844
+ double_check: Optional[pulumi.Input[bool]] = None,
845
+ environment_variable: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckGroupEnvironmentVariableArgs', 'CheckGroupEnvironmentVariableArgsDict']]]]] = None,
846
+ environment_variables: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
847
+ local_setup_script: Optional[pulumi.Input[str]] = None,
848
+ local_teardown_script: Optional[pulumi.Input[str]] = None,
849
+ locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
850
+ muted: Optional[pulumi.Input[bool]] = None,
851
+ name: Optional[pulumi.Input[str]] = None,
852
+ private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
853
+ retry_strategy: Optional[pulumi.Input[Union['CheckGroupRetryStrategyArgs', 'CheckGroupRetryStrategyArgsDict']]] = None,
854
+ run_parallel: Optional[pulumi.Input[bool]] = None,
855
+ runtime_id: Optional[pulumi.Input[str]] = None,
856
+ setup_snippet_id: Optional[pulumi.Input[int]] = None,
857
+ tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
858
+ teardown_snippet_id: Optional[pulumi.Input[int]] = None,
859
+ use_global_alert_settings: Optional[pulumi.Input[bool]] = None) -> 'CheckGroup':
860
+ """
861
+ Get an existing CheckGroup resource's state with the given name, id, and optional extra
862
+ properties used to qualify the lookup.
863
+
864
+ :param str resource_name: The unique name of the resulting resource.
865
+ :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
866
+ :param pulumi.ResourceOptions opts: Options for the resource.
867
+ :param pulumi.Input[bool] activated: Determines if the checks in the group are running or not.
868
+ :param pulumi.Input[int] concurrency: Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
869
+ :param pulumi.Input[bool] double_check: Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.
870
+ :param pulumi.Input[Sequence[pulumi.Input[Union['CheckGroupEnvironmentVariableArgs', 'CheckGroupEnvironmentVariableArgsDict']]]] environment_variable: Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
871
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] environment_variables: Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.
872
+ :param pulumi.Input[str] local_setup_script: A valid piece of Node.js code to run in the setup phase of an API check in this group.
873
+ :param pulumi.Input[str] local_teardown_script: A valid piece of Node.js code to run in the teardown phase of an API check in this group.
874
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] locations: An array of one or more data center locations where to run the checks.
875
+ :param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check in this group fails and/or recovers.
876
+ :param pulumi.Input[str] name: The name of the check group.
877
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
878
+ :param pulumi.Input[Union['CheckGroupRetryStrategyArgs', 'CheckGroupRetryStrategyArgsDict']] retry_strategy: A strategy for retrying failed check runs.
879
+ :param pulumi.Input[bool] run_parallel: Determines if the checks in the group should run in all selected locations in parallel or round-robin.
880
+ :param pulumi.Input[str] runtime_id: The id of the runtime to use for this group.
881
+ :param pulumi.Input[int] setup_snippet_id: An ID reference to a snippet to use in the setup phase of an API check.
882
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: Tags for organizing and filtering checks.
883
+ :param pulumi.Input[int] teardown_snippet_id: An ID reference to a snippet to use in the teardown phase of an API check.
884
+ :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 group.
885
+ """
886
+ opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
887
+
888
+ __props__ = _CheckGroupState.__new__(_CheckGroupState)
889
+
890
+ __props__.__dict__["activated"] = activated
891
+ __props__.__dict__["alert_channel_subscriptions"] = alert_channel_subscriptions
892
+ __props__.__dict__["alert_settings"] = alert_settings
893
+ __props__.__dict__["api_check_defaults"] = api_check_defaults
894
+ __props__.__dict__["concurrency"] = concurrency
895
+ __props__.__dict__["double_check"] = double_check
896
+ __props__.__dict__["environment_variable"] = environment_variable
897
+ __props__.__dict__["environment_variables"] = environment_variables
898
+ __props__.__dict__["local_setup_script"] = local_setup_script
899
+ __props__.__dict__["local_teardown_script"] = local_teardown_script
900
+ __props__.__dict__["locations"] = locations
901
+ __props__.__dict__["muted"] = muted
902
+ __props__.__dict__["name"] = name
903
+ __props__.__dict__["private_locations"] = private_locations
904
+ __props__.__dict__["retry_strategy"] = retry_strategy
905
+ __props__.__dict__["run_parallel"] = run_parallel
906
+ __props__.__dict__["runtime_id"] = runtime_id
907
+ __props__.__dict__["setup_snippet_id"] = setup_snippet_id
908
+ __props__.__dict__["tags"] = tags
909
+ __props__.__dict__["teardown_snippet_id"] = teardown_snippet_id
910
+ __props__.__dict__["use_global_alert_settings"] = use_global_alert_settings
911
+ return CheckGroup(resource_name, opts=opts, __props__=__props__)
912
+
913
+ @property
914
+ @pulumi.getter
915
+ def activated(self) -> pulumi.Output[bool]:
916
+ """
917
+ Determines if the checks in the group are running or not.
918
+ """
919
+ return pulumi.get(self, "activated")
920
+
921
+ @property
922
+ @pulumi.getter(name="alertChannelSubscriptions")
923
+ def alert_channel_subscriptions(self) -> pulumi.Output[Optional[Sequence['outputs.CheckGroupAlertChannelSubscription']]]:
924
+ return pulumi.get(self, "alert_channel_subscriptions")
925
+
926
+ @property
927
+ @pulumi.getter(name="alertSettings")
928
+ def alert_settings(self) -> pulumi.Output['outputs.CheckGroupAlertSettings']:
929
+ return pulumi.get(self, "alert_settings")
930
+
931
+ @property
932
+ @pulumi.getter(name="apiCheckDefaults")
933
+ def api_check_defaults(self) -> pulumi.Output['outputs.CheckGroupApiCheckDefaults']:
934
+ return pulumi.get(self, "api_check_defaults")
935
+
936
+ @property
937
+ @pulumi.getter
938
+ def concurrency(self) -> pulumi.Output[int]:
939
+ """
940
+ Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
941
+ """
942
+ return pulumi.get(self, "concurrency")
943
+
944
+ @property
945
+ @pulumi.getter(name="doubleCheck")
946
+ @_utilities.deprecated("""The property `double_check` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retry_strategy` property instead.""")
947
+ def double_check(self) -> pulumi.Output[Optional[bool]]:
948
+ """
949
+ Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.
950
+ """
951
+ return pulumi.get(self, "double_check")
952
+
953
+ @property
954
+ @pulumi.getter(name="environmentVariable")
955
+ def environment_variable(self) -> pulumi.Output[Optional[Sequence['outputs.CheckGroupEnvironmentVariable']]]:
956
+ """
957
+ Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
958
+ """
959
+ return pulumi.get(self, "environment_variable")
960
+
961
+ @property
962
+ @pulumi.getter(name="environmentVariables")
963
+ @_utilities.deprecated("""The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""")
964
+ def environment_variables(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
965
+ """
966
+ Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.
967
+ """
968
+ return pulumi.get(self, "environment_variables")
969
+
970
+ @property
971
+ @pulumi.getter(name="localSetupScript")
972
+ def local_setup_script(self) -> pulumi.Output[Optional[str]]:
973
+ """
974
+ A valid piece of Node.js code to run in the setup phase of an API check in this group.
975
+ """
976
+ return pulumi.get(self, "local_setup_script")
977
+
978
+ @property
979
+ @pulumi.getter(name="localTeardownScript")
980
+ def local_teardown_script(self) -> pulumi.Output[Optional[str]]:
981
+ """
982
+ A valid piece of Node.js code to run in the teardown phase of an API check in this group.
983
+ """
984
+ return pulumi.get(self, "local_teardown_script")
985
+
986
+ @property
987
+ @pulumi.getter
988
+ def locations(self) -> pulumi.Output[Optional[Sequence[str]]]:
989
+ """
990
+ An array of one or more data center locations where to run the checks.
991
+ """
992
+ return pulumi.get(self, "locations")
993
+
994
+ @property
995
+ @pulumi.getter
996
+ def muted(self) -> pulumi.Output[Optional[bool]]:
997
+ """
998
+ Determines if any notifications will be sent out when a check in this group fails and/or recovers.
999
+ """
1000
+ return pulumi.get(self, "muted")
1001
+
1002
+ @property
1003
+ @pulumi.getter
1004
+ def name(self) -> pulumi.Output[str]:
1005
+ """
1006
+ The name of the check group.
1007
+ """
1008
+ return pulumi.get(self, "name")
1009
+
1010
+ @property
1011
+ @pulumi.getter(name="privateLocations")
1012
+ def private_locations(self) -> pulumi.Output[Optional[Sequence[str]]]:
1013
+ """
1014
+ An array of one or more private locations slugs.
1015
+ """
1016
+ return pulumi.get(self, "private_locations")
1017
+
1018
+ @property
1019
+ @pulumi.getter(name="retryStrategy")
1020
+ def retry_strategy(self) -> pulumi.Output['outputs.CheckGroupRetryStrategy']:
1021
+ """
1022
+ A strategy for retrying failed check runs.
1023
+ """
1024
+ return pulumi.get(self, "retry_strategy")
1025
+
1026
+ @property
1027
+ @pulumi.getter(name="runParallel")
1028
+ def run_parallel(self) -> pulumi.Output[Optional[bool]]:
1029
+ """
1030
+ Determines if the checks in the group should run in all selected locations in parallel or round-robin.
1031
+ """
1032
+ return pulumi.get(self, "run_parallel")
1033
+
1034
+ @property
1035
+ @pulumi.getter(name="runtimeId")
1036
+ def runtime_id(self) -> pulumi.Output[Optional[str]]:
1037
+ """
1038
+ The id of the runtime to use for this group.
1039
+ """
1040
+ return pulumi.get(self, "runtime_id")
1041
+
1042
+ @property
1043
+ @pulumi.getter(name="setupSnippetId")
1044
+ def setup_snippet_id(self) -> pulumi.Output[Optional[int]]:
1045
+ """
1046
+ An ID reference to a snippet to use in the setup phase of an API check.
1047
+ """
1048
+ return pulumi.get(self, "setup_snippet_id")
1049
+
1050
+ @property
1051
+ @pulumi.getter
1052
+ def tags(self) -> pulumi.Output[Optional[Sequence[str]]]:
1053
+ """
1054
+ Tags for organizing and filtering checks.
1055
+ """
1056
+ return pulumi.get(self, "tags")
1057
+
1058
+ @property
1059
+ @pulumi.getter(name="teardownSnippetId")
1060
+ def teardown_snippet_id(self) -> pulumi.Output[Optional[int]]:
1061
+ """
1062
+ An ID reference to a snippet to use in the teardown phase of an API check.
1063
+ """
1064
+ return pulumi.get(self, "teardown_snippet_id")
1065
+
1066
+ @property
1067
+ @pulumi.getter(name="useGlobalAlertSettings")
1068
+ def use_global_alert_settings(self) -> pulumi.Output[Optional[bool]]:
1069
+ """
1070
+ When true, the account level alert settings will be used, not the alert setting defined on this check group.
1071
+ """
1072
+ return pulumi.get(self, "use_global_alert_settings")
1073
+