@checkly/pulumi 1.1.4 → 2.0.0-alpha.1738673134

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.
Files changed (55) hide show
  1. package/LICENSE +202 -21
  2. package/README.md +39 -137
  3. package/alertChannel.d.ts +44 -20
  4. package/alertChannel.js +41 -19
  5. package/alertChannel.js.map +1 -1
  6. package/check.d.ts +101 -61
  7. package/check.js +8 -0
  8. package/check.js.map +1 -1
  9. package/checkGroup.d.ts +56 -104
  10. package/checkGroup.js +8 -87
  11. package/checkGroup.js.map +1 -1
  12. package/dashboard.d.ts +29 -9
  13. package/dashboard.js +12 -6
  14. package/dashboard.js.map +1 -1
  15. package/environmentVariable.d.ts +5 -2
  16. package/environmentVariable.js +4 -2
  17. package/environmentVariable.js.map +1 -1
  18. package/getStaticIps.d.ts +50 -0
  19. package/getStaticIps.js +26 -0
  20. package/getStaticIps.js.map +1 -0
  21. package/heartbeatCheck.d.ts +129 -0
  22. package/heartbeatCheck.js +91 -0
  23. package/heartbeatCheck.js.map +1 -0
  24. package/index.d.ts +42 -11
  25. package/index.js +47 -50
  26. package/index.js.map +1 -1
  27. package/maintenanceWindow.d.ts +5 -4
  28. package/maintenanceWindow.js +5 -4
  29. package/maintenanceWindow.js.map +1 -1
  30. package/package.json +7 -7
  31. package/privateLocation.d.ts +2 -2
  32. package/privateLocation.js +4 -2
  33. package/privateLocation.js.map +1 -1
  34. package/provider.js +1 -1
  35. package/provider.js.map +1 -1
  36. package/snippet.d.ts +20 -0
  37. package/snippet.js +20 -0
  38. package/snippet.js.map +1 -1
  39. package/tcpCheck.d.ts +342 -0
  40. package/tcpCheck.js +169 -0
  41. package/tcpCheck.js.map +1 -0
  42. package/triggerCheck.d.ts +2 -2
  43. package/triggerCheck.js +2 -2
  44. package/triggerCheckGroup.d.ts +2 -2
  45. package/triggerCheckGroup.js +2 -2
  46. package/types/index.js.map +1 -1
  47. package/types/input.d.ts +377 -7
  48. package/types/input.js.map +1 -1
  49. package/types/output.d.ts +383 -13
  50. package/types/output.js.map +1 -1
  51. package/utilities.d.ts +4 -0
  52. package/utilities.js +45 -1
  53. package/utilities.js.map +1 -1
  54. package/package.json.bak +0 -29
  55. package/scripts/install-pulumi-plugin.js +0 -26
@@ -4,9 +4,9 @@ import * as pulumi from "@pulumi/pulumi";
4
4
  *
5
5
  * ```typescript
6
6
  * import * as pulumi from "@pulumi/pulumi";
7
- * import * as pulumi from "@checkly/pulumi";
7
+ * import * as checkly from "@checkly/pulumi";
8
8
  *
9
- * const testTriggerGroup = new checkly.TriggerCheckGroup("testTriggerGroup", {groupId: "215"});
9
+ * const testTriggerGroup = new checkly.TriggerCheckGroup("test_trigger_group", {groupId: 215});
10
10
  * export const testTriggerGroupUrl = testTriggerGroup.url;
11
11
  * ```
12
12
  */
@@ -10,9 +10,9 @@ const utilities = require("./utilities");
10
10
  *
11
11
  * ```typescript
12
12
  * import * as pulumi from "@pulumi/pulumi";
13
- * import * as pulumi from "@checkly/pulumi";
13
+ * import * as checkly from "@checkly/pulumi";
14
14
  *
15
- * const testTriggerGroup = new checkly.TriggerCheckGroup("testTriggerGroup", {groupId: "215"});
15
+ * const testTriggerGroup = new checkly.TriggerCheckGroup("test_trigger_group", {groupId: 215});
16
16
  * export const testTriggerGroupUrl = testTriggerGroup.url;
17
17
  * ```
