@checkly/pulumi 0.0.1-alpha.2 → 0.0.1-alpha.6

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 (60) hide show
  1. package/README.md +70 -44
  2. package/alertChannel.ts +56 -141
  3. package/bin/README.md +102 -41
  4. package/bin/alertChannel.d.ts +55 -138
  5. package/bin/alertChannel.js +41 -108
  6. package/bin/alertChannel.js.map +1 -1
  7. package/bin/check.d.ts +90 -51
  8. package/bin/check.js +4 -3
  9. package/bin/check.js.map +1 -1
  10. package/bin/checkGroup.d.ts +112 -36
  11. package/bin/checkGroup.js +89 -3
  12. package/bin/checkGroup.js.map +1 -1
  13. package/bin/dashboard.d.ts +125 -14
  14. package/bin/dashboard.js +22 -24
  15. package/bin/dashboard.js.map +1 -1
  16. package/bin/environmentVariable.d.ts +64 -0
  17. package/bin/environmentVariable.js +78 -0
  18. package/bin/environmentVariable.js.map +1 -0
  19. package/bin/index.d.ts +1 -0
  20. package/bin/index.js +5 -0
  21. package/bin/index.js.map +1 -1
  22. package/bin/maintenanceWindow.d.ts +16 -36
  23. package/bin/maintenanceWindow.js +2 -33
  24. package/bin/maintenanceWindow.js.map +1 -1
  25. package/bin/package.json +4 -3
  26. package/bin/package.json.bak +2 -1
  27. package/bin/provider.js +1 -3
  28. package/bin/provider.js.map +1 -1
  29. package/bin/snippet.d.ts +3 -3
  30. package/bin/snippet.js +1 -3
  31. package/bin/snippet.js.map +1 -1
  32. package/bin/triggerCheck.d.ts +19 -7
  33. package/bin/triggerCheck.js +2 -10
  34. package/bin/triggerCheck.js.map +1 -1
  35. package/bin/triggerCheckGroup.d.ts +19 -7
  36. package/bin/triggerCheckGroup.js +2 -10
  37. package/bin/triggerCheckGroup.js.map +1 -1
  38. package/bin/types/input.d.ts +2 -188
  39. package/bin/types/input.js.map +1 -1
  40. package/bin/types/output.d.ts +2 -188
  41. package/bin/types/output.js.map +1 -1
  42. package/bin/utilities.js +6 -1
  43. package/bin/utilities.js.map +1 -1
  44. package/bin/yarn.lock +179 -117
  45. package/check.ts +91 -54
  46. package/checkGroup.ts +113 -39
  47. package/dashboard.ts +126 -38
  48. package/environmentVariable.ts +107 -0
  49. package/index.ts +5 -0
  50. package/maintenanceWindow.ts +17 -48
  51. package/package.json +7 -6
  52. package/provider.ts +1 -3
  53. package/scripts/install-pulumi-plugin.js +26 -0
  54. package/snippet.ts +4 -6
  55. package/triggerCheck.ts +20 -10
  56. package/triggerCheckGroup.ts +20 -10
  57. package/tsconfig.json +1 -0
  58. package/types/input.ts +2 -188
  59. package/types/output.ts +2 -188
  60. package/utilities.ts +5 -0
package/check.ts CHANGED
@@ -5,6 +5,9 @@ import * as pulumi from "@pulumi/pulumi";
5
5
  import { input as inputs, output as outputs } from "./types";
6
6
  import * as utilities from "./utilities";
7
7
 
