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