@checkly/pulumi 0.0.1-alpha.4 → 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 (50) hide show
  1. package/README.md +2 -3
  2. package/alertChannel.ts +55 -138
  3. package/bin/README.md +58 -15
  4. package/bin/alertChannel.d.ts +55 -138
  5. package/bin/alertChannel.js +40 -105
  6. package/bin/alertChannel.js.map +1 -1
  7. package/bin/check.d.ts +90 -51
  8. package/bin/check.js +3 -0
  9. package/bin/check.js.map +1 -1
  10. package/bin/checkGroup.d.ts +112 -36
  11. package/bin/checkGroup.js +88 -0
  12. package/bin/checkGroup.js.map +1 -1
  13. package/bin/dashboard.d.ts +125 -14
  14. package/bin/dashboard.js +21 -21
  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 +1 -30
  24. package/bin/maintenanceWindow.js.map +1 -1
  25. package/bin/package.json +3 -3
  26. package/bin/snippet.d.ts +3 -3
  27. package/bin/triggerCheck.d.ts +18 -6
  28. package/bin/triggerCheck.js +0 -6
  29. package/bin/triggerCheck.js.map +1 -1
  30. package/bin/triggerCheckGroup.d.ts +18 -6
  31. package/bin/triggerCheckGroup.js +0 -6
  32. package/bin/triggerCheckGroup.js.map +1 -1
  33. package/bin/types/input.d.ts +2 -188
  34. package/bin/types/input.js.map +1 -1
  35. package/bin/types/output.d.ts +2 -188
  36. package/bin/types/output.js.map +1 -1
  37. package/bin/yarn.lock +179 -117
  38. package/check.ts +90 -51
  39. package/checkGroup.ts +112 -36
  40. package/dashboard.ts +125 -35
  41. package/environmentVariable.ts +107 -0
  42. package/index.ts +5 -0
  43. package/maintenanceWindow.ts +16 -45
  44. package/package.json +29 -29
  45. package/snippet.ts +3 -3
  46. package/triggerCheck.ts +18 -6
  47. package/triggerCheckGroup.ts +18 -6
  48. package/tsconfig.json +1 -0
  49. package/types/input.ts +2 -188
  50. package/types/output.ts +2 -188
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
 
@@ -220,20 +235,20 @@ export interface CheckState {
220
235
  */
221
236
  activated?: pulumi.Input<boolean>;
222
237
  alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckAlertChannelSubscription>[]>;
223
- /**
224
- * . Supported values documented below.
225
- */
226
238
  alertSettings?: pulumi.Input<inputs.CheckAlertSettings>;
227
239
  /**
228
- * 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`).
229
242
  */
230
243
  degradedResponseTime?: pulumi.Input<number>;
231
244
  /**
232
- * 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.
233
247
  */
234
248
  doubleCheck?: pulumi.Input<boolean>;
235
249
  /**
236
- * 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.
237
252
  */
238
253
  environmentVariables?: pulumi.Input<{[key: string]: any}>;
239
254
  /**
@@ -241,15 +256,17 @@ export interface CheckState {
241
256
  */
242
257
  frequency?: pulumi.Input<number>;
243
258
  /**
244
- * 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`.
245
261
  */
246
262
  frequencyOffset?: pulumi.Input<number>;
247
263
  /**
248
- * . The id of the check group this check is part of.
264
+ * The id of the check group this check is part of.
249
265
  */
250
266
  groupId?: pulumi.Input<number>;
251
267
  /**
252
- * 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.
253
270
  */
254
271
  groupOrder?: pulumi.Input<number>;
255
272
  /**
@@ -261,15 +278,16 @@ export interface CheckState {
261
278
  */
262
279
  localTeardownScript?: pulumi.Input<string>;
263
280
  /**
264
- * 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"])
265
282
  */
266
283
  locations?: pulumi.Input<pulumi.Input<string>[]>;
267
284
  /**
268
- * 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`).
269
287
  */
270
288
  maxResponseTime?: pulumi.Input<number>;
271
289
  /**
272
- * 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.
273
291
  */
274
292
  muted?: pulumi.Input<boolean>;
275
293
  /**
@@ -277,26 +295,35 @@ export interface CheckState {
277
295
  */
278
296
  name?: pulumi.Input<string>;
279
297
  /**
280
- * . An API check might have one request config. Supported values documented below.
298
+ * An API check might have one request config.
281
299
  */
282
300
  request?: pulumi.Input<inputs.CheckRequest>;
283
301
  /**
284
- * . The id of the runtime to use for this check.
302
+ * The id of the runtime to use for this check.
285
303
  */
286
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
+ */
287
309
  script?: pulumi.Input<string>;
288
310
  /**
289
311
  * An ID reference to a snippet to use in the setup phase of an API check.
290
312
  */
291
313
  setupSnippetId?: pulumi.Input<number>;
292
314
  /**
293
- * 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.
294
316
  */
295
317
  shouldFail?: pulumi.Input<boolean>;
296
318
  /**
297
- * 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.
298
322
  */
299
323
  sslCheck?: pulumi.Input<boolean>;
324
+ /**
325
+ * A list of tags for organizing and filtering checks.
326
+ */
300
327
  tags?: pulumi.Input<pulumi.Input<string>[]>;
301
328
  /**
302
329
  * An ID reference to a snippet to use in the teardown phase of an API check.
@@ -307,7 +334,7 @@ export interface CheckState {
307
334
  */
308
335
  type?: pulumi.Input<string>;
309
336
  /**
310
- * 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.
311
338
  */
312
339
  useGlobalAlertSettings?: pulumi.Input<boolean>;
313
340
  }
