pulumi-checkly 2.0.0a1738674781__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pulumi_checkly/__init__.py +143 -0
- pulumi_checkly/_inputs.py +3131 -0
- pulumi_checkly/_utilities.py +327 -0
- pulumi_checkly/alert_channel.py +742 -0
- pulumi_checkly/check.py +1579 -0
- pulumi_checkly/check_group.py +1073 -0
- pulumi_checkly/config/__init__.py +8 -0
- pulumi_checkly/config/__init__.pyi +22 -0
- pulumi_checkly/config/vars.py +34 -0
- pulumi_checkly/dashboard.py +920 -0
- pulumi_checkly/environment_variable.py +269 -0
- pulumi_checkly/get_static_ips.py +126 -0
- pulumi_checkly/heartbeat_check.py +480 -0
- pulumi_checkly/maintenance_window.py +462 -0
- pulumi_checkly/outputs.py +2413 -0
- pulumi_checkly/private_location.py +293 -0
- pulumi_checkly/provider.py +144 -0
- pulumi_checkly/pulumi-plugin.json +6 -0
- pulumi_checkly/py.typed +0 -0
- pulumi_checkly/snippet.py +228 -0
- pulumi_checkly/tcp_check.py +1171 -0
- pulumi_checkly/trigger_check.py +261 -0
- pulumi_checkly/trigger_check_group.py +261 -0
- pulumi_checkly-2.0.0a1738674781.dist-info/METADATA +69 -0
- pulumi_checkly-2.0.0a1738674781.dist-info/RECORD +27 -0
- pulumi_checkly-2.0.0a1738674781.dist-info/WHEEL +5 -0
- pulumi_checkly-2.0.0a1738674781.dist-info/top_level.txt +1 -0
pulumi_checkly/check.py
ADDED
|
@@ -0,0 +1,1579 @@
|
|
|
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__ = ['CheckArgs', 'Check']
|
|
20
|
+
|
|
21
|
+
@pulumi.input_type
|
|
22
|
+
class CheckArgs:
|
|
23
|
+
def __init__(__self__, *,
|
|
24
|
+
activated: pulumi.Input[bool],
|
|
25
|
+
frequency: pulumi.Input[int],
|
|
26
|
+
type: pulumi.Input[str],
|
|
27
|
+
alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input['CheckAlertChannelSubscriptionArgs']]]] = None,
|
|
28
|
+
alert_settings: Optional[pulumi.Input['CheckAlertSettingsArgs']] = None,
|
|
29
|
+
degraded_response_time: Optional[pulumi.Input[int]] = None,
|
|
30
|
+
double_check: Optional[pulumi.Input[bool]] = None,
|
|
31
|
+
environment_variable: Optional[pulumi.Input[Sequence[pulumi.Input['CheckEnvironmentVariableArgs']]]] = None,
|
|
32
|
+
environment_variables: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
33
|
+
frequency_offset: Optional[pulumi.Input[int]] = None,
|
|
34
|
+
group_id: Optional[pulumi.Input[int]] = None,
|
|
35
|
+
group_order: Optional[pulumi.Input[int]] = None,
|
|
36
|
+
local_setup_script: Optional[pulumi.Input[str]] = None,
|
|
37
|
+
local_teardown_script: Optional[pulumi.Input[str]] = None,
|
|
38
|
+
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
39
|
+
max_response_time: Optional[pulumi.Input[int]] = None,
|
|
40
|
+
muted: Optional[pulumi.Input[bool]] = None,
|
|
41
|
+
name: Optional[pulumi.Input[str]] = None,
|
|
42
|
+
private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
43
|
+
request: Optional[pulumi.Input['CheckRequestArgs']] = None,
|
|
44
|
+
retry_strategy: Optional[pulumi.Input['CheckRetryStrategyArgs']] = None,
|
|
45
|
+
run_parallel: Optional[pulumi.Input[bool]] = None,
|
|
46
|
+
runtime_id: Optional[pulumi.Input[str]] = None,
|
|
47
|
+
script: Optional[pulumi.Input[str]] = None,
|
|
48
|
+
setup_snippet_id: Optional[pulumi.Input[int]] = None,
|
|
49
|
+
should_fail: Optional[pulumi.Input[bool]] = None,
|
|
50
|
+
ssl_check: Optional[pulumi.Input[bool]] = None,
|
|
51
|
+
ssl_check_domain: Optional[pulumi.Input[str]] = None,
|
|
52
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
53
|
+
teardown_snippet_id: Optional[pulumi.Input[int]] = None,
|
|
54
|
+
use_global_alert_settings: Optional[pulumi.Input[bool]] = None):
|
|
55
|
+
"""
|
|
56
|
+
The set of arguments for constructing a Check resource.
|
|
57
|
+
:param pulumi.Input[bool] activated: Determines if the check is running or not. Possible values `true`, and `false`.
|
|
58
|
+
: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`.
|
|
59
|
+
:param pulumi.Input[str] type: The type of the check. Possible values are `API`, `BROWSER`, and `MULTI_STEP`.
|
|
60
|
+
:param pulumi.Input[Sequence[pulumi.Input['CheckAlertChannelSubscriptionArgs']]] 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.
|
|
61
|
+
: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 30000. (Default `15000`).
|
|
62
|
+
: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.
|
|
63
|
+
:param pulumi.Input[Sequence[pulumi.Input['CheckEnvironmentVariableArgs']]] 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.
|
|
64
|
+
: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.
|
|
65
|
+
:param pulumi.Input[int] frequency_offset: This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequency_offset` could be `10`, `20` or `30`.
|
|
66
|
+
:param pulumi.Input[int] group_id: The id of the check group this check is part of.
|
|
67
|
+
: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.
|
|
68
|
+
:param pulumi.Input[str] local_setup_script: A valid piece of Node.js code to run in the setup phase.
|
|
69
|
+
:param pulumi.Input[str] local_teardown_script: A valid piece of Node.js code to run in the teardown phase.
|
|
70
|
+
: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"])
|
|
71
|
+
: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 30000. (Default `30000`).
|
|
72
|
+
:param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check fails/degrades/recovers.
|
|
73
|
+
:param pulumi.Input[str] name: The name of the check.
|
|
74
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
|
|
75
|
+
:param pulumi.Input['CheckRequestArgs'] request: An API check might have one request config.
|
|
76
|
+
:param pulumi.Input['CheckRetryStrategyArgs'] retry_strategy: A strategy for retrying failed check runs.
|
|
77
|
+
:param pulumi.Input[bool] run_parallel: Determines if the check should run in all selected locations in parallel or round-robin.
|
|
78
|
+
:param pulumi.Input[str] runtime_id: The id of the runtime to use for this check.
|
|
79
|
+
:param pulumi.Input[str] script: A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
|
|
80
|
+
:param pulumi.Input[int] setup_snippet_id: An ID reference to a snippet to use in the setup phase of an API check.
|
|
81
|
+
:param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
|
|
82
|
+
:param pulumi.Input[bool] ssl_check: Determines if the SSL certificate should be validated for expiry.
|
|
83
|
+
:param pulumi.Input[str] ssl_check_domain: A valid fully qualified domain name (FQDN) to check its SSL certificate.
|
|
84
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks.
|
|
85
|
+
:param pulumi.Input[int] teardown_snippet_id: An ID reference to a snippet to use in the teardown phase of an API check.
|
|
86
|
+
: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.
|
|
87
|
+
"""
|
|
88
|
+
pulumi.set(__self__, "activated", activated)
|
|
89
|
+
pulumi.set(__self__, "frequency", frequency)
|
|
90
|
+
pulumi.set(__self__, "type", type)
|
|
91
|
+
if alert_channel_subscriptions is not None:
|
|
92
|
+
pulumi.set(__self__, "alert_channel_subscriptions", alert_channel_subscriptions)
|
|
93
|
+
if alert_settings is not None:
|
|
94
|
+
pulumi.set(__self__, "alert_settings", alert_settings)
|
|
95
|
+
if degraded_response_time is not None:
|
|
96
|
+
pulumi.set(__self__, "degraded_response_time", degraded_response_time)
|
|
97
|
+
if double_check is not None:
|
|
98
|
+
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)
|
|
99
|
+
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.""")
|
|
100
|
+
if double_check is not None:
|
|
101
|
+
pulumi.set(__self__, "double_check", double_check)
|
|
102
|
+
if environment_variable is not None:
|
|
103
|
+
pulumi.set(__self__, "environment_variable", environment_variable)
|
|
104
|
+
if environment_variables is not None:
|
|
105
|
+
warnings.warn("""The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""", DeprecationWarning)
|
|
106
|
+
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.""")
|
|
107
|
+
if environment_variables is not None:
|
|
108
|
+
pulumi.set(__self__, "environment_variables", environment_variables)
|
|
109
|
+
if frequency_offset is not None:
|
|
110
|
+
pulumi.set(__self__, "frequency_offset", frequency_offset)
|
|
111
|
+
if group_id is not None:
|
|
112
|
+
pulumi.set(__self__, "group_id", group_id)
|
|
113
|
+
if group_order is not None:
|
|
114
|
+
pulumi.set(__self__, "group_order", group_order)
|
|
115
|
+
if local_setup_script is not None:
|
|
116
|
+
pulumi.set(__self__, "local_setup_script", local_setup_script)
|
|
117
|
+
if local_teardown_script is not None:
|
|
118
|
+
pulumi.set(__self__, "local_teardown_script", local_teardown_script)
|
|
119
|
+
if locations is not None:
|
|
120
|
+
pulumi.set(__self__, "locations", locations)
|
|
121
|
+
if max_response_time is not None:
|
|
122
|
+
pulumi.set(__self__, "max_response_time", max_response_time)
|
|
123
|
+
if muted is not None:
|
|
124
|
+
pulumi.set(__self__, "muted", muted)
|
|
125
|
+
if name is not None:
|
|
126
|
+
pulumi.set(__self__, "name", name)
|
|
127
|
+
if private_locations is not None:
|
|
128
|
+
pulumi.set(__self__, "private_locations", private_locations)
|
|
129
|
+
if request is not None:
|
|
130
|
+
pulumi.set(__self__, "request", request)
|
|
131
|
+
if retry_strategy is not None:
|
|
132
|
+
pulumi.set(__self__, "retry_strategy", retry_strategy)
|
|
133
|
+
if run_parallel is not None:
|
|
134
|
+
pulumi.set(__self__, "run_parallel", run_parallel)
|
|
135
|
+
if runtime_id is not None:
|
|
136
|
+
pulumi.set(__self__, "runtime_id", runtime_id)
|
|
137
|
+
if script is not None:
|
|
138
|
+
pulumi.set(__self__, "script", script)
|
|
139
|
+
if setup_snippet_id is not None:
|
|
140
|
+
pulumi.set(__self__, "setup_snippet_id", setup_snippet_id)
|
|
141
|
+
if should_fail is not None:
|
|
142
|
+
pulumi.set(__self__, "should_fail", should_fail)
|
|
143
|
+
if ssl_check is not None:
|
|
144
|
+
warnings.warn("""The property `ssl_check` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.""", DeprecationWarning)
|
|
145
|
+
pulumi.log.warn("""ssl_check is deprecated: The property `ssl_check` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.""")
|
|
146
|
+
if ssl_check is not None:
|
|
147
|
+
pulumi.set(__self__, "ssl_check", ssl_check)
|
|
148
|
+
if ssl_check_domain is not None:
|
|
149
|
+
pulumi.set(__self__, "ssl_check_domain", ssl_check_domain)
|
|
150
|
+
if tags is not None:
|
|
151
|
+
pulumi.set(__self__, "tags", tags)
|
|
152
|
+
if teardown_snippet_id is not None:
|
|
153
|
+
pulumi.set(__self__, "teardown_snippet_id", teardown_snippet_id)
|
|
154
|
+
if use_global_alert_settings is not None:
|
|
155
|
+
pulumi.set(__self__, "use_global_alert_settings", use_global_alert_settings)
|
|
156
|
+
|
|
157
|
+
@property
|
|
158
|
+
@pulumi.getter
|
|
159
|
+
def activated(self) -> pulumi.Input[bool]:
|
|
160
|
+
"""
|
|
161
|
+
Determines if the check is running or not. Possible values `true`, and `false`.
|
|
162
|
+
"""
|
|
163
|
+
return pulumi.get(self, "activated")
|
|
164
|
+
|
|
165
|
+
@activated.setter
|
|
166
|
+
def activated(self, value: pulumi.Input[bool]):
|
|
167
|
+
pulumi.set(self, "activated", value)
|
|
168
|
+
|
|
169
|
+
@property
|
|
170
|
+
@pulumi.getter
|
|
171
|
+
def frequency(self) -> pulumi.Input[int]:
|
|
172
|
+
"""
|
|
173
|
+
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`.
|
|
174
|
+
"""
|
|
175
|
+
return pulumi.get(self, "frequency")
|
|
176
|
+
|
|
177
|
+
@frequency.setter
|
|
178
|
+
def frequency(self, value: pulumi.Input[int]):
|
|
179
|
+
pulumi.set(self, "frequency", value)
|
|
180
|
+
|
|
181
|
+
@property
|
|
182
|
+
@pulumi.getter
|
|
183
|
+
def type(self) -> pulumi.Input[str]:
|
|
184
|
+
"""
|
|
185
|
+
The type of the check. Possible values are `API`, `BROWSER`, and `MULTI_STEP`.
|
|
186
|
+
"""
|
|
187
|
+
return pulumi.get(self, "type")
|
|
188
|
+
|
|
189
|
+
@type.setter
|
|
190
|
+
def type(self, value: pulumi.Input[str]):
|
|
191
|
+
pulumi.set(self, "type", value)
|
|
192
|
+
|
|
193
|
+
@property
|
|
194
|
+
@pulumi.getter(name="alertChannelSubscriptions")
|
|
195
|
+
def alert_channel_subscriptions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CheckAlertChannelSubscriptionArgs']]]]:
|
|
196
|
+
"""
|
|
197
|
+
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.
|
|
198
|
+
"""
|
|
199
|
+
return pulumi.get(self, "alert_channel_subscriptions")
|
|
200
|
+
|
|
201
|
+
@alert_channel_subscriptions.setter
|
|
202
|
+
def alert_channel_subscriptions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CheckAlertChannelSubscriptionArgs']]]]):
|
|
203
|
+
pulumi.set(self, "alert_channel_subscriptions", value)
|
|
204
|
+
|
|
205
|
+
@property
|
|
206
|
+
@pulumi.getter(name="alertSettings")
|
|
207
|
+
def alert_settings(self) -> Optional[pulumi.Input['CheckAlertSettingsArgs']]:
|
|
208
|
+
return pulumi.get(self, "alert_settings")
|
|
209
|
+
|
|
210
|
+
@alert_settings.setter
|
|
211
|
+
def alert_settings(self, value: Optional[pulumi.Input['CheckAlertSettingsArgs']]):
|
|
212
|
+
pulumi.set(self, "alert_settings", value)
|
|
213
|
+
|
|
214
|
+
@property
|
|
215
|
+
@pulumi.getter(name="degradedResponseTime")
|
|
216
|
+
def degraded_response_time(self) -> Optional[pulumi.Input[int]]:
|
|
217
|
+
"""
|
|
218
|
+
The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default `15000`).
|
|
219
|
+
"""
|
|
220
|
+
return pulumi.get(self, "degraded_response_time")
|
|
221
|
+
|
|
222
|
+
@degraded_response_time.setter
|
|
223
|
+
def degraded_response_time(self, value: Optional[pulumi.Input[int]]):
|
|
224
|
+
pulumi.set(self, "degraded_response_time", value)
|
|
225
|
+
|
|
226
|
+
@property
|
|
227
|
+
@pulumi.getter(name="doubleCheck")
|
|
228
|
+
@_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.""")
|
|
229
|
+
def double_check(self) -> Optional[pulumi.Input[bool]]:
|
|
230
|
+
"""
|
|
231
|
+
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.
|
|
232
|
+
"""
|
|
233
|
+
return pulumi.get(self, "double_check")
|
|
234
|
+
|
|
235
|
+
@double_check.setter
|
|
236
|
+
def double_check(self, value: Optional[pulumi.Input[bool]]):
|
|
237
|
+
pulumi.set(self, "double_check", value)
|
|
238
|
+
|
|
239
|
+
@property
|
|
240
|
+
@pulumi.getter(name="environmentVariable")
|
|
241
|
+
def environment_variable(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CheckEnvironmentVariableArgs']]]]:
|
|
242
|
+
"""
|
|
243
|
+
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.
|
|
244
|
+
"""
|
|
245
|
+
return pulumi.get(self, "environment_variable")
|
|
246
|
+
|
|
247
|
+
@environment_variable.setter
|
|
248
|
+
def environment_variable(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CheckEnvironmentVariableArgs']]]]):
|
|
249
|
+
pulumi.set(self, "environment_variable", value)
|
|
250
|
+
|
|
251
|
+
@property
|
|
252
|
+
@pulumi.getter(name="environmentVariables")
|
|
253
|
+
@_utilities.deprecated("""The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""")
|
|
254
|
+
def environment_variables(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
|
|
255
|
+
"""
|
|
256
|
+
Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.
|
|
257
|
+
"""
|
|
258
|
+
return pulumi.get(self, "environment_variables")
|
|
259
|
+
|
|
260
|
+
@environment_variables.setter
|
|
261
|
+
def environment_variables(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
|
|
262
|
+
pulumi.set(self, "environment_variables", value)
|
|
263
|
+
|
|
264
|
+
@property
|
|
265
|
+
@pulumi.getter(name="frequencyOffset")
|
|
266
|
+
def frequency_offset(self) -> Optional[pulumi.Input[int]]:
|
|
267
|
+
"""
|
|
268
|
+
This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequency_offset` could be `10`, `20` or `30`.
|
|
269
|
+
"""
|
|
270
|
+
return pulumi.get(self, "frequency_offset")
|
|
271
|
+
|
|
272
|
+
@frequency_offset.setter
|
|
273
|
+
def frequency_offset(self, value: Optional[pulumi.Input[int]]):
|
|
274
|
+
pulumi.set(self, "frequency_offset", value)
|
|
275
|
+
|
|
276
|
+
@property
|
|
277
|
+
@pulumi.getter(name="groupId")
|
|
278
|
+
def group_id(self) -> Optional[pulumi.Input[int]]:
|
|
279
|
+
"""
|
|
280
|
+
The id of the check group this check is part of.
|
|
281
|
+
"""
|
|
282
|
+
return pulumi.get(self, "group_id")
|
|
283
|
+
|
|
284
|
+
@group_id.setter
|
|
285
|
+
def group_id(self, value: Optional[pulumi.Input[int]]):
|
|
286
|
+
pulumi.set(self, "group_id", value)
|
|
287
|
+
|
|
288
|
+
@property
|
|
289
|
+
@pulumi.getter(name="groupOrder")
|
|
290
|
+
def group_order(self) -> Optional[pulumi.Input[int]]:
|
|
291
|
+
"""
|
|
292
|
+
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.
|
|
293
|
+
"""
|
|
294
|
+
return pulumi.get(self, "group_order")
|
|
295
|
+
|
|
296
|
+
@group_order.setter
|
|
297
|
+
def group_order(self, value: Optional[pulumi.Input[int]]):
|
|
298
|
+
pulumi.set(self, "group_order", value)
|
|
299
|
+
|
|
300
|
+
@property
|
|
301
|
+
@pulumi.getter(name="localSetupScript")
|
|
302
|
+
def local_setup_script(self) -> Optional[pulumi.Input[str]]:
|
|
303
|
+
"""
|
|
304
|
+
A valid piece of Node.js code to run in the setup phase.
|
|
305
|
+
"""
|
|
306
|
+
return pulumi.get(self, "local_setup_script")
|
|
307
|
+
|
|
308
|
+
@local_setup_script.setter
|
|
309
|
+
def local_setup_script(self, value: Optional[pulumi.Input[str]]):
|
|
310
|
+
pulumi.set(self, "local_setup_script", value)
|
|
311
|
+
|
|
312
|
+
@property
|
|
313
|
+
@pulumi.getter(name="localTeardownScript")
|
|
314
|
+
def local_teardown_script(self) -> Optional[pulumi.Input[str]]:
|
|
315
|
+
"""
|
|
316
|
+
A valid piece of Node.js code to run in the teardown phase.
|
|
317
|
+
"""
|
|
318
|
+
return pulumi.get(self, "local_teardown_script")
|
|
319
|
+
|
|
320
|
+
@local_teardown_script.setter
|
|
321
|
+
def local_teardown_script(self, value: Optional[pulumi.Input[str]]):
|
|
322
|
+
pulumi.set(self, "local_teardown_script", value)
|
|
323
|
+
|
|
324
|
+
@property
|
|
325
|
+
@pulumi.getter
|
|
326
|
+
def locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
327
|
+
"""
|
|
328
|
+
An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
|
|
329
|
+
"""
|
|
330
|
+
return pulumi.get(self, "locations")
|
|
331
|
+
|
|
332
|
+
@locations.setter
|
|
333
|
+
def locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
|
334
|
+
pulumi.set(self, "locations", value)
|
|
335
|
+
|
|
336
|
+
@property
|
|
337
|
+
@pulumi.getter(name="maxResponseTime")
|
|
338
|
+
def max_response_time(self) -> Optional[pulumi.Input[int]]:
|
|
339
|
+
"""
|
|
340
|
+
The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default `30000`).
|
|
341
|
+
"""
|
|
342
|
+
return pulumi.get(self, "max_response_time")
|
|
343
|
+
|
|
344
|
+
@max_response_time.setter
|
|
345
|
+
def max_response_time(self, value: Optional[pulumi.Input[int]]):
|
|
346
|
+
pulumi.set(self, "max_response_time", value)
|
|
347
|
+
|
|
348
|
+
@property
|
|
349
|
+
@pulumi.getter
|
|
350
|
+
def muted(self) -> Optional[pulumi.Input[bool]]:
|
|
351
|
+
"""
|
|
352
|
+
Determines if any notifications will be sent out when a check fails/degrades/recovers.
|
|
353
|
+
"""
|
|
354
|
+
return pulumi.get(self, "muted")
|
|
355
|
+
|
|
356
|
+
@muted.setter
|
|
357
|
+
def muted(self, value: Optional[pulumi.Input[bool]]):
|
|
358
|
+
pulumi.set(self, "muted", value)
|
|
359
|
+
|
|
360
|
+
@property
|
|
361
|
+
@pulumi.getter
|
|
362
|
+
def name(self) -> Optional[pulumi.Input[str]]:
|
|
363
|
+
"""
|
|
364
|
+
The name of the check.
|
|
365
|
+
"""
|
|
366
|
+
return pulumi.get(self, "name")
|
|
367
|
+
|
|
368
|
+
@name.setter
|
|
369
|
+
def name(self, value: Optional[pulumi.Input[str]]):
|
|
370
|
+
pulumi.set(self, "name", value)
|
|
371
|
+
|
|
372
|
+
@property
|
|
373
|
+
@pulumi.getter(name="privateLocations")
|
|
374
|
+
def private_locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
375
|
+
"""
|
|
376
|
+
An array of one or more private locations slugs.
|
|
377
|
+
"""
|
|
378
|
+
return pulumi.get(self, "private_locations")
|
|
379
|
+
|
|
380
|
+
@private_locations.setter
|
|
381
|
+
def private_locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
|
382
|
+
pulumi.set(self, "private_locations", value)
|
|
383
|
+
|
|
384
|
+
@property
|
|
385
|
+
@pulumi.getter
|
|
386
|
+
def request(self) -> Optional[pulumi.Input['CheckRequestArgs']]:
|
|
387
|
+
"""
|
|
388
|
+
An API check might have one request config.
|
|
389
|
+
"""
|
|
390
|
+
return pulumi.get(self, "request")
|
|
391
|
+
|
|
392
|
+
@request.setter
|
|
393
|
+
def request(self, value: Optional[pulumi.Input['CheckRequestArgs']]):
|
|
394
|
+
pulumi.set(self, "request", value)
|
|
395
|
+
|
|
396
|
+
@property
|
|
397
|
+
@pulumi.getter(name="retryStrategy")
|
|
398
|
+
def retry_strategy(self) -> Optional[pulumi.Input['CheckRetryStrategyArgs']]:
|
|
399
|
+
"""
|
|
400
|
+
A strategy for retrying failed check runs.
|
|
401
|
+
"""
|
|
402
|
+
return pulumi.get(self, "retry_strategy")
|
|
403
|
+
|
|
404
|
+
@retry_strategy.setter
|
|
405
|
+
def retry_strategy(self, value: Optional[pulumi.Input['CheckRetryStrategyArgs']]):
|
|
406
|
+
pulumi.set(self, "retry_strategy", value)
|
|
407
|
+
|
|
408
|
+
@property
|
|
409
|
+
@pulumi.getter(name="runParallel")
|
|
410
|
+
def run_parallel(self) -> Optional[pulumi.Input[bool]]:
|
|
411
|
+
"""
|
|
412
|
+
Determines if the check should run in all selected locations in parallel or round-robin.
|
|
413
|
+
"""
|
|
414
|
+
return pulumi.get(self, "run_parallel")
|
|
415
|
+
|
|
416
|
+
@run_parallel.setter
|
|
417
|
+
def run_parallel(self, value: Optional[pulumi.Input[bool]]):
|
|
418
|
+
pulumi.set(self, "run_parallel", value)
|
|
419
|
+
|
|
420
|
+
@property
|
|
421
|
+
@pulumi.getter(name="runtimeId")
|
|
422
|
+
def runtime_id(self) -> Optional[pulumi.Input[str]]:
|
|
423
|
+
"""
|
|
424
|
+
The id of the runtime to use for this check.
|
|
425
|
+
"""
|
|
426
|
+
return pulumi.get(self, "runtime_id")
|
|
427
|
+
|
|
428
|
+
@runtime_id.setter
|
|
429
|
+
def runtime_id(self, value: Optional[pulumi.Input[str]]):
|
|
430
|
+
pulumi.set(self, "runtime_id", value)
|
|
431
|
+
|
|
432
|
+
@property
|
|
433
|
+
@pulumi.getter
|
|
434
|
+
def script(self) -> Optional[pulumi.Input[str]]:
|
|
435
|
+
"""
|
|
436
|
+
A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
|
|
437
|
+
"""
|
|
438
|
+
return pulumi.get(self, "script")
|
|
439
|
+
|
|
440
|
+
@script.setter
|
|
441
|
+
def script(self, value: Optional[pulumi.Input[str]]):
|
|
442
|
+
pulumi.set(self, "script", value)
|
|
443
|
+
|
|
444
|
+
@property
|
|
445
|
+
@pulumi.getter(name="setupSnippetId")
|
|
446
|
+
def setup_snippet_id(self) -> Optional[pulumi.Input[int]]:
|
|
447
|
+
"""
|
|
448
|
+
An ID reference to a snippet to use in the setup phase of an API check.
|
|
449
|
+
"""
|
|
450
|
+
return pulumi.get(self, "setup_snippet_id")
|
|
451
|
+
|
|
452
|
+
@setup_snippet_id.setter
|
|
453
|
+
def setup_snippet_id(self, value: Optional[pulumi.Input[int]]):
|
|
454
|
+
pulumi.set(self, "setup_snippet_id", value)
|
|
455
|
+
|
|
456
|
+
@property
|
|
457
|
+
@pulumi.getter(name="shouldFail")
|
|
458
|
+
def should_fail(self) -> Optional[pulumi.Input[bool]]:
|
|
459
|
+
"""
|
|
460
|
+
Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
|
|
461
|
+
"""
|
|
462
|
+
return pulumi.get(self, "should_fail")
|
|
463
|
+
|
|
464
|
+
@should_fail.setter
|
|
465
|
+
def should_fail(self, value: Optional[pulumi.Input[bool]]):
|
|
466
|
+
pulumi.set(self, "should_fail", value)
|
|
467
|
+
|
|
468
|
+
@property
|
|
469
|
+
@pulumi.getter(name="sslCheck")
|
|
470
|
+
@_utilities.deprecated("""The property `ssl_check` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.""")
|
|
471
|
+
def ssl_check(self) -> Optional[pulumi.Input[bool]]:
|
|
472
|
+
"""
|
|
473
|
+
Determines if the SSL certificate should be validated for expiry.
|
|
474
|
+
"""
|
|
475
|
+
return pulumi.get(self, "ssl_check")
|
|
476
|
+
|
|
477
|
+
@ssl_check.setter
|
|
478
|
+
def ssl_check(self, value: Optional[pulumi.Input[bool]]):
|
|
479
|
+
pulumi.set(self, "ssl_check", value)
|
|
480
|
+
|
|
481
|
+
@property
|
|
482
|
+
@pulumi.getter(name="sslCheckDomain")
|
|
483
|
+
def ssl_check_domain(self) -> Optional[pulumi.Input[str]]:
|
|
484
|
+
"""
|
|
485
|
+
A valid fully qualified domain name (FQDN) to check its SSL certificate.
|
|
486
|
+
"""
|
|
487
|
+
return pulumi.get(self, "ssl_check_domain")
|
|
488
|
+
|
|
489
|
+
@ssl_check_domain.setter
|
|
490
|
+
def ssl_check_domain(self, value: Optional[pulumi.Input[str]]):
|
|
491
|
+
pulumi.set(self, "ssl_check_domain", value)
|
|
492
|
+
|
|
493
|
+
@property
|
|
494
|
+
@pulumi.getter
|
|
495
|
+
def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
496
|
+
"""
|
|
497
|
+
A list of tags for organizing and filtering checks.
|
|
498
|
+
"""
|
|
499
|
+
return pulumi.get(self, "tags")
|
|
500
|
+
|
|
501
|
+
@tags.setter
|
|
502
|
+
def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
|
503
|
+
pulumi.set(self, "tags", value)
|
|
504
|
+
|
|
505
|
+
@property
|
|
506
|
+
@pulumi.getter(name="teardownSnippetId")
|
|
507
|
+
def teardown_snippet_id(self) -> Optional[pulumi.Input[int]]:
|
|
508
|
+
"""
|
|
509
|
+
An ID reference to a snippet to use in the teardown phase of an API check.
|
|
510
|
+
"""
|
|
511
|
+
return pulumi.get(self, "teardown_snippet_id")
|
|
512
|
+
|
|
513
|
+
@teardown_snippet_id.setter
|
|
514
|
+
def teardown_snippet_id(self, value: Optional[pulumi.Input[int]]):
|
|
515
|
+
pulumi.set(self, "teardown_snippet_id", value)
|
|
516
|
+
|
|
517
|
+
@property
|
|
518
|
+
@pulumi.getter(name="useGlobalAlertSettings")
|
|
519
|
+
def use_global_alert_settings(self) -> Optional[pulumi.Input[bool]]:
|
|
520
|
+
"""
|
|
521
|
+
When true, the account level alert settings will be used, not the alert setting defined on this check.
|
|
522
|
+
"""
|
|
523
|
+
return pulumi.get(self, "use_global_alert_settings")
|
|
524
|
+
|
|
525
|
+
@use_global_alert_settings.setter
|
|
526
|
+
def use_global_alert_settings(self, value: Optional[pulumi.Input[bool]]):
|
|
527
|
+
pulumi.set(self, "use_global_alert_settings", value)
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
@pulumi.input_type
|
|
531
|
+
class _CheckState:
|
|
532
|
+
def __init__(__self__, *,
|
|
533
|
+
activated: Optional[pulumi.Input[bool]] = None,
|
|
534
|
+
alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input['CheckAlertChannelSubscriptionArgs']]]] = None,
|
|
535
|
+
alert_settings: Optional[pulumi.Input['CheckAlertSettingsArgs']] = None,
|
|
536
|
+
degraded_response_time: Optional[pulumi.Input[int]] = None,
|
|
537
|
+
double_check: Optional[pulumi.Input[bool]] = None,
|
|
538
|
+
environment_variable: Optional[pulumi.Input[Sequence[pulumi.Input['CheckEnvironmentVariableArgs']]]] = None,
|
|
539
|
+
environment_variables: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
540
|
+
frequency: Optional[pulumi.Input[int]] = None,
|
|
541
|
+
frequency_offset: Optional[pulumi.Input[int]] = None,
|
|
542
|
+
group_id: Optional[pulumi.Input[int]] = None,
|
|
543
|
+
group_order: Optional[pulumi.Input[int]] = None,
|
|
544
|
+
local_setup_script: Optional[pulumi.Input[str]] = None,
|
|
545
|
+
local_teardown_script: Optional[pulumi.Input[str]] = None,
|
|
546
|
+
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
547
|
+
max_response_time: Optional[pulumi.Input[int]] = None,
|
|
548
|
+
muted: Optional[pulumi.Input[bool]] = None,
|
|
549
|
+
name: Optional[pulumi.Input[str]] = None,
|
|
550
|
+
private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
551
|
+
request: Optional[pulumi.Input['CheckRequestArgs']] = None,
|
|
552
|
+
retry_strategy: Optional[pulumi.Input['CheckRetryStrategyArgs']] = None,
|
|
553
|
+
run_parallel: Optional[pulumi.Input[bool]] = None,
|
|
554
|
+
runtime_id: Optional[pulumi.Input[str]] = None,
|
|
555
|
+
script: Optional[pulumi.Input[str]] = None,
|
|
556
|
+
setup_snippet_id: Optional[pulumi.Input[int]] = None,
|
|
557
|
+
should_fail: Optional[pulumi.Input[bool]] = None,
|
|
558
|
+
ssl_check: Optional[pulumi.Input[bool]] = None,
|
|
559
|
+
ssl_check_domain: Optional[pulumi.Input[str]] = None,
|
|
560
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
561
|
+
teardown_snippet_id: Optional[pulumi.Input[int]] = None,
|
|
562
|
+
type: Optional[pulumi.Input[str]] = None,
|
|
563
|
+
use_global_alert_settings: Optional[pulumi.Input[bool]] = None):
|
|
564
|
+
"""
|
|
565
|
+
Input properties used for looking up and filtering Check resources.
|
|
566
|
+
:param pulumi.Input[bool] activated: Determines if the check is running or not. Possible values `true`, and `false`.
|
|
567
|
+
:param pulumi.Input[Sequence[pulumi.Input['CheckAlertChannelSubscriptionArgs']]] 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.
|
|
568
|
+
: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 30000. (Default `15000`).
|
|
569
|
+
: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.
|
|
570
|
+
:param pulumi.Input[Sequence[pulumi.Input['CheckEnvironmentVariableArgs']]] 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.
|
|
571
|
+
: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.
|
|
572
|
+
: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`.
|
|
573
|
+
:param pulumi.Input[int] frequency_offset: This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequency_offset` could be `10`, `20` or `30`.
|
|
574
|
+
:param pulumi.Input[int] group_id: The id of the check group this check is part of.
|
|
575
|
+
: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.
|
|
576
|
+
:param pulumi.Input[str] local_setup_script: A valid piece of Node.js code to run in the setup phase.
|
|
577
|
+
:param pulumi.Input[str] local_teardown_script: A valid piece of Node.js code to run in the teardown phase.
|
|
578
|
+
: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"])
|
|
579
|
+
: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 30000. (Default `30000`).
|
|
580
|
+
:param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check fails/degrades/recovers.
|
|
581
|
+
:param pulumi.Input[str] name: The name of the check.
|
|
582
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
|
|
583
|
+
:param pulumi.Input['CheckRequestArgs'] request: An API check might have one request config.
|
|
584
|
+
:param pulumi.Input['CheckRetryStrategyArgs'] retry_strategy: A strategy for retrying failed check runs.
|
|
585
|
+
:param pulumi.Input[bool] run_parallel: Determines if the check should run in all selected locations in parallel or round-robin.
|
|
586
|
+
:param pulumi.Input[str] runtime_id: The id of the runtime to use for this check.
|
|
587
|
+
:param pulumi.Input[str] script: A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
|
|
588
|
+
:param pulumi.Input[int] setup_snippet_id: An ID reference to a snippet to use in the setup phase of an API check.
|
|
589
|
+
:param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
|
|
590
|
+
:param pulumi.Input[bool] ssl_check: Determines if the SSL certificate should be validated for expiry.
|
|
591
|
+
:param pulumi.Input[str] ssl_check_domain: A valid fully qualified domain name (FQDN) to check its SSL certificate.
|
|
592
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks.
|
|
593
|
+
:param pulumi.Input[int] teardown_snippet_id: An ID reference to a snippet to use in the teardown phase of an API check.
|
|
594
|
+
:param pulumi.Input[str] type: The type of the check. Possible values are `API`, `BROWSER`, and `MULTI_STEP`.
|
|
595
|
+
: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.
|
|
596
|
+
"""
|
|
597
|
+
if activated is not None:
|
|
598
|
+
pulumi.set(__self__, "activated", activated)
|
|
599
|
+
if alert_channel_subscriptions is not None:
|
|
600
|
+
pulumi.set(__self__, "alert_channel_subscriptions", alert_channel_subscriptions)
|
|
601
|
+
if alert_settings is not None:
|
|
602
|
+
pulumi.set(__self__, "alert_settings", alert_settings)
|
|
603
|
+
if degraded_response_time is not None:
|
|
604
|
+
pulumi.set(__self__, "degraded_response_time", degraded_response_time)
|
|
605
|
+
if double_check is not None:
|
|
606
|
+
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)
|
|
607
|
+
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.""")
|
|
608
|
+
if double_check is not None:
|
|
609
|
+
pulumi.set(__self__, "double_check", double_check)
|
|
610
|
+
if environment_variable is not None:
|
|
611
|
+
pulumi.set(__self__, "environment_variable", environment_variable)
|
|
612
|
+
if environment_variables is not None:
|
|
613
|
+
warnings.warn("""The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""", DeprecationWarning)
|
|
614
|
+
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.""")
|
|
615
|
+
if environment_variables is not None:
|
|
616
|
+
pulumi.set(__self__, "environment_variables", environment_variables)
|
|
617
|
+
if frequency is not None:
|
|
618
|
+
pulumi.set(__self__, "frequency", frequency)
|
|
619
|
+
if frequency_offset is not None:
|
|
620
|
+
pulumi.set(__self__, "frequency_offset", frequency_offset)
|
|
621
|
+
if group_id is not None:
|
|
622
|
+
pulumi.set(__self__, "group_id", group_id)
|
|
623
|
+
if group_order is not None:
|
|
624
|
+
pulumi.set(__self__, "group_order", group_order)
|
|
625
|
+
if local_setup_script is not None:
|
|
626
|
+
pulumi.set(__self__, "local_setup_script", local_setup_script)
|
|
627
|
+
if local_teardown_script is not None:
|
|
628
|
+
pulumi.set(__self__, "local_teardown_script", local_teardown_script)
|
|
629
|
+
if locations is not None:
|
|
630
|
+
pulumi.set(__self__, "locations", locations)
|
|
631
|
+
if max_response_time is not None:
|
|
632
|
+
pulumi.set(__self__, "max_response_time", max_response_time)
|
|
633
|
+
if muted is not None:
|
|
634
|
+
pulumi.set(__self__, "muted", muted)
|
|
635
|
+
if name is not None:
|
|
636
|
+
pulumi.set(__self__, "name", name)
|
|
637
|
+
if private_locations is not None:
|
|
638
|
+
pulumi.set(__self__, "private_locations", private_locations)
|
|
639
|
+
if request is not None:
|
|
640
|
+
pulumi.set(__self__, "request", request)
|
|
641
|
+
if retry_strategy is not None:
|
|
642
|
+
pulumi.set(__self__, "retry_strategy", retry_strategy)
|
|
643
|
+
if run_parallel is not None:
|
|
644
|
+
pulumi.set(__self__, "run_parallel", run_parallel)
|
|
645
|
+
if runtime_id is not None:
|
|
646
|
+
pulumi.set(__self__, "runtime_id", runtime_id)
|
|
647
|
+
if script is not None:
|
|
648
|
+
pulumi.set(__self__, "script", script)
|
|
649
|
+
if setup_snippet_id is not None:
|
|
650
|
+
pulumi.set(__self__, "setup_snippet_id", setup_snippet_id)
|
|
651
|
+
if should_fail is not None:
|
|
652
|
+
pulumi.set(__self__, "should_fail", should_fail)
|
|
653
|
+
if ssl_check is not None:
|
|
654
|
+
warnings.warn("""The property `ssl_check` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.""", DeprecationWarning)
|
|
655
|
+
pulumi.log.warn("""ssl_check is deprecated: The property `ssl_check` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.""")
|
|
656
|
+
if ssl_check is not None:
|
|
657
|
+
pulumi.set(__self__, "ssl_check", ssl_check)
|
|
658
|
+
if ssl_check_domain is not None:
|
|
659
|
+
pulumi.set(__self__, "ssl_check_domain", ssl_check_domain)
|
|
660
|
+
if tags is not None:
|
|
661
|
+
pulumi.set(__self__, "tags", tags)
|
|
662
|
+
if teardown_snippet_id is not None:
|
|
663
|
+
pulumi.set(__self__, "teardown_snippet_id", teardown_snippet_id)
|
|
664
|
+
if type is not None:
|
|
665
|
+
pulumi.set(__self__, "type", type)
|
|
666
|
+
if use_global_alert_settings is not None:
|
|
667
|
+
pulumi.set(__self__, "use_global_alert_settings", use_global_alert_settings)
|
|
668
|
+
|
|
669
|
+
@property
|
|
670
|
+
@pulumi.getter
|
|
671
|
+
def activated(self) -> Optional[pulumi.Input[bool]]:
|
|
672
|
+
"""
|
|
673
|
+
Determines if the check is running or not. Possible values `true`, and `false`.
|
|
674
|
+
"""
|
|
675
|
+
return pulumi.get(self, "activated")
|
|
676
|
+
|
|
677
|
+
@activated.setter
|
|
678
|
+
def activated(self, value: Optional[pulumi.Input[bool]]):
|
|
679
|
+
pulumi.set(self, "activated", value)
|
|
680
|
+
|
|
681
|
+
@property
|
|
682
|
+
@pulumi.getter(name="alertChannelSubscriptions")
|
|
683
|
+
def alert_channel_subscriptions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CheckAlertChannelSubscriptionArgs']]]]:
|
|
684
|
+
"""
|
|
685
|
+
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.
|
|
686
|
+
"""
|
|
687
|
+
return pulumi.get(self, "alert_channel_subscriptions")
|
|
688
|
+
|
|
689
|
+
@alert_channel_subscriptions.setter
|
|
690
|
+
def alert_channel_subscriptions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CheckAlertChannelSubscriptionArgs']]]]):
|
|
691
|
+
pulumi.set(self, "alert_channel_subscriptions", value)
|
|
692
|
+
|
|
693
|
+
@property
|
|
694
|
+
@pulumi.getter(name="alertSettings")
|
|
695
|
+
def alert_settings(self) -> Optional[pulumi.Input['CheckAlertSettingsArgs']]:
|
|
696
|
+
return pulumi.get(self, "alert_settings")
|
|
697
|
+
|
|
698
|
+
@alert_settings.setter
|
|
699
|
+
def alert_settings(self, value: Optional[pulumi.Input['CheckAlertSettingsArgs']]):
|
|
700
|
+
pulumi.set(self, "alert_settings", value)
|
|
701
|
+
|
|
702
|
+
@property
|
|
703
|
+
@pulumi.getter(name="degradedResponseTime")
|
|
704
|
+
def degraded_response_time(self) -> Optional[pulumi.Input[int]]:
|
|
705
|
+
"""
|
|
706
|
+
The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default `15000`).
|
|
707
|
+
"""
|
|
708
|
+
return pulumi.get(self, "degraded_response_time")
|
|
709
|
+
|
|
710
|
+
@degraded_response_time.setter
|
|
711
|
+
def degraded_response_time(self, value: Optional[pulumi.Input[int]]):
|
|
712
|
+
pulumi.set(self, "degraded_response_time", value)
|
|
713
|
+
|
|
714
|
+
@property
|
|
715
|
+
@pulumi.getter(name="doubleCheck")
|
|
716
|
+
@_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.""")
|
|
717
|
+
def double_check(self) -> Optional[pulumi.Input[bool]]:
|
|
718
|
+
"""
|
|
719
|
+
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.
|
|
720
|
+
"""
|
|
721
|
+
return pulumi.get(self, "double_check")
|
|
722
|
+
|
|
723
|
+
@double_check.setter
|
|
724
|
+
def double_check(self, value: Optional[pulumi.Input[bool]]):
|
|
725
|
+
pulumi.set(self, "double_check", value)
|
|
726
|
+
|
|
727
|
+
@property
|
|
728
|
+
@pulumi.getter(name="environmentVariable")
|
|
729
|
+
def environment_variable(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CheckEnvironmentVariableArgs']]]]:
|
|
730
|
+
"""
|
|
731
|
+
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.
|
|
732
|
+
"""
|
|
733
|
+
return pulumi.get(self, "environment_variable")
|
|
734
|
+
|
|
735
|
+
@environment_variable.setter
|
|
736
|
+
def environment_variable(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CheckEnvironmentVariableArgs']]]]):
|
|
737
|
+
pulumi.set(self, "environment_variable", value)
|
|
738
|
+
|
|
739
|
+
@property
|
|
740
|
+
@pulumi.getter(name="environmentVariables")
|
|
741
|
+
@_utilities.deprecated("""The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""")
|
|
742
|
+
def environment_variables(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
|
|
743
|
+
"""
|
|
744
|
+
Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.
|
|
745
|
+
"""
|
|
746
|
+
return pulumi.get(self, "environment_variables")
|
|
747
|
+
|
|
748
|
+
@environment_variables.setter
|
|
749
|
+
def environment_variables(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
|
|
750
|
+
pulumi.set(self, "environment_variables", value)
|
|
751
|
+
|
|
752
|
+
@property
|
|
753
|
+
@pulumi.getter
|
|
754
|
+
def frequency(self) -> Optional[pulumi.Input[int]]:
|
|
755
|
+
"""
|
|
756
|
+
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`.
|
|
757
|
+
"""
|
|
758
|
+
return pulumi.get(self, "frequency")
|
|
759
|
+
|
|
760
|
+
@frequency.setter
|
|
761
|
+
def frequency(self, value: Optional[pulumi.Input[int]]):
|
|
762
|
+
pulumi.set(self, "frequency", value)
|
|
763
|
+
|
|
764
|
+
@property
|
|
765
|
+
@pulumi.getter(name="frequencyOffset")
|
|
766
|
+
def frequency_offset(self) -> Optional[pulumi.Input[int]]:
|
|
767
|
+
"""
|
|
768
|
+
This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequency_offset` could be `10`, `20` or `30`.
|
|
769
|
+
"""
|
|
770
|
+
return pulumi.get(self, "frequency_offset")
|
|
771
|
+
|
|
772
|
+
@frequency_offset.setter
|
|
773
|
+
def frequency_offset(self, value: Optional[pulumi.Input[int]]):
|
|
774
|
+
pulumi.set(self, "frequency_offset", value)
|
|
775
|
+
|
|
776
|
+
@property
|
|
777
|
+
@pulumi.getter(name="groupId")
|
|
778
|
+
def group_id(self) -> Optional[pulumi.Input[int]]:
|
|
779
|
+
"""
|
|
780
|
+
The id of the check group this check is part of.
|
|
781
|
+
"""
|
|
782
|
+
return pulumi.get(self, "group_id")
|
|
783
|
+
|
|
784
|
+
@group_id.setter
|
|
785
|
+
def group_id(self, value: Optional[pulumi.Input[int]]):
|
|
786
|
+
pulumi.set(self, "group_id", value)
|
|
787
|
+
|
|
788
|
+
@property
|
|
789
|
+
@pulumi.getter(name="groupOrder")
|
|
790
|
+
def group_order(self) -> Optional[pulumi.Input[int]]:
|
|
791
|
+
"""
|
|
792
|
+
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.
|
|
793
|
+
"""
|
|
794
|
+
return pulumi.get(self, "group_order")
|
|
795
|
+
|
|
796
|
+
@group_order.setter
|
|
797
|
+
def group_order(self, value: Optional[pulumi.Input[int]]):
|
|
798
|
+
pulumi.set(self, "group_order", value)
|
|
799
|
+
|
|
800
|
+
@property
|
|
801
|
+
@pulumi.getter(name="localSetupScript")
|
|
802
|
+
def local_setup_script(self) -> Optional[pulumi.Input[str]]:
|
|
803
|
+
"""
|
|
804
|
+
A valid piece of Node.js code to run in the setup phase.
|
|
805
|
+
"""
|
|
806
|
+
return pulumi.get(self, "local_setup_script")
|
|
807
|
+
|
|
808
|
+
@local_setup_script.setter
|
|
809
|
+
def local_setup_script(self, value: Optional[pulumi.Input[str]]):
|
|
810
|
+
pulumi.set(self, "local_setup_script", value)
|
|
811
|
+
|
|
812
|
+
@property
|
|
813
|
+
@pulumi.getter(name="localTeardownScript")
|
|
814
|
+
def local_teardown_script(self) -> Optional[pulumi.Input[str]]:
|
|
815
|
+
"""
|
|
816
|
+
A valid piece of Node.js code to run in the teardown phase.
|
|
817
|
+
"""
|
|
818
|
+
return pulumi.get(self, "local_teardown_script")
|
|
819
|
+
|
|
820
|
+
@local_teardown_script.setter
|
|
821
|
+
def local_teardown_script(self, value: Optional[pulumi.Input[str]]):
|
|
822
|
+
pulumi.set(self, "local_teardown_script", value)
|
|
823
|
+
|
|
824
|
+
@property
|
|
825
|
+
@pulumi.getter
|
|
826
|
+
def locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
827
|
+
"""
|
|
828
|
+
An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
|
|
829
|
+
"""
|
|
830
|
+
return pulumi.get(self, "locations")
|
|
831
|
+
|
|
832
|
+
@locations.setter
|
|
833
|
+
def locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
|
834
|
+
pulumi.set(self, "locations", value)
|
|
835
|
+
|
|
836
|
+
@property
|
|
837
|
+
@pulumi.getter(name="maxResponseTime")
|
|
838
|
+
def max_response_time(self) -> Optional[pulumi.Input[int]]:
|
|
839
|
+
"""
|
|
840
|
+
The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default `30000`).
|
|
841
|
+
"""
|
|
842
|
+
return pulumi.get(self, "max_response_time")
|
|
843
|
+
|
|
844
|
+
@max_response_time.setter
|
|
845
|
+
def max_response_time(self, value: Optional[pulumi.Input[int]]):
|
|
846
|
+
pulumi.set(self, "max_response_time", value)
|
|
847
|
+
|
|
848
|
+
@property
|
|
849
|
+
@pulumi.getter
|
|
850
|
+
def muted(self) -> Optional[pulumi.Input[bool]]:
|
|
851
|
+
"""
|
|
852
|
+
Determines if any notifications will be sent out when a check fails/degrades/recovers.
|
|
853
|
+
"""
|
|
854
|
+
return pulumi.get(self, "muted")
|
|
855
|
+
|
|
856
|
+
@muted.setter
|
|
857
|
+
def muted(self, value: Optional[pulumi.Input[bool]]):
|
|
858
|
+
pulumi.set(self, "muted", value)
|
|
859
|
+
|
|
860
|
+
@property
|
|
861
|
+
@pulumi.getter
|
|
862
|
+
def name(self) -> Optional[pulumi.Input[str]]:
|
|
863
|
+
"""
|
|
864
|
+
The name of the check.
|
|
865
|
+
"""
|
|
866
|
+
return pulumi.get(self, "name")
|
|
867
|
+
|
|
868
|
+
@name.setter
|
|
869
|
+
def name(self, value: Optional[pulumi.Input[str]]):
|
|
870
|
+
pulumi.set(self, "name", value)
|
|
871
|
+
|
|
872
|
+
@property
|
|
873
|
+
@pulumi.getter(name="privateLocations")
|
|
874
|
+
def private_locations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
875
|
+
"""
|
|
876
|
+
An array of one or more private locations slugs.
|
|
877
|
+
"""
|
|
878
|
+
return pulumi.get(self, "private_locations")
|
|
879
|
+
|
|
880
|
+
@private_locations.setter
|
|
881
|
+
def private_locations(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
|
882
|
+
pulumi.set(self, "private_locations", value)
|
|
883
|
+
|
|
884
|
+
@property
|
|
885
|
+
@pulumi.getter
|
|
886
|
+
def request(self) -> Optional[pulumi.Input['CheckRequestArgs']]:
|
|
887
|
+
"""
|
|
888
|
+
An API check might have one request config.
|
|
889
|
+
"""
|
|
890
|
+
return pulumi.get(self, "request")
|
|
891
|
+
|
|
892
|
+
@request.setter
|
|
893
|
+
def request(self, value: Optional[pulumi.Input['CheckRequestArgs']]):
|
|
894
|
+
pulumi.set(self, "request", value)
|
|
895
|
+
|
|
896
|
+
@property
|
|
897
|
+
@pulumi.getter(name="retryStrategy")
|
|
898
|
+
def retry_strategy(self) -> Optional[pulumi.Input['CheckRetryStrategyArgs']]:
|
|
899
|
+
"""
|
|
900
|
+
A strategy for retrying failed check runs.
|
|
901
|
+
"""
|
|
902
|
+
return pulumi.get(self, "retry_strategy")
|
|
903
|
+
|
|
904
|
+
@retry_strategy.setter
|
|
905
|
+
def retry_strategy(self, value: Optional[pulumi.Input['CheckRetryStrategyArgs']]):
|
|
906
|
+
pulumi.set(self, "retry_strategy", value)
|
|
907
|
+
|
|
908
|
+
@property
|
|
909
|
+
@pulumi.getter(name="runParallel")
|
|
910
|
+
def run_parallel(self) -> Optional[pulumi.Input[bool]]:
|
|
911
|
+
"""
|
|
912
|
+
Determines if the check should run in all selected locations in parallel or round-robin.
|
|
913
|
+
"""
|
|
914
|
+
return pulumi.get(self, "run_parallel")
|
|
915
|
+
|
|
916
|
+
@run_parallel.setter
|
|
917
|
+
def run_parallel(self, value: Optional[pulumi.Input[bool]]):
|
|
918
|
+
pulumi.set(self, "run_parallel", value)
|
|
919
|
+
|
|
920
|
+
@property
|
|
921
|
+
@pulumi.getter(name="runtimeId")
|
|
922
|
+
def runtime_id(self) -> Optional[pulumi.Input[str]]:
|
|
923
|
+
"""
|
|
924
|
+
The id of the runtime to use for this check.
|
|
925
|
+
"""
|
|
926
|
+
return pulumi.get(self, "runtime_id")
|
|
927
|
+
|
|
928
|
+
@runtime_id.setter
|
|
929
|
+
def runtime_id(self, value: Optional[pulumi.Input[str]]):
|
|
930
|
+
pulumi.set(self, "runtime_id", value)
|
|
931
|
+
|
|
932
|
+
@property
|
|
933
|
+
@pulumi.getter
|
|
934
|
+
def script(self) -> Optional[pulumi.Input[str]]:
|
|
935
|
+
"""
|
|
936
|
+
A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
|
|
937
|
+
"""
|
|
938
|
+
return pulumi.get(self, "script")
|
|
939
|
+
|
|
940
|
+
@script.setter
|
|
941
|
+
def script(self, value: Optional[pulumi.Input[str]]):
|
|
942
|
+
pulumi.set(self, "script", value)
|
|
943
|
+
|
|
944
|
+
@property
|
|
945
|
+
@pulumi.getter(name="setupSnippetId")
|
|
946
|
+
def setup_snippet_id(self) -> Optional[pulumi.Input[int]]:
|
|
947
|
+
"""
|
|
948
|
+
An ID reference to a snippet to use in the setup phase of an API check.
|
|
949
|
+
"""
|
|
950
|
+
return pulumi.get(self, "setup_snippet_id")
|
|
951
|
+
|
|
952
|
+
@setup_snippet_id.setter
|
|
953
|
+
def setup_snippet_id(self, value: Optional[pulumi.Input[int]]):
|
|
954
|
+
pulumi.set(self, "setup_snippet_id", value)
|
|
955
|
+
|
|
956
|
+
@property
|
|
957
|
+
@pulumi.getter(name="shouldFail")
|
|
958
|
+
def should_fail(self) -> Optional[pulumi.Input[bool]]:
|
|
959
|
+
"""
|
|
960
|
+
Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
|
|
961
|
+
"""
|
|
962
|
+
return pulumi.get(self, "should_fail")
|
|
963
|
+
|
|
964
|
+
@should_fail.setter
|
|
965
|
+
def should_fail(self, value: Optional[pulumi.Input[bool]]):
|
|
966
|
+
pulumi.set(self, "should_fail", value)
|
|
967
|
+
|
|
968
|
+
@property
|
|
969
|
+
@pulumi.getter(name="sslCheck")
|
|
970
|
+
@_utilities.deprecated("""The property `ssl_check` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.""")
|
|
971
|
+
def ssl_check(self) -> Optional[pulumi.Input[bool]]:
|
|
972
|
+
"""
|
|
973
|
+
Determines if the SSL certificate should be validated for expiry.
|
|
974
|
+
"""
|
|
975
|
+
return pulumi.get(self, "ssl_check")
|
|
976
|
+
|
|
977
|
+
@ssl_check.setter
|
|
978
|
+
def ssl_check(self, value: Optional[pulumi.Input[bool]]):
|
|
979
|
+
pulumi.set(self, "ssl_check", value)
|
|
980
|
+
|
|
981
|
+
@property
|
|
982
|
+
@pulumi.getter(name="sslCheckDomain")
|
|
983
|
+
def ssl_check_domain(self) -> Optional[pulumi.Input[str]]:
|
|
984
|
+
"""
|
|
985
|
+
A valid fully qualified domain name (FQDN) to check its SSL certificate.
|
|
986
|
+
"""
|
|
987
|
+
return pulumi.get(self, "ssl_check_domain")
|
|
988
|
+
|
|
989
|
+
@ssl_check_domain.setter
|
|
990
|
+
def ssl_check_domain(self, value: Optional[pulumi.Input[str]]):
|
|
991
|
+
pulumi.set(self, "ssl_check_domain", value)
|
|
992
|
+
|
|
993
|
+
@property
|
|
994
|
+
@pulumi.getter
|
|
995
|
+
def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
996
|
+
"""
|
|
997
|
+
A list of tags for organizing and filtering checks.
|
|
998
|
+
"""
|
|
999
|
+
return pulumi.get(self, "tags")
|
|
1000
|
+
|
|
1001
|
+
@tags.setter
|
|
1002
|
+
def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
|
1003
|
+
pulumi.set(self, "tags", value)
|
|
1004
|
+
|
|
1005
|
+
@property
|
|
1006
|
+
@pulumi.getter(name="teardownSnippetId")
|
|
1007
|
+
def teardown_snippet_id(self) -> Optional[pulumi.Input[int]]:
|
|
1008
|
+
"""
|
|
1009
|
+
An ID reference to a snippet to use in the teardown phase of an API check.
|
|
1010
|
+
"""
|
|
1011
|
+
return pulumi.get(self, "teardown_snippet_id")
|
|
1012
|
+
|
|
1013
|
+
@teardown_snippet_id.setter
|
|
1014
|
+
def teardown_snippet_id(self, value: Optional[pulumi.Input[int]]):
|
|
1015
|
+
pulumi.set(self, "teardown_snippet_id", value)
|
|
1016
|
+
|
|
1017
|
+
@property
|
|
1018
|
+
@pulumi.getter
|
|
1019
|
+
def type(self) -> Optional[pulumi.Input[str]]:
|
|
1020
|
+
"""
|
|
1021
|
+
The type of the check. Possible values are `API`, `BROWSER`, and `MULTI_STEP`.
|
|
1022
|
+
"""
|
|
1023
|
+
return pulumi.get(self, "type")
|
|
1024
|
+
|
|
1025
|
+
@type.setter
|
|
1026
|
+
def type(self, value: Optional[pulumi.Input[str]]):
|
|
1027
|
+
pulumi.set(self, "type", value)
|
|
1028
|
+
|
|
1029
|
+
@property
|
|
1030
|
+
@pulumi.getter(name="useGlobalAlertSettings")
|
|
1031
|
+
def use_global_alert_settings(self) -> Optional[pulumi.Input[bool]]:
|
|
1032
|
+
"""
|
|
1033
|
+
When true, the account level alert settings will be used, not the alert setting defined on this check.
|
|
1034
|
+
"""
|
|
1035
|
+
return pulumi.get(self, "use_global_alert_settings")
|
|
1036
|
+
|
|
1037
|
+
@use_global_alert_settings.setter
|
|
1038
|
+
def use_global_alert_settings(self, value: Optional[pulumi.Input[bool]]):
|
|
1039
|
+
pulumi.set(self, "use_global_alert_settings", value)
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
class Check(pulumi.CustomResource):
|
|
1043
|
+
@overload
|
|
1044
|
+
def __init__(__self__,
|
|
1045
|
+
resource_name: str,
|
|
1046
|
+
opts: Optional[pulumi.ResourceOptions] = None,
|
|
1047
|
+
activated: Optional[pulumi.Input[bool]] = None,
|
|
1048
|
+
alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckAlertChannelSubscriptionArgs', 'CheckAlertChannelSubscriptionArgsDict']]]]] = None,
|
|
1049
|
+
alert_settings: Optional[pulumi.Input[Union['CheckAlertSettingsArgs', 'CheckAlertSettingsArgsDict']]] = None,
|
|
1050
|
+
degraded_response_time: Optional[pulumi.Input[int]] = None,
|
|
1051
|
+
double_check: Optional[pulumi.Input[bool]] = None,
|
|
1052
|
+
environment_variable: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckEnvironmentVariableArgs', 'CheckEnvironmentVariableArgsDict']]]]] = None,
|
|
1053
|
+
environment_variables: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
1054
|
+
frequency: Optional[pulumi.Input[int]] = None,
|
|
1055
|
+
frequency_offset: Optional[pulumi.Input[int]] = None,
|
|
1056
|
+
group_id: Optional[pulumi.Input[int]] = None,
|
|
1057
|
+
group_order: Optional[pulumi.Input[int]] = None,
|
|
1058
|
+
local_setup_script: Optional[pulumi.Input[str]] = None,
|
|
1059
|
+
local_teardown_script: Optional[pulumi.Input[str]] = None,
|
|
1060
|
+
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1061
|
+
max_response_time: Optional[pulumi.Input[int]] = None,
|
|
1062
|
+
muted: Optional[pulumi.Input[bool]] = None,
|
|
1063
|
+
name: Optional[pulumi.Input[str]] = None,
|
|
1064
|
+
private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1065
|
+
request: Optional[pulumi.Input[Union['CheckRequestArgs', 'CheckRequestArgsDict']]] = None,
|
|
1066
|
+
retry_strategy: Optional[pulumi.Input[Union['CheckRetryStrategyArgs', 'CheckRetryStrategyArgsDict']]] = None,
|
|
1067
|
+
run_parallel: Optional[pulumi.Input[bool]] = None,
|
|
1068
|
+
runtime_id: Optional[pulumi.Input[str]] = None,
|
|
1069
|
+
script: Optional[pulumi.Input[str]] = None,
|
|
1070
|
+
setup_snippet_id: Optional[pulumi.Input[int]] = None,
|
|
1071
|
+
should_fail: Optional[pulumi.Input[bool]] = None,
|
|
1072
|
+
ssl_check: Optional[pulumi.Input[bool]] = None,
|
|
1073
|
+
ssl_check_domain: Optional[pulumi.Input[str]] = None,
|
|
1074
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1075
|
+
teardown_snippet_id: Optional[pulumi.Input[int]] = None,
|
|
1076
|
+
type: Optional[pulumi.Input[str]] = None,
|
|
1077
|
+
use_global_alert_settings: Optional[pulumi.Input[bool]] = None,
|
|
1078
|
+
__props__=None):
|
|
1079
|
+
"""
|
|
1080
|
+
Checks allows you to monitor key webapp flows, backend API's and set up alerting, so you get a notification when things break or slow down.
|
|
1081
|
+
|
|
1082
|
+
:param str resource_name: The name of the resource.
|
|
1083
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
1084
|
+
:param pulumi.Input[bool] activated: Determines if the check is running or not. Possible values `true`, and `false`.
|
|
1085
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['CheckAlertChannelSubscriptionArgs', 'CheckAlertChannelSubscriptionArgsDict']]]] 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.
|
|
1086
|
+
: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 30000. (Default `15000`).
|
|
1087
|
+
: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.
|
|
1088
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['CheckEnvironmentVariableArgs', 'CheckEnvironmentVariableArgsDict']]]] 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.
|
|
1089
|
+
: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.
|
|
1090
|
+
: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`.
|
|
1091
|
+
:param pulumi.Input[int] frequency_offset: This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequency_offset` could be `10`, `20` or `30`.
|
|
1092
|
+
:param pulumi.Input[int] group_id: The id of the check group this check is part of.
|
|
1093
|
+
: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.
|
|
1094
|
+
:param pulumi.Input[str] local_setup_script: A valid piece of Node.js code to run in the setup phase.
|
|
1095
|
+
:param pulumi.Input[str] local_teardown_script: A valid piece of Node.js code to run in the teardown phase.
|
|
1096
|
+
: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"])
|
|
1097
|
+
: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 30000. (Default `30000`).
|
|
1098
|
+
:param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check fails/degrades/recovers.
|
|
1099
|
+
:param pulumi.Input[str] name: The name of the check.
|
|
1100
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
|
|
1101
|
+
:param pulumi.Input[Union['CheckRequestArgs', 'CheckRequestArgsDict']] request: An API check might have one request config.
|
|
1102
|
+
:param pulumi.Input[Union['CheckRetryStrategyArgs', 'CheckRetryStrategyArgsDict']] retry_strategy: A strategy for retrying failed check runs.
|
|
1103
|
+
:param pulumi.Input[bool] run_parallel: Determines if the check should run in all selected locations in parallel or round-robin.
|
|
1104
|
+
:param pulumi.Input[str] runtime_id: The id of the runtime to use for this check.
|
|
1105
|
+
:param pulumi.Input[str] script: A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
|
|
1106
|
+
:param pulumi.Input[int] setup_snippet_id: An ID reference to a snippet to use in the setup phase of an API check.
|
|
1107
|
+
:param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
|
|
1108
|
+
:param pulumi.Input[bool] ssl_check: Determines if the SSL certificate should be validated for expiry.
|
|
1109
|
+
:param pulumi.Input[str] ssl_check_domain: A valid fully qualified domain name (FQDN) to check its SSL certificate.
|
|
1110
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks.
|
|
1111
|
+
:param pulumi.Input[int] teardown_snippet_id: An ID reference to a snippet to use in the teardown phase of an API check.
|
|
1112
|
+
:param pulumi.Input[str] type: The type of the check. Possible values are `API`, `BROWSER`, and `MULTI_STEP`.
|
|
1113
|
+
: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.
|
|
1114
|
+
"""
|
|
1115
|
+
...
|
|
1116
|
+
@overload
|
|
1117
|
+
def __init__(__self__,
|
|
1118
|
+
resource_name: str,
|
|
1119
|
+
args: CheckArgs,
|
|
1120
|
+
opts: Optional[pulumi.ResourceOptions] = None):
|
|
1121
|
+
"""
|
|
1122
|
+
Checks allows you to monitor key webapp flows, backend API's and set up alerting, so you get a notification when things break or slow down.
|
|
1123
|
+
|
|
1124
|
+
:param str resource_name: The name of the resource.
|
|
1125
|
+
:param CheckArgs args: The arguments to use to populate this resource's properties.
|
|
1126
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
1127
|
+
"""
|
|
1128
|
+
...
|
|
1129
|
+
def __init__(__self__, resource_name: str, *args, **kwargs):
|
|
1130
|
+
resource_args, opts = _utilities.get_resource_args_opts(CheckArgs, pulumi.ResourceOptions, *args, **kwargs)
|
|
1131
|
+
if resource_args is not None:
|
|
1132
|
+
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
|
|
1133
|
+
else:
|
|
1134
|
+
__self__._internal_init(resource_name, *args, **kwargs)
|
|
1135
|
+
|
|
1136
|
+
def _internal_init(__self__,
|
|
1137
|
+
resource_name: str,
|
|
1138
|
+
opts: Optional[pulumi.ResourceOptions] = None,
|
|
1139
|
+
activated: Optional[pulumi.Input[bool]] = None,
|
|
1140
|
+
alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckAlertChannelSubscriptionArgs', 'CheckAlertChannelSubscriptionArgsDict']]]]] = None,
|
|
1141
|
+
alert_settings: Optional[pulumi.Input[Union['CheckAlertSettingsArgs', 'CheckAlertSettingsArgsDict']]] = None,
|
|
1142
|
+
degraded_response_time: Optional[pulumi.Input[int]] = None,
|
|
1143
|
+
double_check: Optional[pulumi.Input[bool]] = None,
|
|
1144
|
+
environment_variable: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckEnvironmentVariableArgs', 'CheckEnvironmentVariableArgsDict']]]]] = None,
|
|
1145
|
+
environment_variables: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
1146
|
+
frequency: Optional[pulumi.Input[int]] = None,
|
|
1147
|
+
frequency_offset: Optional[pulumi.Input[int]] = None,
|
|
1148
|
+
group_id: Optional[pulumi.Input[int]] = None,
|
|
1149
|
+
group_order: Optional[pulumi.Input[int]] = None,
|
|
1150
|
+
local_setup_script: Optional[pulumi.Input[str]] = None,
|
|
1151
|
+
local_teardown_script: Optional[pulumi.Input[str]] = None,
|
|
1152
|
+
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1153
|
+
max_response_time: Optional[pulumi.Input[int]] = None,
|
|
1154
|
+
muted: Optional[pulumi.Input[bool]] = None,
|
|
1155
|
+
name: Optional[pulumi.Input[str]] = None,
|
|
1156
|
+
private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1157
|
+
request: Optional[pulumi.Input[Union['CheckRequestArgs', 'CheckRequestArgsDict']]] = None,
|
|
1158
|
+
retry_strategy: Optional[pulumi.Input[Union['CheckRetryStrategyArgs', 'CheckRetryStrategyArgsDict']]] = None,
|
|
1159
|
+
run_parallel: Optional[pulumi.Input[bool]] = None,
|
|
1160
|
+
runtime_id: Optional[pulumi.Input[str]] = None,
|
|
1161
|
+
script: Optional[pulumi.Input[str]] = None,
|
|
1162
|
+
setup_snippet_id: Optional[pulumi.Input[int]] = None,
|
|
1163
|
+
should_fail: Optional[pulumi.Input[bool]] = None,
|
|
1164
|
+
ssl_check: Optional[pulumi.Input[bool]] = None,
|
|
1165
|
+
ssl_check_domain: Optional[pulumi.Input[str]] = None,
|
|
1166
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1167
|
+
teardown_snippet_id: Optional[pulumi.Input[int]] = None,
|
|
1168
|
+
type: Optional[pulumi.Input[str]] = None,
|
|
1169
|
+
use_global_alert_settings: Optional[pulumi.Input[bool]] = None,
|
|
1170
|
+
__props__=None):
|
|
1171
|
+
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
1172
|
+
if not isinstance(opts, pulumi.ResourceOptions):
|
|
1173
|
+
raise TypeError('Expected resource options to be a ResourceOptions instance')
|
|
1174
|
+
if opts.id is None:
|
|
1175
|
+
if __props__ is not None:
|
|
1176
|
+
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
|
|
1177
|
+
__props__ = CheckArgs.__new__(CheckArgs)
|
|
1178
|
+
|
|
1179
|
+
if activated is None and not opts.urn:
|
|
1180
|
+
raise TypeError("Missing required property 'activated'")
|
|
1181
|
+
__props__.__dict__["activated"] = activated
|
|
1182
|
+
__props__.__dict__["alert_channel_subscriptions"] = alert_channel_subscriptions
|
|
1183
|
+
__props__.__dict__["alert_settings"] = alert_settings
|
|
1184
|
+
__props__.__dict__["degraded_response_time"] = degraded_response_time
|
|
1185
|
+
__props__.__dict__["double_check"] = double_check
|
|
1186
|
+
__props__.__dict__["environment_variable"] = environment_variable
|
|
1187
|
+
__props__.__dict__["environment_variables"] = environment_variables
|
|
1188
|
+
if frequency is None and not opts.urn:
|
|
1189
|
+
raise TypeError("Missing required property 'frequency'")
|
|
1190
|
+
__props__.__dict__["frequency"] = frequency
|
|
1191
|
+
__props__.__dict__["frequency_offset"] = frequency_offset
|
|
1192
|
+
__props__.__dict__["group_id"] = group_id
|
|
1193
|
+
__props__.__dict__["group_order"] = group_order
|
|
1194
|
+
__props__.__dict__["local_setup_script"] = local_setup_script
|
|
1195
|
+
__props__.__dict__["local_teardown_script"] = local_teardown_script
|
|
1196
|
+
__props__.__dict__["locations"] = locations
|
|
1197
|
+
__props__.__dict__["max_response_time"] = max_response_time
|
|
1198
|
+
__props__.__dict__["muted"] = muted
|
|
1199
|
+
__props__.__dict__["name"] = name
|
|
1200
|
+
__props__.__dict__["private_locations"] = private_locations
|
|
1201
|
+
__props__.__dict__["request"] = request
|
|
1202
|
+
__props__.__dict__["retry_strategy"] = retry_strategy
|
|
1203
|
+
__props__.__dict__["run_parallel"] = run_parallel
|
|
1204
|
+
__props__.__dict__["runtime_id"] = runtime_id
|
|
1205
|
+
__props__.__dict__["script"] = script
|
|
1206
|
+
__props__.__dict__["setup_snippet_id"] = setup_snippet_id
|
|
1207
|
+
__props__.__dict__["should_fail"] = should_fail
|
|
1208
|
+
__props__.__dict__["ssl_check"] = ssl_check
|
|
1209
|
+
__props__.__dict__["ssl_check_domain"] = ssl_check_domain
|
|
1210
|
+
__props__.__dict__["tags"] = tags
|
|
1211
|
+
__props__.__dict__["teardown_snippet_id"] = teardown_snippet_id
|
|
1212
|
+
if type is None and not opts.urn:
|
|
1213
|
+
raise TypeError("Missing required property 'type'")
|
|
1214
|
+
__props__.__dict__["type"] = type
|
|
1215
|
+
__props__.__dict__["use_global_alert_settings"] = use_global_alert_settings
|
|
1216
|
+
super(Check, __self__).__init__(
|
|
1217
|
+
'checkly:index/check:Check',
|
|
1218
|
+
resource_name,
|
|
1219
|
+
__props__,
|
|
1220
|
+
opts)
|
|
1221
|
+
|
|
1222
|
+
@staticmethod
|
|
1223
|
+
def get(resource_name: str,
|
|
1224
|
+
id: pulumi.Input[str],
|
|
1225
|
+
opts: Optional[pulumi.ResourceOptions] = None,
|
|
1226
|
+
activated: Optional[pulumi.Input[bool]] = None,
|
|
1227
|
+
alert_channel_subscriptions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckAlertChannelSubscriptionArgs', 'CheckAlertChannelSubscriptionArgsDict']]]]] = None,
|
|
1228
|
+
alert_settings: Optional[pulumi.Input[Union['CheckAlertSettingsArgs', 'CheckAlertSettingsArgsDict']]] = None,
|
|
1229
|
+
degraded_response_time: Optional[pulumi.Input[int]] = None,
|
|
1230
|
+
double_check: Optional[pulumi.Input[bool]] = None,
|
|
1231
|
+
environment_variable: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CheckEnvironmentVariableArgs', 'CheckEnvironmentVariableArgsDict']]]]] = None,
|
|
1232
|
+
environment_variables: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
1233
|
+
frequency: Optional[pulumi.Input[int]] = None,
|
|
1234
|
+
frequency_offset: Optional[pulumi.Input[int]] = None,
|
|
1235
|
+
group_id: Optional[pulumi.Input[int]] = None,
|
|
1236
|
+
group_order: Optional[pulumi.Input[int]] = None,
|
|
1237
|
+
local_setup_script: Optional[pulumi.Input[str]] = None,
|
|
1238
|
+
local_teardown_script: Optional[pulumi.Input[str]] = None,
|
|
1239
|
+
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1240
|
+
max_response_time: Optional[pulumi.Input[int]] = None,
|
|
1241
|
+
muted: Optional[pulumi.Input[bool]] = None,
|
|
1242
|
+
name: Optional[pulumi.Input[str]] = None,
|
|
1243
|
+
private_locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1244
|
+
request: Optional[pulumi.Input[Union['CheckRequestArgs', 'CheckRequestArgsDict']]] = None,
|
|
1245
|
+
retry_strategy: Optional[pulumi.Input[Union['CheckRetryStrategyArgs', 'CheckRetryStrategyArgsDict']]] = None,
|
|
1246
|
+
run_parallel: Optional[pulumi.Input[bool]] = None,
|
|
1247
|
+
runtime_id: Optional[pulumi.Input[str]] = None,
|
|
1248
|
+
script: Optional[pulumi.Input[str]] = None,
|
|
1249
|
+
setup_snippet_id: Optional[pulumi.Input[int]] = None,
|
|
1250
|
+
should_fail: Optional[pulumi.Input[bool]] = None,
|
|
1251
|
+
ssl_check: Optional[pulumi.Input[bool]] = None,
|
|
1252
|
+
ssl_check_domain: Optional[pulumi.Input[str]] = None,
|
|
1253
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1254
|
+
teardown_snippet_id: Optional[pulumi.Input[int]] = None,
|
|
1255
|
+
type: Optional[pulumi.Input[str]] = None,
|
|
1256
|
+
use_global_alert_settings: Optional[pulumi.Input[bool]] = None) -> 'Check':
|
|
1257
|
+
"""
|
|
1258
|
+
Get an existing Check resource's state with the given name, id, and optional extra
|
|
1259
|
+
properties used to qualify the lookup.
|
|
1260
|
+
|
|
1261
|
+
:param str resource_name: The unique name of the resulting resource.
|
|
1262
|
+
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
1263
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
1264
|
+
:param pulumi.Input[bool] activated: Determines if the check is running or not. Possible values `true`, and `false`.
|
|
1265
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['CheckAlertChannelSubscriptionArgs', 'CheckAlertChannelSubscriptionArgsDict']]]] 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.
|
|
1266
|
+
: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 30000. (Default `15000`).
|
|
1267
|
+
: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.
|
|
1268
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['CheckEnvironmentVariableArgs', 'CheckEnvironmentVariableArgsDict']]]] 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.
|
|
1269
|
+
: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.
|
|
1270
|
+
: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`.
|
|
1271
|
+
:param pulumi.Input[int] frequency_offset: This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequency_offset` could be `10`, `20` or `30`.
|
|
1272
|
+
:param pulumi.Input[int] group_id: The id of the check group this check is part of.
|
|
1273
|
+
: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.
|
|
1274
|
+
:param pulumi.Input[str] local_setup_script: A valid piece of Node.js code to run in the setup phase.
|
|
1275
|
+
:param pulumi.Input[str] local_teardown_script: A valid piece of Node.js code to run in the teardown phase.
|
|
1276
|
+
: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"])
|
|
1277
|
+
: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 30000. (Default `30000`).
|
|
1278
|
+
:param pulumi.Input[bool] muted: Determines if any notifications will be sent out when a check fails/degrades/recovers.
|
|
1279
|
+
:param pulumi.Input[str] name: The name of the check.
|
|
1280
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] private_locations: An array of one or more private locations slugs.
|
|
1281
|
+
:param pulumi.Input[Union['CheckRequestArgs', 'CheckRequestArgsDict']] request: An API check might have one request config.
|
|
1282
|
+
:param pulumi.Input[Union['CheckRetryStrategyArgs', 'CheckRetryStrategyArgsDict']] retry_strategy: A strategy for retrying failed check runs.
|
|
1283
|
+
:param pulumi.Input[bool] run_parallel: Determines if the check should run in all selected locations in parallel or round-robin.
|
|
1284
|
+
:param pulumi.Input[str] runtime_id: The id of the runtime to use for this check.
|
|
1285
|
+
:param pulumi.Input[str] script: A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
|
|
1286
|
+
:param pulumi.Input[int] setup_snippet_id: An ID reference to a snippet to use in the setup phase of an API check.
|
|
1287
|
+
:param pulumi.Input[bool] should_fail: Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
|
|
1288
|
+
:param pulumi.Input[bool] ssl_check: Determines if the SSL certificate should be validated for expiry.
|
|
1289
|
+
:param pulumi.Input[str] ssl_check_domain: A valid fully qualified domain name (FQDN) to check its SSL certificate.
|
|
1290
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tags for organizing and filtering checks.
|
|
1291
|
+
:param pulumi.Input[int] teardown_snippet_id: An ID reference to a snippet to use in the teardown phase of an API check.
|
|
1292
|
+
:param pulumi.Input[str] type: The type of the check. Possible values are `API`, `BROWSER`, and `MULTI_STEP`.
|
|
1293
|
+
: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.
|
|
1294
|
+
"""
|
|
1295
|
+
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
1296
|
+
|
|
1297
|
+
__props__ = _CheckState.__new__(_CheckState)
|
|
1298
|
+
|
|
1299
|
+
__props__.__dict__["activated"] = activated
|
|
1300
|
+
__props__.__dict__["alert_channel_subscriptions"] = alert_channel_subscriptions
|
|
1301
|
+
__props__.__dict__["alert_settings"] = alert_settings
|
|
1302
|
+
__props__.__dict__["degraded_response_time"] = degraded_response_time
|
|
1303
|
+
__props__.__dict__["double_check"] = double_check
|
|
1304
|
+
__props__.__dict__["environment_variable"] = environment_variable
|
|
1305
|
+
__props__.__dict__["environment_variables"] = environment_variables
|
|
1306
|
+
__props__.__dict__["frequency"] = frequency
|
|
1307
|
+
__props__.__dict__["frequency_offset"] = frequency_offset
|
|
1308
|
+
__props__.__dict__["group_id"] = group_id
|
|
1309
|
+
__props__.__dict__["group_order"] = group_order
|
|
1310
|
+
__props__.__dict__["local_setup_script"] = local_setup_script
|
|
1311
|
+
__props__.__dict__["local_teardown_script"] = local_teardown_script
|
|
1312
|
+
__props__.__dict__["locations"] = locations
|
|
1313
|
+
__props__.__dict__["max_response_time"] = max_response_time
|
|
1314
|
+
__props__.__dict__["muted"] = muted
|
|
1315
|
+
__props__.__dict__["name"] = name
|
|
1316
|
+
__props__.__dict__["private_locations"] = private_locations
|
|
1317
|
+
__props__.__dict__["request"] = request
|
|
1318
|
+
__props__.__dict__["retry_strategy"] = retry_strategy
|
|
1319
|
+
__props__.__dict__["run_parallel"] = run_parallel
|
|
1320
|
+
__props__.__dict__["runtime_id"] = runtime_id
|
|
1321
|
+
__props__.__dict__["script"] = script
|
|
1322
|
+
__props__.__dict__["setup_snippet_id"] = setup_snippet_id
|
|
1323
|
+
__props__.__dict__["should_fail"] = should_fail
|
|
1324
|
+
__props__.__dict__["ssl_check"] = ssl_check
|
|
1325
|
+
__props__.__dict__["ssl_check_domain"] = ssl_check_domain
|
|
1326
|
+
__props__.__dict__["tags"] = tags
|
|
1327
|
+
__props__.__dict__["teardown_snippet_id"] = teardown_snippet_id
|
|
1328
|
+
__props__.__dict__["type"] = type
|
|
1329
|
+
__props__.__dict__["use_global_alert_settings"] = use_global_alert_settings
|
|
1330
|
+
return Check(resource_name, opts=opts, __props__=__props__)
|
|
1331
|
+
|
|
1332
|
+
@property
|
|
1333
|
+
@pulumi.getter
|
|
1334
|
+
def activated(self) -> pulumi.Output[bool]:
|
|
1335
|
+
"""
|
|
1336
|
+
Determines if the check is running or not. Possible values `true`, and `false`.
|
|
1337
|
+
"""
|
|
1338
|
+
return pulumi.get(self, "activated")
|
|
1339
|
+
|
|
1340
|
+
@property
|
|
1341
|
+
@pulumi.getter(name="alertChannelSubscriptions")
|
|
1342
|
+
def alert_channel_subscriptions(self) -> pulumi.Output[Optional[Sequence['outputs.CheckAlertChannelSubscription']]]:
|
|
1343
|
+
"""
|
|
1344
|
+
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.
|
|
1345
|
+
"""
|
|
1346
|
+
return pulumi.get(self, "alert_channel_subscriptions")
|
|
1347
|
+
|
|
1348
|
+
@property
|
|
1349
|
+
@pulumi.getter(name="alertSettings")
|
|
1350
|
+
def alert_settings(self) -> pulumi.Output['outputs.CheckAlertSettings']:
|
|
1351
|
+
return pulumi.get(self, "alert_settings")
|
|
1352
|
+
|
|
1353
|
+
@property
|
|
1354
|
+
@pulumi.getter(name="degradedResponseTime")
|
|
1355
|
+
def degraded_response_time(self) -> pulumi.Output[Optional[int]]:
|
|
1356
|
+
"""
|
|
1357
|
+
The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default `15000`).
|
|
1358
|
+
"""
|
|
1359
|
+
return pulumi.get(self, "degraded_response_time")
|
|
1360
|
+
|
|
1361
|
+
@property
|
|
1362
|
+
@pulumi.getter(name="doubleCheck")
|
|
1363
|
+
@_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.""")
|
|
1364
|
+
def double_check(self) -> pulumi.Output[Optional[bool]]:
|
|
1365
|
+
"""
|
|
1366
|
+
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.
|
|
1367
|
+
"""
|
|
1368
|
+
return pulumi.get(self, "double_check")
|
|
1369
|
+
|
|
1370
|
+
@property
|
|
1371
|
+
@pulumi.getter(name="environmentVariable")
|
|
1372
|
+
def environment_variable(self) -> pulumi.Output[Optional[Sequence['outputs.CheckEnvironmentVariable']]]:
|
|
1373
|
+
"""
|
|
1374
|
+
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.
|
|
1375
|
+
"""
|
|
1376
|
+
return pulumi.get(self, "environment_variable")
|
|
1377
|
+
|
|
1378
|
+
@property
|
|
1379
|
+
@pulumi.getter(name="environmentVariables")
|
|
1380
|
+
@_utilities.deprecated("""The property `environment_variables` is deprecated and will be removed in a future version. Consider using the new `environment_variable` list.""")
|
|
1381
|
+
def environment_variables(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
|
|
1382
|
+
"""
|
|
1383
|
+
Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.
|
|
1384
|
+
"""
|
|
1385
|
+
return pulumi.get(self, "environment_variables")
|
|
1386
|
+
|
|
1387
|
+
@property
|
|
1388
|
+
@pulumi.getter
|
|
1389
|
+
def frequency(self) -> pulumi.Output[int]:
|
|
1390
|
+
"""
|
|
1391
|
+
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`.
|
|
1392
|
+
"""
|
|
1393
|
+
return pulumi.get(self, "frequency")
|
|
1394
|
+
|
|
1395
|
+
@property
|
|
1396
|
+
@pulumi.getter(name="frequencyOffset")
|
|
1397
|
+
def frequency_offset(self) -> pulumi.Output[Optional[int]]:
|
|
1398
|
+
"""
|
|
1399
|
+
This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequency_offset` could be `10`, `20` or `30`.
|
|
1400
|
+
"""
|
|
1401
|
+
return pulumi.get(self, "frequency_offset")
|
|
1402
|
+
|
|
1403
|
+
@property
|
|
1404
|
+
@pulumi.getter(name="groupId")
|
|
1405
|
+
def group_id(self) -> pulumi.Output[Optional[int]]:
|
|
1406
|
+
"""
|
|
1407
|
+
The id of the check group this check is part of.
|
|
1408
|
+
"""
|
|
1409
|
+
return pulumi.get(self, "group_id")
|
|
1410
|
+
|
|
1411
|
+
@property
|
|
1412
|
+
@pulumi.getter(name="groupOrder")
|
|
1413
|
+
def group_order(self) -> pulumi.Output[Optional[int]]:
|
|
1414
|
+
"""
|
|
1415
|
+
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.
|
|
1416
|
+
"""
|
|
1417
|
+
return pulumi.get(self, "group_order")
|
|
1418
|
+
|
|
1419
|
+
@property
|
|
1420
|
+
@pulumi.getter(name="localSetupScript")
|
|
1421
|
+
def local_setup_script(self) -> pulumi.Output[Optional[str]]:
|
|
1422
|
+
"""
|
|
1423
|
+
A valid piece of Node.js code to run in the setup phase.
|
|
1424
|
+
"""
|
|
1425
|
+
return pulumi.get(self, "local_setup_script")
|
|
1426
|
+
|
|
1427
|
+
@property
|
|
1428
|
+
@pulumi.getter(name="localTeardownScript")
|
|
1429
|
+
def local_teardown_script(self) -> pulumi.Output[Optional[str]]:
|
|
1430
|
+
"""
|
|
1431
|
+
A valid piece of Node.js code to run in the teardown phase.
|
|
1432
|
+
"""
|
|
1433
|
+
return pulumi.get(self, "local_teardown_script")
|
|
1434
|
+
|
|
1435
|
+
@property
|
|
1436
|
+
@pulumi.getter
|
|
1437
|
+
def locations(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
|
1438
|
+
"""
|
|
1439
|
+
An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
|
|
1440
|
+
"""
|
|
1441
|
+
return pulumi.get(self, "locations")
|
|
1442
|
+
|
|
1443
|
+
@property
|
|
1444
|
+
@pulumi.getter(name="maxResponseTime")
|
|
1445
|
+
def max_response_time(self) -> pulumi.Output[Optional[int]]:
|
|
1446
|
+
"""
|
|
1447
|
+
The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default `30000`).
|
|
1448
|
+
"""
|
|
1449
|
+
return pulumi.get(self, "max_response_time")
|
|
1450
|
+
|
|
1451
|
+
@property
|
|
1452
|
+
@pulumi.getter
|
|
1453
|
+
def muted(self) -> pulumi.Output[Optional[bool]]:
|
|
1454
|
+
"""
|
|
1455
|
+
Determines if any notifications will be sent out when a check fails/degrades/recovers.
|
|
1456
|
+
"""
|
|
1457
|
+
return pulumi.get(self, "muted")
|
|
1458
|
+
|
|
1459
|
+
@property
|
|
1460
|
+
@pulumi.getter
|
|
1461
|
+
def name(self) -> pulumi.Output[str]:
|
|
1462
|
+
"""
|
|
1463
|
+
The name of the check.
|
|
1464
|
+
"""
|
|
1465
|
+
return pulumi.get(self, "name")
|
|
1466
|
+
|
|
1467
|
+
@property
|
|
1468
|
+
@pulumi.getter(name="privateLocations")
|
|
1469
|
+
def private_locations(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
|
1470
|
+
"""
|
|
1471
|
+
An array of one or more private locations slugs.
|
|
1472
|
+
"""
|
|
1473
|
+
return pulumi.get(self, "private_locations")
|
|
1474
|
+
|
|
1475
|
+
@property
|
|
1476
|
+
@pulumi.getter
|
|
1477
|
+
def request(self) -> pulumi.Output[Optional['outputs.CheckRequest']]:
|
|
1478
|
+
"""
|
|
1479
|
+
An API check might have one request config.
|
|
1480
|
+
"""
|
|
1481
|
+
return pulumi.get(self, "request")
|
|
1482
|
+
|
|
1483
|
+
@property
|
|
1484
|
+
@pulumi.getter(name="retryStrategy")
|
|
1485
|
+
def retry_strategy(self) -> pulumi.Output['outputs.CheckRetryStrategy']:
|
|
1486
|
+
"""
|
|
1487
|
+
A strategy for retrying failed check runs.
|
|
1488
|
+
"""
|
|
1489
|
+
return pulumi.get(self, "retry_strategy")
|
|
1490
|
+
|
|
1491
|
+
@property
|
|
1492
|
+
@pulumi.getter(name="runParallel")
|
|
1493
|
+
def run_parallel(self) -> pulumi.Output[Optional[bool]]:
|
|
1494
|
+
"""
|
|
1495
|
+
Determines if the check should run in all selected locations in parallel or round-robin.
|
|
1496
|
+
"""
|
|
1497
|
+
return pulumi.get(self, "run_parallel")
|
|
1498
|
+
|
|
1499
|
+
@property
|
|
1500
|
+
@pulumi.getter(name="runtimeId")
|
|
1501
|
+
def runtime_id(self) -> pulumi.Output[Optional[str]]:
|
|
1502
|
+
"""
|
|
1503
|
+
The id of the runtime to use for this check.
|
|
1504
|
+
"""
|
|
1505
|
+
return pulumi.get(self, "runtime_id")
|
|
1506
|
+
|
|
1507
|
+
@property
|
|
1508
|
+
@pulumi.getter
|
|
1509
|
+
def script(self) -> pulumi.Output[Optional[str]]:
|
|
1510
|
+
"""
|
|
1511
|
+
A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
|
|
1512
|
+
"""
|
|
1513
|
+
return pulumi.get(self, "script")
|
|
1514
|
+
|
|
1515
|
+
@property
|
|
1516
|
+
@pulumi.getter(name="setupSnippetId")
|
|
1517
|
+
def setup_snippet_id(self) -> pulumi.Output[Optional[int]]:
|
|
1518
|
+
"""
|
|
1519
|
+
An ID reference to a snippet to use in the setup phase of an API check.
|
|
1520
|
+
"""
|
|
1521
|
+
return pulumi.get(self, "setup_snippet_id")
|
|
1522
|
+
|
|
1523
|
+
@property
|
|
1524
|
+
@pulumi.getter(name="shouldFail")
|
|
1525
|
+
def should_fail(self) -> pulumi.Output[Optional[bool]]:
|
|
1526
|
+
"""
|
|
1527
|
+
Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
|
|
1528
|
+
"""
|
|
1529
|
+
return pulumi.get(self, "should_fail")
|
|
1530
|
+
|
|
1531
|
+
@property
|
|
1532
|
+
@pulumi.getter(name="sslCheck")
|
|
1533
|
+
@_utilities.deprecated("""The property `ssl_check` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.""")
|
|
1534
|
+
def ssl_check(self) -> pulumi.Output[Optional[bool]]:
|
|
1535
|
+
"""
|
|
1536
|
+
Determines if the SSL certificate should be validated for expiry.
|
|
1537
|
+
"""
|
|
1538
|
+
return pulumi.get(self, "ssl_check")
|
|
1539
|
+
|
|
1540
|
+
@property
|
|
1541
|
+
@pulumi.getter(name="sslCheckDomain")
|
|
1542
|
+
def ssl_check_domain(self) -> pulumi.Output[Optional[str]]:
|
|
1543
|
+
"""
|
|
1544
|
+
A valid fully qualified domain name (FQDN) to check its SSL certificate.
|
|
1545
|
+
"""
|
|
1546
|
+
return pulumi.get(self, "ssl_check_domain")
|
|
1547
|
+
|
|
1548
|
+
@property
|
|
1549
|
+
@pulumi.getter
|
|
1550
|
+
def tags(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
|
1551
|
+
"""
|
|
1552
|
+
A list of tags for organizing and filtering checks.
|
|
1553
|
+
"""
|
|
1554
|
+
return pulumi.get(self, "tags")
|
|
1555
|
+
|
|
1556
|
+
@property
|
|
1557
|
+
@pulumi.getter(name="teardownSnippetId")
|
|
1558
|
+
def teardown_snippet_id(self) -> pulumi.Output[Optional[int]]:
|
|
1559
|
+
"""
|
|
1560
|
+
An ID reference to a snippet to use in the teardown phase of an API check.
|
|
1561
|
+
"""
|
|
1562
|
+
return pulumi.get(self, "teardown_snippet_id")
|
|
1563
|
+
|
|
1564
|
+
@property
|
|
1565
|
+
@pulumi.getter
|
|
1566
|
+
def type(self) -> pulumi.Output[str]:
|
|
1567
|
+
"""
|
|
1568
|
+
The type of the check. Possible values are `API`, `BROWSER`, and `MULTI_STEP`.
|
|
1569
|
+
"""
|
|
1570
|
+
return pulumi.get(self, "type")
|
|
1571
|
+
|
|
1572
|
+
@property
|
|
1573
|
+
@pulumi.getter(name="useGlobalAlertSettings")
|
|
1574
|
+
def use_global_alert_settings(self) -> pulumi.Output[Optional[bool]]:
|
|
1575
|
+
"""
|
|
1576
|
+
When true, the account level alert settings will be used, not the alert setting defined on this check.
|
|
1577
|
+
"""
|
|
1578
|
+
return pulumi.get(self, "use_global_alert_settings")
|
|
1579
|
+
|