8
+ /**
9
+ * 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.
10
+ */
8
11
  export class Check extends pulumi.CustomResource {
9
12
  /**
10
13
  * Get an existing Check resource's state with the given name, ID, and optional extra
@@ -38,20 +41,20 @@ export class Check extends pulumi.CustomResource {
38
41
  */
39
42
  public readonly activated!: pulumi.Output<boolean>;
40
43
  public readonly alertChannelSubscriptions!: pulumi.Output<outputs.CheckAlertChannelSubscription[] | undefined>;
41
- /**
42
- * . Supported values documented below.
43
- */
44
44
  public readonly alertSettings!: pulumi.Output<outputs.CheckAlertSettings>;
45
45
  /**
46
- * The response time in milliseconds where a check should be considered degraded. Possible values are between 0 and 30000. Defaults to `15000`.
46
+ * The response time in milliseconds starting from which a check should be considered degraded. Possible values are between
47
+ * 0 and 30000. (Default `15000`).
47
48
  */
48
49
  public readonly degradedResponseTime!: pulumi.Output<number | undefined>;
49
50
  /**
50
- * 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. Possible values `true`, and `false`.
51
+ * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
52
+ * region before marking the check as failed.
51
53
  */
52
54
  public readonly doubleCheck!: pulumi.Output<boolean | undefined>;
53
55
  /**
54
- * Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
56
+ * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
57
+ * Use global environment variables whenever possible.
55
58
  */
56
59
  public readonly environmentVariables!: pulumi.Output<{[key: string]: any} | undefined>;
57
60
  /**
@@ -59,15 +62,17 @@ export class Check extends pulumi.CustomResource {
59
62
  */
60
63
  public readonly frequency!: pulumi.Output<number>;
61
64
  /**
62
- * This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequencyOffset` could be `10`, `20` or `30`.
65
+ * This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must
66
+ * be `0` and `frequency_offset` could be `10`, `20` or `30`.
63
67
  */
64
68
  public readonly frequencyOffset!: pulumi.Output<number | undefined>;
65
69
  /**
66
- * . The id of the check group this check is part of.
70
+ * The id of the check group this check is part of.
67
71
  */
68
72
  public readonly groupId!: pulumi.Output<number | undefined>;
69
73
  /**
70
- * 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.
74
+ * The position of this check in a check group. It determines in what order checks are run when a group is triggered from
75
+ * the API or from CI/CD.
71
76
  */
72
77
  public readonly groupOrder!: pulumi.Output<number | undefined>;
73
78
  /**
@@ -79,15 +84,16 @@ export class Check extends pulumi.CustomResource {
79
84
  */
80
85
  public readonly localTeardownScript!: pulumi.Output<string | undefined>;
81
86
  /**
82
- * An array of one or more data center locations where to run the this check. Defaults to["us-east-1"].
87
+ * An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
83
88
  */
84
89
  public readonly locations!: pulumi.Output<string[] | undefined>;
85
90
  /**
86
- * The response time in milliseconds where a check should be considered failing. Possible values are between 0 and 30000. Defaults to `30000`.
91
+ * The response time in milliseconds starting from which a check should be considered failing. Possible values are between
92
+ * 0 and 30000. (Default `30000`).
87
93
  */
88
94
  public readonly maxResponseTime!: pulumi.Output<number | undefined>;
89
95
  /**
90
- * Determines if any notifications will be sent out when a check fails and/or recovers. Possible values `true`, and `false`.
96
+ * Determines if any notifications will be sent out when a check fails/degrades/recovers.
91
97
  */
92
98
  public readonly muted!: pulumi.Output<boolean | undefined>;
93
99
  /**
@@ -95,26 +101,35 @@ export class Check extends pulumi.CustomResource {
95
101
  */
96
102
  public readonly name!: pulumi.Output<string>;
97
103
  /**
98
- * . An API check might have one request config. Supported values documented below.
104
+ * An API check might have one request config.
99
105
  */
100
106
  public readonly request!: pulumi.Output<outputs.CheckRequest | undefined>;
101
107
  /**
102
- * . The id of the runtime to use for this check.
108
+ * The id of the runtime to use for this check.
103
109
  */
104
110
  public readonly runtimeId!: pulumi.Output<string | undefined>;
111
+ /**
112
+ * A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a
113
+ * reference to an external JavaScript file.
114
+ */
105
115
  public readonly script!: pulumi.Output<string | undefined>;
106
116
  /**
107
117
  * An ID reference to a snippet to use in the setup phase of an API check.
108
118
  */
109
119
  public readonly setupSnippetId!: pulumi.Output<number | undefined>;
110
120
  /**
111
- * Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404. Possible values `true`, and `false`.
121
+ * Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
112
122
  */
113
123
  public readonly shouldFail!: pulumi.Output<boolean | undefined>;
114
124
  /**
115
- * Determines if the SSL certificate should be validated for expiry. Possible values `true`, and `false`.
125
+ * Determines if the SSL certificate should be validated for expiry.
126
+ *
127
+ * @deprecated The property `ssl_check` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
116
128
  */
117
129
  public readonly sslCheck!: pulumi.Output<boolean | undefined>;
130
+ /**
131
+ * A list of tags for organizing and filtering checks.
132
+ */
118
133
  public readonly tags!: pulumi.Output<string[] | undefined>;
119
134
  /**
120
135
  * An ID reference to a snippet to use in the teardown phase of an API check.
@@ -125,7 +140,7 @@ export class Check extends pulumi.CustomResource {
125
140
  */
126
141
  public readonly type!: pulumi.Output<string>;
127
142
  /**
128
- * When true, the account level alert setting will be used, not the alert setting defined on this check. Possible values `true`, and `false`.
143
+ * When true, the account level alert settings will be used, not the alert setting defined on this check.
129
144
  */
130
145
  public readonly useGlobalAlertSettings!: pulumi.Output<boolean | undefined>;
131
146
 
@@ -206,9 +221,7 @@ export class Check extends pulumi.CustomResource {
206
221
  resourceInputs["type"] = args ? args.type : undefined;
207
222
  resourceInputs["useGlobalAlertSettings"] = args ? args.useGlobalAlertSettings : undefined;
208
223
  }
209
- if (!opts.version) {
210
- opts = pulumi.mergeOptions(opts, { version: utilities.getVersion()});
211
- }
224
+ opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
212
225
  super(Check.__pulumiType, name, resourceInputs, opts);
213
226
  }