@@ -321,20 +348,20 @@ export interface CheckArgs {
321
348
  */
322
349
  activated: pulumi.Input<boolean>;
323
350
  alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckAlertChannelSubscription>[]>;
324
- /**
325
- * . Supported values documented below.
326
- */
327
351
  alertSettings?: pulumi.Input<inputs.CheckAlertSettings>;
328
352
  /**
329
- * 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`).
330
355
  */
331
356
  degradedResponseTime?: pulumi.Input<number>;
332
357
  /**
333
- * 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.
334
360
  */
335
361
  doubleCheck?: pulumi.Input<boolean>;
336
362
  /**
337
- * 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.
338
365
  */
339
366
  environmentVariables?: pulumi.Input<{[key: string]: any}>;
340
367
  /**
@@ -342,15 +369,17 @@ export interface CheckArgs {
342
369
  */
343
370
  frequency: pulumi.Input<number>;
344
371
  /**
345
- * 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`.
346
374
  */
347
375
  frequencyOffset?: pulumi.Input<number>;
348
376
  /**
349
- * . The id of the check group this check is part of.
377
+ * The id of the check group this check is part of.
350
378
  */
351
379
  groupId?: pulumi.Input<number>;
352
380
  /**
353
- * 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.
354
383
  */
355
384
  groupOrder?: pulumi.Input<number>;
356
385
  /**
@@ -362,15 +391,16 @@ export interface CheckArgs {
362
391
  */
363
392
  localTeardownScript?: pulumi.Input<string>;
364
393
  /**
365
- * 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"])
366
395
  */
367
396
  locations?: pulumi.Input<pulumi.Input<string>[]>;
368
397
  /**
369
- * 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`).
370
400
  */
371
401
  maxResponseTime?: pulumi.Input<number>;
372
402
  /**
373
- * 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.
374
404
  */
375
405
  muted?: pulumi.Input<boolean>;
376
406
  /**
@@ -378,26 +408,35 @@ export interface CheckArgs {
378
408
  */
379
409
  name?: pulumi.Input<string>;
380
410
  /**
381
- * . An API check might have one request config. Supported values documented below.
411
+ * An API check might have one request config.
382
412
  */
383
413
  request?: pulumi.Input<inputs.CheckRequest>;
384
414
  /**
385
- * . The id of the runtime to use for this check.
415
+ * The id of the runtime to use for this check.
386
416
  */
387
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
+ */
388
422
  script?: pulumi.Input<string>;
389
423
  /**
390
424
  * An ID reference to a snippet to use in the setup phase of an API check.
391
425
  */
392
426
  setupSnippetId?: pulumi.Input<number>;
393
427
  /**
394
- * 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.
395
429
  */
396
430
  shouldFail?: pulumi.Input<boolean>;
397
431
  /**
398
- * 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.
399
435
  */
400
436
  sslCheck?: pulumi.Input<boolean>;
437
+ /**
438
+ * A list of tags for organizing and filtering checks.
439
+ */
401
440
  tags?: pulumi.Input<pulumi.Input<string>[]>;
402
441
  /**
403
442
  * An ID reference to a snippet to use in the teardown phase of an API check.
@@ -408,7 +447,7 @@ export interface CheckArgs {
408
447
  */
409
448
  type: pulumi.Input<string>;
410
449
  /**
411
- * 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.
412
451
  */
413
452
  useGlobalAlertSettings?: pulumi.Input<boolean>;
414
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
 
@@ -172,24 +256,20 @@ export interface CheckGroupState {
172
256
  */
173
257
  activated?: pulumi.Input<boolean>;
174
258
  alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertChannelSubscription>[]>;
175
- /**
176
- * . Supported values documented below.
177
- */
178
259
  alertSettings?: pulumi.Input<inputs.CheckGroupAlertSettings>;
179
- /**
180
- * Default configs to use for all api checks belonging to this group. Supported values documented below.
181
- */
182
260
  apiCheckDefaults?: pulumi.Input<inputs.CheckGroupApiCheckDefaults>;
183
261
  /**
184
- * 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.
185
263
  */
186
264
  concurrency?: pulumi.Input<number>;
187
265
  /**
188
- * 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.
189
268
  */
190
269
  doubleCheck?: pulumi.Input<boolean>;
191
270
  /**
192
- * 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.
193
273
  */
194
274
  environmentVariables?: pulumi.Input<{[key: string]: any}>;
195
275
  /**
@@ -205,7 +285,7 @@ export interface CheckGroupState {
205
285
  */
206
286
  locations?: pulumi.Input<pulumi.Input<string>[]>;
207
287
  /**
208
- * 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.
209
289
  */
210
290
  muted?: pulumi.Input<boolean>;
211
291
  /**
@@ -213,7 +293,7 @@ export interface CheckGroupState {
213
293
  */
214
294
  name?: pulumi.Input<string>;
215
295
  /**
216
- * . The id of the runtime to use for this group.
296
+ * The id of the runtime to use for this group.
217
297
  */
218
298
  runtimeId?: pulumi.Input<string>;
219
299
  /**
@@ -229,7 +309,7 @@ export interface CheckGroupState {
229
309
  */
230
310
  teardownSnippetId?: pulumi.Input<number>;
231
311
  /**
232
- * 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.
233
313
  */
234
314
  useGlobalAlertSettings?: pulumi.Input<boolean>;
235
315
  }
@@ -243,24 +323,20 @@ export interface CheckGroupArgs {
243
323
  */
244
324
  activated: pulumi.Input<boolean>;
245
325
  alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertChannelSubscription>[]>;
246
- /**
247
- * . Supported values documented below.
248
- */
249
326
  alertSettings?: pulumi.Input<inputs.CheckGroupAlertSettings>;
250
- /**
251
- * Default configs to use for all api checks belonging to this group. Supported values documented below.
252
- */
253
327
  apiCheckDefaults?: pulumi.Input<inputs.CheckGroupApiCheckDefaults>;
254
328
  /**
255
- * 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.
256
330
  */
257
331
  concurrency: pulumi.Input<number>;
258
332
  /**
259
- * 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.
260
335
  */
261
336
  doubleCheck?: pulumi.Input<boolean>;
262
337
  /**
263
- * 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.
264
340
  */
265
341
  environmentVariables?: pulumi.Input<{[key: string]: any}>;
266
342
  /**
@@ -276,7 +352,7 @@ export interface CheckGroupArgs {
276
352
  */
277
353
  locations: pulumi.Input<pulumi.Input<string>[]>;
278
354
  /**
279
- * 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.
280
356
  */
281
357
  muted?: pulumi.Input<boolean>;
282
358
  /**
@@ -284,7 +360,7 @@ export interface CheckGroupArgs {
284
360
  */
285
361
  name?: pulumi.Input<string>;
286
362
  /**
287
- * . The id of the runtime to use for this group.
363
+ * The id of the runtime to use for this group.
288
364
  */
289
365
  runtimeId?: pulumi.Input<string>;
290
366
  /**
@@ -300,7 +376,7 @@ export interface CheckGroupArgs {
300
376
  */
301
377
  teardownSnippetId?: pulumi.Input<number>;
302
378
  /**
303
- * 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.
304
380
  */
305
381
  useGlobalAlertSettings?: pulumi.Input<boolean>;
306
382
  }