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