214
227
  }
@@ -222,20 +235,20 @@ export interface CheckState {
222
235
  */
223
236
  activated?: pulumi.Input<boolean>;
224
237
  alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckAlertChannelSubscription>[]>;
225
- /**
226
- * . Supported values documented below.
227
- */
228
238
  alertSettings?: pulumi.Input<inputs.CheckAlertSettings>;
229
239
  /**
230
- * The response time in milliseconds where a check should be considered degraded. Possible values are between 0 and 30000. Defaults to `15000`.
240
+ * The response time in milliseconds starting from which a check should be considered degraded. Possible values are between
241
+ * 0 and 30000. (Default `15000`).
231
242
  */
232
243
  degradedResponseTime?: pulumi.Input<number>;
233
244
  /**
234
- * 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. Possible values `true`, and `false`.
245
+ * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
246
+ * region before marking the check as failed.
235
247
  */
236
248
  doubleCheck?: pulumi.Input<boolean>;
237
249
  /**
238
- * Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
250
+ * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
251
+ * Use global environment variables whenever possible.
239
252
  */
240
253
  environmentVariables?: pulumi.Input<{[key: string]: any}>;
241
254
  /**
@@ -243,15 +256,17 @@ export interface CheckState {
243
256
  */
244
257
  frequency?: pulumi.Input<number>;
245
258
  /**
246
- * This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequencyOffset` could be `10`, `20` or `30`.
259
+ * This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must
260
+ * be `0` and `frequency_offset` could be `10`, `20` or `30`.
247
261
  */
248
262
  frequencyOffset?: pulumi.Input<number>;
249
263
  /**
250
- * . The id of the check group this check is part of.
264
+ * The id of the check group this check is part of.
251
265
  */
252
266
  groupId?: pulumi.Input<number>;
253
267
  /**
254
- * 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.
268
+ * The position of this check in a check group. It determines in what order checks are run when a group is triggered from
269
+ * the API or from CI/CD.
255
270
  */
256
271
  groupOrder?: pulumi.Input<number>;
257
272
  /**
@@ -263,15 +278,16 @@ export interface CheckState {
263
278
  */
264
279
  localTeardownScript?: pulumi.Input<string>;
265
280
  /**
266
- * An array of one or more data center locations where to run the this check. Defaults to["us-east-1"].
281
+ * An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
267
282
  */
268
283
  locations?: pulumi.Input<pulumi.Input<string>[]>;
269
284
  /**
270
- * The response time in milliseconds where a check should be considered failing. Possible values are between 0 and 30000. Defaults to `30000`.
285
+ * The response time in milliseconds starting from which a check should be considered failing. Possible values are between
286
+ * 0 and 30000. (Default `30000`).
271
287
  */
272
288
  maxResponseTime?: pulumi.Input<number>;
273
289
  /**
274
- * Determines if any notifications will be sent out when a check fails and/or recovers. Possible values `true`, and `false`.
290
+ * Determines if any notifications will be sent out when a check fails/degrades/recovers.
275
291
  */
276
292
  muted?: pulumi.Input<boolean>;
277
293
  /**
@@ -279,26 +295,35 @@ export interface CheckState {
279
295
  */
280
296
  name?: pulumi.Input<string>;
281
297
  /**
282
- * . An API check might have one request config. Supported values documented below.
298
+ * An API check might have one request config.
283
299
  */
284
300
  request?: pulumi.Input<inputs.CheckRequest>;
285
301
  /**
286
- * . The id of the runtime to use for this check.
302
+ * The id of the runtime to use for this check.
287
303
  */
288
304
  runtimeId?: pulumi.Input<string>;
305
+ /**
306
+ * A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a
307
+ * reference to an external JavaScript file.
308
+ */
289
309
  script?: pulumi.Input<string>;
290
310
  /**
291
311
  * An ID reference to a snippet to use in the setup phase of an API check.
292
312
  */
293
313
  setupSnippetId?: pulumi.Input<number>;
294
314
  /**
295
- * Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404. Possible values `true`, and `false`.
315
+ * Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
296
316
  */
297
317
  shouldFail?: pulumi.Input<boolean>;
298
318
  /**
299
- * Determines if the SSL certificate should be validated for expiry. Possible values `true`, and `false`.
319
+ * Determines if the SSL certificate should be validated for expiry.
320
+ *
321
+ * @deprecated The property `ssl_check` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
300
322
  */
301
323
  sslCheck?: pulumi.Input<boolean>;
324
+ /**
325
+ * A list of tags for organizing and filtering checks.
326
+ */
302
327
  tags?: pulumi.Input<pulumi.Input<string>[]>;
303
328
  /**
304
329
  * An ID reference to a snippet to use in the teardown phase of an API check.
@@ -309,7 +334,7 @@ export interface CheckState {
309
334
  */
310
335
  type?: pulumi.Input<string>;
311
336
  /**
312
- * When true, the account level alert setting will be used, not the alert setting defined on this check. Possible values `true`, and `false`.
337
+ * When true, the account level alert settings will be used, not the alert setting defined on this check.
313
338
  */
314
339
  useGlobalAlertSettings?: pulumi.Input<boolean>;
315
340
  }