18
18
  */
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,sBAAsB;AACtB,iCAAiC;AAI7B,sBAAK;AAHT,mCAAmC;AAI/B,wBAAM"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAIjF,sBAAsB;AACtB,iCAAiC;AAI7B,sBAAK;AAHT,mCAAmC;AAI/B,wBAAM"}
package/types/input.d.ts CHANGED
@@ -1,6 +1,19 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
- import { input as inputs } from "../types";
2
+ import * as inputs from "../types/input";
3
+ export interface AlertChannelCall {
4
+ /**
5
+ * The name of this alert channel
6
+ */
7
+ name: pulumi.Input<string>;
8
+ /**
9
+ * The mobile number to receive the alerts
10
+ */
11
+ number: pulumi.Input<string>;
12
+ }
3
13
  export interface AlertChannelEmail {
14
+ /**
15
+ * The email address of this email alert channel.
16
+ */
4
17
  address: pulumi.Input<string>;
5
18
  }
6
19
  export interface AlertChannelOpsgenie {
@@ -15,32 +28,55 @@ export interface AlertChannelPagerduty {
15
28
  serviceName?: pulumi.Input<string>;
16
29
  }
17
30
  export interface AlertChannelSlack {
31
+ /**
32
+ * The name of the alert's Slack channel
33
+ */
18
34
  channel: pulumi.Input<string>;
35
+ /**
36
+ * The Slack webhook URL
37
+ */
19
38
  url: pulumi.Input<string>;
20
39
  }
21
40
  export interface AlertChannelSms {
41
+ /**
42
+ * The name of this alert channel
43
+ */
22
44
  name: pulumi.Input<string>;
45
+ /**
46
+ * The mobile number to receive the alerts
47
+ */
23
48
  number: pulumi.Input<string>;
24
49
  }
25
50
  export interface AlertChannelWebhook {
26
51
  headers?: pulumi.Input<{
27
- [key: string]: any;
52
+ [key: string]: pulumi.Input<string>;
28
53
  }>;
54
+ /**
55
+ * (Default `POST`)
56
+ */
29
57
  method?: pulumi.Input<string>;
30
58
  name: pulumi.Input<string>;
31
59
  queryParameters?: pulumi.Input<{
32
- [key: string]: any;
60
+ [key: string]: pulumi.Input<string>;
33
61
  }>;
34
62
  template?: pulumi.Input<string>;
35
63
  url: pulumi.Input<string>;
36
64
  webhookSecret?: pulumi.Input<string>;
65
+ /**
66
+ * Type of the webhook. Possible values are 'WEBHOOK*DISCORD', 'WEBHOOK*FIREHYDRANT', 'WEBHOOK*GITLAB*ALERT', 'WEBHOOK*SPIKESH', 'WEBHOOK*SPLUNK', 'WEBHOOK*MSTEAMS' and 'WEBHOOK*TELEGRAM'.
67
+ */
68
+ webhookType?: pulumi.Input<string>;
37
69
  }
38
70
  export interface CheckAlertChannelSubscription {
39
71
  activated: pulumi.Input<boolean>;
40
72
  channelId: pulumi.Input<number>;
41
73
  }
42
74
  export interface CheckAlertSettings {
75
+ /**
76
+ * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
77
+ */
43
78
  escalationType?: pulumi.Input<string>;
79
+ parallelRunFailureThresholds?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsParallelRunFailureThreshold>[]>;
44
80
  reminders?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsReminder>[]>;
45
81
  runBasedEscalations?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsRunBasedEscalation>[]>;
46
82
  /**
@@ -49,26 +85,64 @@ export interface CheckAlertSettings {
49
85
  sslCertificates?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsSslCertificate>[]>;
50
86
  timeBasedEscalations?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsTimeBasedEscalation>[]>;
51
87
  }
88
+ export interface CheckAlertSettingsParallelRunFailureThreshold {
89
+ /**
90
+ * Applicable only for checks scheduled in parallel in multiple locations.
91
+ */
92
+ enabled?: pulumi.Input<boolean>;
93
+ /**
94
+ * Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `100`, and `100`. (Default `10`).
95
+ */
96
+ percentage?: pulumi.Input<number>;
97
+ }
52
98
  export interface CheckAlertSettingsReminder {
99
+ /**
100
+ * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
101
+ */
53
102
  amount?: pulumi.Input<number>;
103
+ /**
104
+ * Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
105
+ */
54
106
  interval?: pulumi.Input<number>;
55
107
  }
56
108
  export interface CheckAlertSettingsRunBasedEscalation {
109
+ /**
110
+ * After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default `1`).
111
+ */
57
112
  failedRunThreshold?: pulumi.Input<number>;
58
113
  }
59
114
  export interface CheckAlertSettingsSslCertificate {
115
+ /**
116
+ * How long before SSL certificate expiry to send alerts. Possible values `3`, `7`, `14`, `30`. (Default `3`).
117
+ */
60
118
  alertThreshold?: pulumi.Input<number>;
119
+ /**
120
+ * Determines if alert notifications should be sent for expiring SSL certificates. Possible values `true`, and `false`. (Default `false`).
121
+ */
61
122
  enabled?: pulumi.Input<boolean>;
62
123
  }
63
124
  export interface CheckAlertSettingsTimeBasedEscalation {
125
+ /**
126
+ * After how many minutes after a check starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
127
+ */
64
128
  minutesFailingThreshold?: pulumi.Input<number>;
65
129
  }
130
+ export interface CheckEnvironmentVariable {
131
+ key: pulumi.Input<string>;
132
+ locked?: pulumi.Input<boolean>;
133
+ secret?: pulumi.Input<boolean>;
134
+ value: pulumi.Input<string>;
135
+ }
66
136
  export interface CheckGroupAlertChannelSubscription {
67
137
  activated: pulumi.Input<boolean>;
68
138
  channelId: pulumi.Input<number>;
69
139
  }
70
140
  export interface CheckGroupAlertSettings {
141
+ /**
142
+ * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
143
+ */
71
144
  escalationType?: pulumi.Input<string>;
145
+ parallelRunFailureThresholds?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsParallelRunFailureThreshold>[]>;
72
146
  reminders?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsReminder>[]>;
73
147
  runBasedEscalations?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsRunBasedEscalation>[]>;
74
148
  /**
@@ -77,29 +151,60 @@ export interface CheckGroupAlertSettings {
77
151
  sslCertificates?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsSslCertificate>[]>;
78
152
  timeBasedEscalations?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsTimeBasedEscalation>[]>;
79
153
  }
154
+ export interface CheckGroupAlertSettingsParallelRunFailureThreshold {
155
+ /**
156
+ * Applicable only for checks scheduled in parallel in multiple locations.
157
+ */
158
+ enabled?: pulumi.Input<boolean>;
159
+ /**
160
+ * Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `100`, and `100`. (Default `10`).
161
+ */
162
+ percentage?: pulumi.Input<number>;
163
+ }
80
164
  export interface CheckGroupAlertSettingsReminder {
165
+ /**
166
+ * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
167
+ */
81
168
  amount?: pulumi.Input<number>;
169
+ /**
170
+ * Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
171
+ */
82
172
  interval?: pulumi.Input<number>;
83
173
  }
84
174
  export interface CheckGroupAlertSettingsRunBasedEscalation {
175
+ /**
176
+ * After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default `1`).
177
+ */
85
178
  failedRunThreshold?: pulumi.Input<number>;
86
179
  }
87
180
  export interface CheckGroupAlertSettingsSslCertificate {
181
+ /**
182
+ * At what moment in time to start alerting on SSL certificates. Possible values `3`, `7`, `14`, `30`. (Default `3`).
183
+ */
88
184
  alertThreshold?: pulumi.Input<number>;
185
+ /**
186
+ * Determines if alert notifications should be sent for expiring SSL certificates.
187
+ */
89
188
  enabled?: pulumi.Input<boolean>;
90
189
  }
91
190
  export interface CheckGroupAlertSettingsTimeBasedEscalation {
191
+ /**
192
+ * After how many minutes after a check starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
193
+ */
92
194
  minutesFailingThreshold?: pulumi.Input<number>;
93
195
  }
94
196
  export interface CheckGroupApiCheckDefaults {
95
197
  assertions?: pulumi.Input<pulumi.Input<inputs.CheckGroupApiCheckDefaultsAssertion>[]>;
96
198
  basicAuth?: pulumi.Input<inputs.CheckGroupApiCheckDefaultsBasicAuth>;
97
199
  headers?: pulumi.Input<{
98
- [key: string]: any;
200
+ [key: string]: pulumi.Input<string>;
99
201
  }>;
100
202
  queryParameters?: pulumi.Input<{
101
- [key: string]: any;
203
+ [key: string]: pulumi.Input<string>;
102
204
  }>;
205
+ /**
206
+ * The base url for this group which you can reference with the `GROUP_BASE_URL` variable in all group checks.
207
+ */
103
208
  url?: pulumi.Input<string>;
104
209
  }
105
210
  /**
@@ -107,8 +212,14 @@ export interface CheckGroupApiCheckDefaults {
107
212
  */
108
213
  export declare function checkGroupApiCheckDefaultsProvideDefaults(val: CheckGroupApiCheckDefaults): CheckGroupApiCheckDefaults;
109
214
  export interface CheckGroupApiCheckDefaultsAssertion {
215
+ /**
216
+ * The type of comparison to be executed between expected and actual value of the assertion. Possible values `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
217
+ */
110
218
  comparison: pulumi.Input<string>;
111
219
  property?: pulumi.Input<string>;
220
+ /**
221
+ * The source of the asserted value. Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
222
+ */
112
223
  source: pulumi.Input<string>;
113
224
  target: pulumi.Input<string>;
114
225
  }
@@ -116,25 +227,78 @@ export interface CheckGroupApiCheckDefaultsBasicAuth {
116
227
  password: pulumi.Input<string>;
117
228
  username: pulumi.Input<string>;
118
229
  }
230
+ export interface CheckGroupEnvironmentVariable {
231
+ key: pulumi.Input<string>;
232
+ locked?: pulumi.Input<boolean>;
233
+ secret?: pulumi.Input<boolean>;
234
+ value: pulumi.Input<string>;
235
+ }
236
+ export interface CheckGroupRetryStrategy {
237
+ /**
238
+ * The number of seconds to wait before the first retry attempt.
239
+ */
240
+ baseBackoffSeconds?: pulumi.Input<number>;
241
+ /**
242
+ * The total amount of time to continue retrying the check (maximum 600 seconds).
243
+ */
244
+ maxDurationSeconds?: pulumi.Input<number>;
245
+ /**
246
+ * The maximum number of times to retry the check. Value must be between 1 and 10.
247
+ */
248
+ maxRetries?: pulumi.Input<number>;
249
+ /**
250
+ * Whether retries should be run in the same region as the initial check run.
251
+ */
252
+ sameRegion?: pulumi.Input<boolean>;
253
+ /**
254
+ * Determines which type of retry strategy to use. Possible values are `FIXED`, `LINEAR`, or `EXPONENTIAL`.
255
+ */
256
+ type: pulumi.Input<string>;
257
+ }
119
258
  export interface CheckRequest {
259
+ /**
260
+ * A request can have multiple assertions.
261
+ */
120
262
  assertions?: pulumi.Input<pulumi.Input<inputs.CheckRequestAssertion>[]>;
263
+ /**
264
+ * Set up HTTP basic authentication (username & password).
265
+ */
121
266
  basicAuth?: pulumi.Input<inputs.CheckRequestBasicAuth>;
267
+ /**
268
+ * The body of the request.
269
+ */
122
270
  body?: pulumi.Input<string>;
271
+ /**
272
+ * The `Content-Type` header of the request. Possible values `NONE`, `JSON`, `FORM`, `RAW`, and `GRAPHQL`.
273
+ */
123
274
  bodyType?: pulumi.Input<string>;
124
275
  followRedirects?: pulumi.Input<boolean>;
125
276
  headers?: pulumi.Input<{
126
- [key: string]: any;
277
+ [key: string]: pulumi.Input<string>;
127
278
  }>;
279
+ /**
280
+ * IP Family to be used when executing the api check. The value can be either IPv4 or IPv6.
281
+ */
282
+ ipFamily?: pulumi.Input<string>;
283
+ /**
284
+ * The HTTP method to use for this API check. Possible values are `GET`, `POST`, `PUT`, `HEAD`, `DELETE`, `PATCH`. (Default `GET`).
285
+ */
128
286
  method?: pulumi.Input<string>;
129
287
  queryParameters?: pulumi.Input<{
130
- [key: string]: any;
288
+ [key: string]: pulumi.Input<string>;
131
289
  }>;
132
290
  skipSsl?: pulumi.Input<boolean>;
133
291
  url: pulumi.Input<string>;
134
292
  }
135
293
  export interface CheckRequestAssertion {
294
+ /**
295
+ * The type of comparison to be executed between expected and actual value of the assertion. Possible values `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
296
+ */
136
297
  comparison: pulumi.Input<string>;
137
298
  property?: pulumi.Input<string>;
299
+ /**
300
+ * The source of the asserted value. Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
301
+ */
138
302
  source: pulumi.Input<string>;
139
303
  target?: pulumi.Input<string>;
140
304
  }
@@ -142,3 +306,209 @@ export interface CheckRequestBasicAuth {
142
306
  password: pulumi.Input<string>;
143
307
  username: pulumi.Input<string>;
144
308
  }
309
+ export interface CheckRetryStrategy {
310
+ /**
311
+ * The number of seconds to wait before the first retry attempt.
312
+ */
313
+ baseBackoffSeconds?: pulumi.Input<number>;
314
+ /**
315
+ * The total amount of time to continue retrying the check (maximum 600 seconds).
316
+ */
317
+ maxDurationSeconds?: pulumi.Input<number>;
318
+ /**
319
+ * The maximum number of times to retry the check. Value must be between 1 and 10.
320
+ */
321
+ maxRetries?: pulumi.Input<number>;
322
+ /**
323
+ * Whether retries should be run in the same region as the initial check run.
324
+ */
325
+ sameRegion?: pulumi.Input<boolean>;
326
+ /**
327
+ * Determines which type of retry strategy to use. Possible values are `FIXED`, `LINEAR`, or `EXPONENTIAL`.
328
+ */
329
+ type: pulumi.Input<string>;
330
+ }
331
+ export interface HeartbeatCheckAlertChannelSubscription {
332
+ activated: pulumi.Input<boolean>;
333
+ channelId: pulumi.Input<number>;
334
+ }
335
+ export interface HeartbeatCheckAlertSettings {
336
+ /**
337
+ * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
338
+ */
339
+ escalationType?: pulumi.Input<string>;
340
+ parallelRunFailureThresholds?: pulumi.Input<pulumi.Input<inputs.HeartbeatCheckAlertSettingsParallelRunFailureThreshold>[]>;
341
+ reminders?: pulumi.Input<pulumi.Input<inputs.HeartbeatCheckAlertSettingsReminder>[]>;
342
+ runBasedEscalations?: pulumi.Input<pulumi.Input<inputs.HeartbeatCheckAlertSettingsRunBasedEscalation>[]>;
343
+ /**
344
+ * @deprecated This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
345
+ */
346
+ sslCertificates?: pulumi.Input<pulumi.Input<inputs.HeartbeatCheckAlertSettingsSslCertificate>[]>;
347
+ timeBasedEscalations?: pulumi.Input<pulumi.Input<inputs.HeartbeatCheckAlertSettingsTimeBasedEscalation>[]>;
348
+ }
349
+ export interface HeartbeatCheckAlertSettingsParallelRunFailureThreshold {
350
+ /**
351
+ * Applicable only for checks scheduled in parallel in multiple locations.
352
+ */
353
+ enabled?: pulumi.Input<boolean>;
354
+ /**
355
+ * Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `100`, and `100`. (Default `10`).
356
+ */
357
+ percentage?: pulumi.Input<number>;
358
+ }
359
+ export interface HeartbeatCheckAlertSettingsReminder {
360
+ /**
361
+ * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
362
+ */
363
+ amount?: pulumi.Input<number>;
364
+ /**
365
+ * Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
366
+ */
367
+ interval?: pulumi.Input<number>;
368
+ }
369
+ export interface HeartbeatCheckAlertSettingsRunBasedEscalation {
370
+ /**
371
+ * After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default `1`).
372
+ */
373
+ failedRunThreshold?: pulumi.Input<number>;
374
+ }
375
+ export interface HeartbeatCheckAlertSettingsSslCertificate {
376
+ /**
377
+ * How long before SSL certificate expiry to send alerts. Possible values `3`, `7`, `14`, `30`. (Default `3`).
378
+ */
379
+ alertThreshold?: pulumi.Input<number>;
380
+ /**
381
+ * Determines if alert notifications should be sent for expiring SSL certificates. Possible values `true`, and `false`. (Default `false`).
382
+ */
383
+ enabled?: pulumi.Input<boolean>;
384
+ }
385
+ export interface HeartbeatCheckAlertSettingsTimeBasedEscalation {
386
+ /**
387
+ * After how many minutes after a check starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
388
+ */
389
+ minutesFailingThreshold?: pulumi.Input<number>;
390
+ }
391
+ export interface HeartbeatCheckHeartbeat {
392
+ /**
393
+ * How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
394
+ */
395
+ grace: pulumi.Input<number>;
396
+ /**
397
+ * Possible values `seconds`, `minutes`, `hours` and `days`.
398
+ */
399
+ graceUnit: pulumi.Input<string>;
400
+ /**
401
+ * How often you expect a ping to the ping URL.
402
+ */
403
+ period: pulumi.Input<number>;
404
+ /**
405
+ * Possible values `seconds`, `minutes`, `hours` and `days`.
406
+ */
407
+ periodUnit: pulumi.Input<string>;
408
+ /**
409
+ * Custom token to generate your ping URL. Checkly will expect a ping to `https://ping.checklyhq.com/[PING_TOKEN]`.
410
+ */
411
+ pingToken?: pulumi.Input<string>;
412
+ }
413
+ export interface TcpCheckAlertChannelSubscription {
414
+ activated: pulumi.Input<boolean>;
415
+ channelId: pulumi.Input<number>;
416
+ }
417
+ export interface TcpCheckAlertSettings {
418
+ /**
419
+ * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
420
+ */
421
+ escalationType?: pulumi.Input<string>;
422
+ parallelRunFailureThresholds?: pulumi.Input<pulumi.Input<inputs.TcpCheckAlertSettingsParallelRunFailureThreshold>[]>;
423
+ reminders?: pulumi.Input<pulumi.Input<inputs.TcpCheckAlertSettingsReminder>[]>;
424
+ runBasedEscalations?: pulumi.Input<pulumi.Input<inputs.TcpCheckAlertSettingsRunBasedEscalation>[]>;
425
+ timeBasedEscalations?: pulumi.Input<pulumi.Input<inputs.TcpCheckAlertSettingsTimeBasedEscalation>[]>;
426
+ }
427
+ export interface TcpCheckAlertSettingsParallelRunFailureThreshold {
428
+ /**
429
+ * Applicable only for checks scheduled in parallel in multiple locations.
430
+ */
431
+ enabled?: pulumi.Input<boolean>;
432
+ /**
433
+ * Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `100`, and `100`. (Default `10`).
434
+ */
435
+ percentage?: pulumi.Input<number>;
436
+ }
437
+ export interface TcpCheckAlertSettingsReminder {
438
+ /**
439
+ * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
440
+ */
441
+ amount?: pulumi.Input<number>;
442
+ /**
443
+ * Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
444
+ */
445
+ interval?: pulumi.Input<number>;
446
+ }
447
+ export interface TcpCheckAlertSettingsRunBasedEscalation {
448
+ /**
449
+ * After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default `1`).
450
+ */
451
+ failedRunThreshold?: pulumi.Input<number>;
452
+ }
453
+ export interface TcpCheckAlertSettingsTimeBasedEscalation {
454
+ /**
455
+ * After how many minutes after a check starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
456
+ */
457
+ minutesFailingThreshold?: pulumi.Input<number>;
458
+ }
459
+ export interface TcpCheckRequest {
460
+ /**
461
+ * A request can have multiple assertions.
462
+ */
463
+ assertions?: pulumi.Input<pulumi.Input<inputs.TcpCheckRequestAssertion>[]>;
464
+ /**
465
+ * The data to send to the target host.
466
+ */
467
+ data?: pulumi.Input<string>;
468
+ /**
469
+ * The hostname or IP to connect to. Do not include a scheme or a port in this value.
470
+ */
471
+ hostname: pulumi.Input<string>;
472
+ /**
473
+ * The IP family to use when executing the TCP check. The value can be either `IPv4` or `IPv6`.
474
+ */
475
+ ipFamily?: pulumi.Input<string>;
476
+ /**
477
+ * The port number to connect to.
478
+ */
479
+ port: pulumi.Input<number>;
480
+ }
481
+ export interface TcpCheckRequestAssertion {
482
+ /**
483
+ * The type of comparison to be executed between expected and actual value of the assertion. Possible values are `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
484
+ */
485
+ comparison: pulumi.Input<string>;
486
+ property?: pulumi.Input<string>;
487
+ /**
488
+ * The source of the asserted value. Possible values are `RESPONSE_DATA` and `RESPONSE_TIME`.
489
+ */
490
+ source: pulumi.Input<string>;
491
+ target?: pulumi.Input<string>;
492
+ }
493
+ export interface TcpCheckRetryStrategy {
494
+ /**
495
+ * The number of seconds to wait before the first retry attempt.
496
+ */
497
+ baseBackoffSeconds?: pulumi.Input<number>;
498
+ /**
499
+ * The total amount of time to continue retrying the check (maximum 600 seconds).
500
+ */
501
+ maxDurationSeconds?: pulumi.Input<number>;
502
+ /**
503
+ * The maximum number of times to retry the check. Value must be between 1 and 10.
504
+ */
505
+ maxRetries?: pulumi.Input<number>;
506
+ /**
507
+ * Whether retries should be run in the same region as the initial check run.
508
+ */
509
+ sameRegion?: pulumi.Input<boolean>;
510
+ /**
511
+ * Determines which type of retry strategy to use. Possible values are `FIXED`, `LINEAR`, or `EXPONENTIAL`.
512
+ */
513
+ type: pulumi.Input<string>;
514
+ }
@@ -1 +1 @@
1
- {"version":3,"file":"input.js","sourceRoot":"","sources":["../../types/input.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAuHjF;;GAEG;AACH,SAAgB,yCAAyC,CAAC,GAA+B;;IACrF,uCACO,GAAG,KACN,GAAG,EAAE,MAAA,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,EAAE,IACtB;AACN,CAAC;AALD,8FAKC"}
1
+ {"version":3,"file":"input.js","sourceRoot":"","sources":["../../types/input.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAqOjF;;GAEG;AACH,SAAgB,yCAAyC,CAAC,GAA+B;;IACrF,uCACO,GAAG,KACN,GAAG,EAAE,MAAA,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,EAAE,IACtB;AACN,CAAC;AALD,8FAKC"}