@@ -323,20 +348,20 @@ export interface CheckArgs {
323
348
  */
324
349
  activated: pulumi.Input<boolean>;
325
350
  alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckAlertChannelSubscription>[]>;
326
- /**
327
- * . Supported values documented below.
328
- */
329
351
  alertSettings?: pulumi.Input<inputs.CheckAlertSettings>;
330
352
  /**
331
- * The response time in milliseconds where a check should be considered degraded. Possible values are between 0 and 30000. Defaults to `15000`.
353
+ * The response time in milliseconds starting from which a check should be considered degraded. Possible values are between
354
+ * 0 and 30000. (Default `15000`).
332
355
  */
333
356
  degradedResponseTime?: pulumi.Input<number>;
334
357
  /**
335
- * 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. Possible values `true`, and `false`.
358
+ * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
359
+ * region before marking the check as failed.
336
360
  */
337
361
  doubleCheck?: pulumi.Input<boolean>;
338
362
  /**
339
- * Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
363
+ * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
364
+ * Use global environment variables whenever possible.
340
365
  */
341
366
  environmentVariables?: pulumi.Input<{[key: string]: any}>;
342
367
  /**
@@ -344,15 +369,17 @@ export interface CheckArgs {
344
369
  */
345
370
  frequency: pulumi.Input<number>;
346
371
  /**
347
- * This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequencyOffset` could be `10`, `20` or `30`.
372
+ * This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must
373
+ * be `0` and `frequency_offset` could be `10`, `20` or `30`.
348
374
  */
349
375
  frequencyOffset?: pulumi.Input<number>;
350
376
  /**
351
- * . The id of the check group this check is part of.
377
+ * The id of the check group this check is part of.
352
378
  */
353
379
  groupId?: pulumi.Input<number>;
354
380
  /**
355
- * 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.
381
+ * The position of this check in a check group. It determines in what order checks are run when a group is triggered from
382
+ * the API or from CI/CD.
356
383
  */
357
384
  groupOrder?: pulumi.Input<number>;
358
385
  /**
@@ -364,15 +391,16 @@ export interface CheckArgs {
364
391
  */
365
392
  localTeardownScript?: pulumi.Input<string>;
366
393
  /**
367
- * An array of one or more data center locations where to run the this check. Defaults to["us-east-1"].
394
+ * An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
368
395
  */
369
396
  locations?: pulumi.Input<pulumi.Input<string>[]>;
370
397
  /**
371
- * The response time in milliseconds where a check should be considered failing. Possible values are between 0 and 30000. Defaults to `30000`.
398
+ * The response time in milliseconds starting from which a check should be considered failing. Possible values are between
399
+ * 0 and 30000. (Default `30000`).
372
400
  */
373
401
  maxResponseTime?: pulumi.Input<number>;
374
402
  /**
375
- * Determines if any notifications will be sent out when a check fails and/or recovers. Possible values `true`, and `false`.
403
+ * Determines if any notifications will be sent out when a check fails/degrades/recovers.
376
404
  */
377
405
  muted?: pulumi.Input<boolean>;
378
406
  /**
@@ -380,26 +408,35 @@ export interface CheckArgs {
380
408
  */
381
409
  name?: pulumi.Input<string>;
382
410
  /**
383
- * . An API check might have one request config. Supported values documented below.
411
+ * An API check might have one request config.
384
412
  */
385
413
  request?: pulumi.Input<inputs.CheckRequest>;
386
414
  /**
387
- * . The id of the runtime to use for this check.
415
+ * The id of the runtime to use for this check.
388
416
  */
389
417
  runtimeId?: pulumi.Input<string>;
418
+ /**
419
+ * A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a
420
+ * reference to an external JavaScript file.
421
+ */
390
422
  script?: pulumi.Input<string>;
391
423
  /**
392
424
  * An ID reference to a snippet to use in the setup phase of an API check.
393
425
  */
394
426
  setupSnippetId?: pulumi.Input<number>;
395
427
  /**
396
- * Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404. Possible values `true`, and `false`.
428
+ * Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
397
429
  */
398
430
  shouldFail?: pulumi.Input<boolean>;
399
431
  /**
400
- * Determines if the SSL certificate should be validated for expiry. Possible values `true`, and `false`.
432
+ * Determines if the SSL certificate should be validated for expiry.
433
+ *
434
+ * @deprecated The property `ssl_check` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
401
435
  */
402
436
  sslCheck?: pulumi.Input<boolean>;
437
+ /**
438
+ * A list of tags for organizing and filtering checks.
439
+ */
403
440
  tags?: pulumi.Input<pulumi.Input<string>[]>;
404
441
  /**
405
442
  * An ID reference to a snippet to use in the teardown phase of an API check.
@@ -410,7 +447,7 @@ export interface CheckArgs {
410
447
  */
411
448
  type: pulumi.Input<string>;
412
449
  /**
413
- * When true, the account level alert setting will be used, not the alert setting defined on this check. Possible values `true`, and `false`.
450
+ * When true, the account level alert settings will be used, not the alert setting defined on this check.
414
451
  */
415
452
  useGlobalAlertSettings?: pulumi.Input<boolean>;
416
453
  }
package/checkGroup.ts CHANGED
@@ -5,6 +5,94 @@ import * as pulumi from "@pulumi/pulumi";
5
5
  import { input as inputs, output as outputs } from "./types";
6
6
  import * as utilities from "./utilities";
7
7
 
8
+ /**
9
+ * Check groups allow you to group together a set of related checks, which can also share default settings for various attributes.
10
+ *
11
+ * ## Example Usage
12
+ *
13
+ * ```typescript
14
+ * import * as pulumi from "@pulumi/pulumi";
15
+ * import * as pulumi from "@checkly/pulumi";
16
+ *
17
+ * const test_group1CheckGroup = new checkly.CheckGroup("test-group1CheckGroup", {
18
+ * activated: true,
19
+ * muted: false,
20
+ * tags: ["auto"],
21
+ * locations: ["eu-west-1"],
22
+ * concurrency: 3,
23
+ * apiCheckDefaults: {
24
+ * url: "http://example.com/",
25
+ * headers: {
26
+ * "X-Test": "foo",
27
+ * },
28
+ * queryParameters: {
29
+ * query: "foo",
30
+ * },
31
+ * assertions: [
32
+ * {
33
+ * source: "STATUS_CODE",
34
+ * property: "",
35
+ * comparison: "EQUALS",
36
+ * target: "200",
37
+ * },
38
+ * {
39
+ * source: "TEXT_BODY",
40
+ * property: "",
41
+ * comparison: "CONTAINS",
42
+ * target: "welcome",
43
+ * },
44
+ * ],
45
+ * basicAuth: {
46
+ * username: "user",
47
+ * password: "pass",
48
+ * },
49
+ * },
50
+ * environmentVariables: {
51
+ * ENVTEST: "Hello world",
52
+ * },
53
+ * doubleCheck: true,
54
+ * useGlobalAlertSettings: false,
55
+ * alertSettings: {
56
+ * escalationType: "RUN_BASED",
57
+ * runBasedEscalations: [{
58
+ * failedRunThreshold: 1,
59
+ * }],
60
+ * timeBasedEscalations: [{
61
+ * minutesFailingThreshold: 5,
62
+ * }],
63
+ * reminders: [{
64
+ * amount: 2,
65
+ * interval: 5,
66
+ * }],
67
+ * },
68
+ * localSetupScript: "setup-test",
69
+ * localTeardownScript: "teardown-test",
70
+ * });
71
+ * // Add a check to a group
72
+ * const test_check1 = new checkly.Check("test-check1", {
73
+ * groupId: test_group1CheckGroup.id,
74
+ * groupOrder: 1,
75
+ * });
76
+ * // Using with alert channels
77
+ * const emailAc1 = new checkly.AlertChannel("emailAc1", {email: {
78
+ * address: "info@example.com",
79
+ * }});
80
+ * const emailAc2 = new checkly.AlertChannel("emailAc2", {email: {
81
+ * address: "info2@example.com",
82
+ * }});
83
+ * // Connect the check group to the alert channels
84
+ * const test_group1Index_checkGroupCheckGroup = new checkly.CheckGroup("test-group1Index/checkGroupCheckGroup", {alertChannelSubscriptions: [
85
+ * {
86
+ * channelId: emailAc1.id,
87
+ * activated: true,
88
+ * },
89
+ * {
90
+ * channelId: emailAc2.id,
91
+ * activated: true,
92
+ * },
93
+ * ]});
94
+ * ```
95
+ */
8
96
  export class CheckGroup extends pulumi.CustomResource {
9
97
  /**
10
98
  * Get an existing CheckGroup resource's state with the given name, ID, and optional extra
@@ -38,24 +126,20 @@ export class CheckGroup extends pulumi.CustomResource {
38
126
  */
39
127
  public readonly activated!: pulumi.Output<boolean>;
40
128
  public readonly alertChannelSubscriptions!: pulumi.Output<outputs.CheckGroupAlertChannelSubscription[] | undefined>;
41
- /**
42
- * . Supported values documented below.
43
- */
44
129
  public readonly alertSettings!: pulumi.Output<outputs.CheckGroupAlertSettings>;
45
- /**
46
- * Default configs to use for all api checks belonging to this group. Supported values documented below.
47
- */
48
130
  public readonly apiCheckDefaults!: pulumi.Output<outputs.CheckGroupApiCheckDefaults>;
49
131
  /**
50
- * Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.
132
+ * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
51
133
  */
52
134
  public readonly concurrency!: pulumi.Output<number>;
53
135
  /**
54
- * 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.
136
+ * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
137
+ * region before marking the check as failed.
55
138
  */
56
139
  public readonly doubleCheck!: pulumi.Output<boolean | undefined>;
57
140
  /**
58
- * Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
141
+ * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
142
+ * Use global environment variables whenever possible.
59
143
  */
60
144
  public readonly environmentVariables!: pulumi.Output<{[key: string]: any} | undefined>;
61
145
  /**
@@ -71,7 +155,7 @@ export class CheckGroup extends pulumi.CustomResource {
71
155
  */
72
156
  public readonly locations!: pulumi.Output<string[]>;
73
157
  /**
74
- * Determines if any notifications will be send out when a check in this group fails and/or recovers.
158
+ * Determines if any notifications will be sent out when a check in this group fails and/or recovers.
75
159
  */
76
160
  public readonly muted!: pulumi.Output<boolean | undefined>;
77
161
  /**
@@ -79,7 +163,7 @@ export class CheckGroup extends pulumi.CustomResource {
79
163
  */
80
164
  public readonly name!: pulumi.Output<string>;
81
165
  /**
82
- * . The id of the runtime to use for this group.
166
+ * The id of the runtime to use for this group.
83
167
  */
84
168
  public readonly runtimeId!: pulumi.Output<string | undefined>;
85
169
  /**
@@ -95,7 +179,7 @@ export class CheckGroup extends pulumi.CustomResource {
95
179
  */
96
180
  public readonly teardownSnippetId!: pulumi.Output<number | undefined>;
97
181
  /**
98
- * When true, the account level alert setting will be used, not the alert setting defined on this check group.
182
+ * When true, the account level alert settings will be used, not the alert setting defined on this check group.
99
183
  */
100
184
  public readonly useGlobalAlertSettings!: pulumi.Output<boolean | undefined>;
101
185
 
@@ -158,9 +242,7 @@ export class CheckGroup extends pulumi.CustomResource {
158
242
  resourceInputs["teardownSnippetId"] = args ? args.teardownSnippetId : undefined;
159
243
  resourceInputs["useGlobalAlertSettings"] = args ? args.useGlobalAlertSettings : undefined;
160
244
  }
161
- if (!opts.version) {
162
- opts = pulumi.mergeOptions(opts, { version: utilities.getVersion()});
163
- }
245
+ opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
164
246
  super(CheckGroup.__pulumiType, name, resourceInputs, opts);
165
247
  }
166
248
  }
@@ -174,24 +256,20 @@ export interface CheckGroupState {
174
256
  */
175
257
  activated?: pulumi.Input<boolean>;
176
258
  alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertChannelSubscription>[]>;
177
- /**
178
- * . Supported values documented below.
179
- */
180
259
  alertSettings?: pulumi.Input<inputs.CheckGroupAlertSettings>;
181
- /**
182
- * Default configs to use for all api checks belonging to this group. Supported values documented below.
183
- */
184
260
  apiCheckDefaults?: pulumi.Input<inputs.CheckGroupApiCheckDefaults>;
185
261
  /**
186
- * Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.
262
+ * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
187
263
  */
188
264
  concurrency?: pulumi.Input<number>;
189
265
  /**
190
- * 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.
266
+ * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
267
+ * region before marking the check as failed.
191
268
  */
192
269
  doubleCheck?: pulumi.Input<boolean>;
193
270
  /**
194
- * Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
271
+ * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
272
+ * Use global environment variables whenever possible.
195
273
  */
196
274
  environmentVariables?: pulumi.Input<{[key: string]: any}>;
197
275
  /**
@@ -207,7 +285,7 @@ export interface CheckGroupState {
207
285
  */
208
286
  locations?: pulumi.Input<pulumi.Input<string>[]>;
209
287
  /**
210
- * Determines if any notifications will be send out when a check in this group fails and/or recovers.
288
+ * Determines if any notifications will be sent out when a check in this group fails and/or recovers.
211
289
  */
212
290
  muted?: pulumi.Input<boolean>;
213
291
  /**
@@ -215,7 +293,7 @@ export interface CheckGroupState {
215
293
  */
216
294
  name?: pulumi.Input<string>;
217
295
  /**
218
- * . The id of the runtime to use for this group.
296
+ * The id of the runtime to use for this group.
219
297
  */
220
298
  runtimeId?: pulumi.Input<string>;
221
299
  /**
@@ -231,7 +309,7 @@ export interface CheckGroupState {
231
309
  */
232
310
  teardownSnippetId?: pulumi.Input<number>;
233
311
  /**
234
- * When true, the account level alert setting will be used, not the alert setting defined on this check group.
312
+ * When true, the account level alert settings will be used, not the alert setting defined on this check group.
235
313
  */
236
314
  useGlobalAlertSettings?: pulumi.Input<boolean>;
237
315
  }
@@ -245,24 +323,20 @@ export interface CheckGroupArgs {
245
323
  */
246
324
  activated: pulumi.Input<boolean>;
247
325
  alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertChannelSubscription>[]>;
248
- /**
249
- * . Supported values documented below.
250
- */
251
326
  alertSettings?: pulumi.Input<inputs.CheckGroupAlertSettings>;
252
- /**
253
- * Default configs to use for all api checks belonging to this group. Supported values documented below.
254
- */
255
327
  apiCheckDefaults?: pulumi.Input<inputs.CheckGroupApiCheckDefaults>;
256
328
  /**
257
- * Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.
329
+ * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
258
330
  */
259
331
  concurrency: pulumi.Input<number>;
260
332
  /**
261
- * 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.
333
+ * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
334
+ * region before marking the check as failed.
262
335
  */
263
336
  doubleCheck?: pulumi.Input<boolean>;
264
337
  /**
265
- * Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
338
+ * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
339
+ * Use global environment variables whenever possible.
266
340
  */
267
341
  environmentVariables?: pulumi.Input<{[key: string]: any}>;
268
342
  /**
@@ -278,7 +352,7 @@ export interface CheckGroupArgs {
278
352
  */
279
353
  locations: pulumi.Input<pulumi.Input<string>[]>;
280
354
  /**
281
- * Determines if any notifications will be send out when a check in this group fails and/or recovers.
355
+ * Determines if any notifications will be sent out when a check in this group fails and/or recovers.
282
356
  */
283
357
  muted?: pulumi.Input<boolean>;
284
358
  /**
@@ -286,7 +360,7 @@ export interface CheckGroupArgs {
286
360
  */
287
361
  name?: pulumi.Input<string>;
288
362
  /**
289
- * . The id of the runtime to use for this group.
363
+ * The id of the runtime to use for this group.
290
364
  */
291
365
  runtimeId?: pulumi.Input<string>;
292
366
  /**
@@ -302,7 +376,7 @@ export interface CheckGroupArgs {
302
376
  */
303
377
  teardownSnippetId?: pulumi.Input<number>;
304
378
  /**
305
- * When true, the account level alert setting will be used, not the alert setting defined on this check group.
379
+ * When true, the account level alert settings will be used, not the alert setting defined on this check group.
306
380
  */
307
381
  useGlobalAlertSettings?: pulumi.Input<boolean>;
308
382
  }