@checkly/pulumi 2.6.0 → 2.7.0-alpha.1762247191

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.
@@ -1 +1 @@
1
- {"version":3,"file":"input.js","sourceRoot":"","sources":["../../types/input.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAqOjF;;GAEG;AACH,SAAgB,yCAAyC,CAAC,GAA+B;IACrF,OAAO;QACH,GAAG,GAAG;QACN,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE;KACvB,CAAC;AACN,CAAC;AALD,8FAKC"}
1
+ {"version":3,"file":"input.js","sourceRoot":"","sources":["../../types/input.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AA6PjF;;GAEG;AACH,SAAgB,yCAAyC,CAAC,GAA+B;IACrF,OAAO;QACH,GAAG,GAAG;QACN,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE;KACvB,CAAC;AACN,CAAC;AALD,8FAKC"}
package/types/output.d.ts CHANGED
@@ -72,57 +72,69 @@ export interface CheckAlertChannelSubscription {
72
72
  }
73
73
  export interface CheckAlertSettings {
74
74
  /**
75
- * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
75
+ * Determines the type of escalation to use. Possible values are `RUN_BASED` and `TIME_BASED`. (Default `RUN_BASED`).
76
76
  */
77
77
  escalationType?: string;
78
+ /**
79
+ * Configuration for parallel run failure threshold.
80
+ */
78
81
  parallelRunFailureThresholds: outputs.CheckAlertSettingsParallelRunFailureThreshold[];
82
+ /**
83
+ * Defines how often to send reminder notifications after initial alert.
84
+ */
79
85
  reminders: outputs.CheckAlertSettingsReminder[];
86
+ /**
87
+ * Configuration for run-based escalation.
88
+ */
80
89
  runBasedEscalations: outputs.CheckAlertSettingsRunBasedEscalation[];
81
90
  /**
82
- * @deprecated This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
91
+ * @deprecated This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.
83
92
  */
84
93
  sslCertificates?: outputs.CheckAlertSettingsSslCertificate[];
94
+ /**
95
+ * Configuration for time-based escalation.
96
+ */
85
97
  timeBasedEscalations: outputs.CheckAlertSettingsTimeBasedEscalation[];
86
98
  }
87
99
  export interface CheckAlertSettingsParallelRunFailureThreshold {
88
100
  /**
89
- * Applicable only for checks scheduled in parallel in multiple locations.
101
+ * Whether parallel run failure threshold is enabled. Only applies if the check is scheduled for multiple locations in parallel. (Default `false`).
90
102
  */
91
103
  enabled?: boolean;
92
104
  /**
93
- * Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `100`, and `100`. (Default `10`).
105
+ * Percentage of runs that must fail to trigger alert. Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `90`, and `100`. (Default `10`).
94
106
  */
95
107
  percentage?: number;
96
108
  }
97
109
  export interface CheckAlertSettingsReminder {
98
110
  /**
99
- * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
111
+ * Number of reminder notifications to send. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000` (`0` to disable, `100000` for unlimited). (Default `0`).
100
112
  */
101
113
  amount?: number;
102
114
  /**
103
- * Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
115
+ * Interval between reminder notifications in minutes. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
104
116
  */
105
117
  interval?: number;
106
118
  }
107
119
  export interface CheckAlertSettingsRunBasedEscalation {
108
120
  /**
109
- * After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default `1`).
121
+ * Send an alert notification after the given number of consecutive check runs have failed. Possible values are between `1` and `5`. (Default `1`).
110
122
  */
111
123
  failedRunThreshold?: number;
112
124
  }
113
125
  export interface CheckAlertSettingsSslCertificate {
114
126
  /**
115
- * How long before SSL certificate expiry to send alerts. Possible values `3`, `7`, `14`, `30`. (Default `3`).
127
+ * No longer available.
116
128
  */
117
129
  alertThreshold?: number;
118
130
  /**
119
- * Determines if alert notifications should be sent for expiring SSL certificates. Possible values `true`, and `false`. (Default `false`).
131
+ * No longer available.
120
132
  */
121
133
  enabled?: boolean;
122
134
  }
123
135
  export interface CheckAlertSettingsTimeBasedEscalation {
124
136
  /**
125
- * After how many minutes after a check starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
137
+ * Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
126
138
  */
127
139
  minutesFailingThreshold?: number;
128
140
  }
@@ -138,57 +150,69 @@ export interface CheckGroupAlertChannelSubscription {
138
150
  }
139
151
  export interface CheckGroupAlertSettings {
140
152
  /**
141
- * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
153
+ * Determines the type of escalation to use. Possible values are `RUN_BASED` and `TIME_BASED`. (Default `RUN_BASED`).
142
154
  */
143
155
  escalationType?: string;
156
+ /**
157
+ * Configuration for parallel run failure threshold.
158
+ */
144
159
  parallelRunFailureThresholds: outputs.CheckGroupAlertSettingsParallelRunFailureThreshold[];
160
+ /**
161
+ * Defines how often to send reminder notifications after initial alert.
162
+ */
145
163
  reminders: outputs.CheckGroupAlertSettingsReminder[];
164
+ /**
165
+ * Configuration for run-based escalation.
166
+ */
146
167
  runBasedEscalations: outputs.CheckGroupAlertSettingsRunBasedEscalation[];
147
168
  /**
148
- * @deprecated This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
169
+ * @deprecated This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.
149
170
  */
150
171
  sslCertificates?: outputs.CheckGroupAlertSettingsSslCertificate[];
172
+ /**
173
+ * Configuration for time-based escalation.
174
+ */
151
175
  timeBasedEscalations: outputs.CheckGroupAlertSettingsTimeBasedEscalation[];
152
176
  }
153
177
  export interface CheckGroupAlertSettingsParallelRunFailureThreshold {
154
178
  /**
155
- * Applicable only for checks scheduled in parallel in multiple locations.
179
+ * Whether parallel run failure threshold is enabled. Only applies if the check is scheduled for multiple locations in parallel. (Default `false`).
156
180
  */
157
181
  enabled?: boolean;
158
182
  /**
159
- * Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `100`, and `100`. (Default `10`).
183
+ * Percentage of runs that must fail to trigger alert. Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `90`, and `100`. (Default `10`).
160
184
  */
161
185
  percentage?: number;
162
186
  }
163
187
  export interface CheckGroupAlertSettingsReminder {
164
188
  /**
165
- * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
189
+ * Number of reminder notifications to send. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000` (`0` to disable, `100000` for unlimited). (Default `0`).
166
190
  */
167
191
  amount?: number;
168
192
  /**
169
- * Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
193
+ * Interval between reminder notifications in minutes. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
170
194
  */
171
195
  interval?: number;
172
196
  }
173
197
  export interface CheckGroupAlertSettingsRunBasedEscalation {
174
198
  /**
175
- * After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default `1`).
199
+ * Send an alert notification after the given number of consecutive check runs have failed. Possible values are between `1` and `5`. (Default `1`).
176
200
  */
177
201
  failedRunThreshold?: number;
178
202
  }
179
203
  export interface CheckGroupAlertSettingsSslCertificate {
180
204
  /**
181
- * At what moment in time to start alerting on SSL certificates. Possible values `3`, `7`, `14`, `30`. (Default `3`).
205
+ * No longer available.
182
206
  */
183
207
  alertThreshold?: number;
184
208
  /**
185
- * Determines if alert notifications should be sent for expiring SSL certificates.
209
+ * No longer available.
186
210
  */
187
211
  enabled?: boolean;
188
212
  }
189
213
  export interface CheckGroupAlertSettingsTimeBasedEscalation {
190
214
  /**
191
- * After how many minutes after a check starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
215
+ * Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
192
216
  */
193
217
  minutesFailingThreshold?: number;
194
218
  }
@@ -369,63 +393,240 @@ export interface CheckTriggerIncident {
369
393
  */
370
394
  severity: string;
371
395
  }
396
+ export interface DnsMonitorAlertChannelSubscription {
397
+ /**
398
+ * Whether an alert should be sent to this channel.
399
+ */
400
+ activated: boolean;
401
+ /**
402
+ * The ID of the alert channel.
403
+ */
404
+ channelId: number;
405
+ }
406
+ export interface DnsMonitorAlertSettings {
407
+ /**
408
+ * Determines the type of escalation to use. Possible values are `RUN_BASED` and `TIME_BASED`. (Default `RUN_BASED`).
409
+ */
410
+ escalationType?: string;
411
+ /**
412
+ * Configuration for parallel run failure threshold.
413
+ */
414
+ parallelRunFailureThresholds: outputs.DnsMonitorAlertSettingsParallelRunFailureThreshold[];
415
+ /**
416
+ * Defines how often to send reminder notifications after initial alert.
417
+ */
418
+ reminders: outputs.DnsMonitorAlertSettingsReminder[];
419
+ /**
420
+ * Configuration for run-based escalation.
421
+ */
422
+ runBasedEscalations: outputs.DnsMonitorAlertSettingsRunBasedEscalation[];
423
+ /**
424
+ * Configuration for time-based escalation.
425
+ */
426
+ timeBasedEscalations: outputs.DnsMonitorAlertSettingsTimeBasedEscalation[];
427
+ }
428
+ export interface DnsMonitorAlertSettingsParallelRunFailureThreshold {
429
+ /**
430
+ * Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default `false`).
431
+ */
432
+ enabled?: boolean;
433
+ /**
434
+ * Percentage of runs that must fail to trigger alert. Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `90`, and `100`. (Default `10`).
435
+ */
436
+ percentage?: number;
437
+ }
438
+ export interface DnsMonitorAlertSettingsReminder {
439
+ /**
440
+ * Number of reminder notifications to send. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000` (`0` to disable, `100000` for unlimited). (Default `0`).
441
+ */
442
+ amount?: number;
443
+ /**
444
+ * Interval between reminder notifications in minutes. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
445
+ */
446
+ interval?: number;
447
+ }
448
+ export interface DnsMonitorAlertSettingsRunBasedEscalation {
449
+ /**
450
+ * Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between `1` and `5`. (Default `1`).
451
+ */
452
+ failedRunThreshold?: number;
453
+ }
454
+ export interface DnsMonitorAlertSettingsTimeBasedEscalation {
455
+ /**
456
+ * Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
457
+ */
458
+ minutesFailingThreshold?: number;
459
+ }
460
+ export interface DnsMonitorRequest {
461
+ /**
462
+ * Assertions to validate the HTTP response. DNS monitors only support status code assertions.
463
+ */
464
+ assertions?: outputs.DnsMonitorRequestAssertion[];
465
+ /**
466
+ * The name server to use.
467
+ */
468
+ nameServer?: outputs.DnsMonitorRequestNameServer;
469
+ /**
470
+ * The protocol used to communicate with the name server. Possible values are `UDP` and `TCP`. (Default `UDP`).
471
+ */
472
+ protocol?: string;
473
+ /**
474
+ * The DNS record to query.
475
+ */
476
+ query: string;
477
+ /**
478
+ * The DNS record type. Possible values are `A`, `AAAA`, `CNAME`, `MX`, `NS`, `TXT` and `SOA`.
479
+ */
480
+ recordType: string;
481
+ }
482
+ export interface DnsMonitorRequestAssertion {
483
+ /**
484
+ * The type of comparison to be executed between expected and actual value of the assertion. Possible values are `EQUALS`, `NOT_EQUALS`, `GREATER_THAN` and `LESS_THAN`.
485
+ */
486
+ comparison: string;
487
+ property?: string;
488
+ /**
489
+ * The source of the asserted value. Possible values are `RESPONSE_CODE`, `RESPONSE_TIME`, `TEXT_ANSWER` and `JSON_ANSWER`.
490
+ */
491
+ source: string;
492
+ /**
493
+ * The target value. Typically `NOERROR` when the source is `RESPONSE_CODE`.
494
+ */
495
+ target: string;
496
+ }
497
+ export interface DnsMonitorRequestNameServer {
498
+ /**
499
+ * The name server host.
500
+ */
501
+ host?: string;
502
+ /**
503
+ * The name server port.
504
+ */
505
+ port?: number;
506
+ }
507
+ export interface DnsMonitorRetryStrategy {
508
+ /**
509
+ * The number of seconds to wait before the first retry attempt. (Default `60`).
510
+ */
511
+ baseBackoffSeconds?: number;
512
+ /**
513
+ * The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when `type` is `FIXED`, `LINEAR`, or `EXPONENTIAL`. (Default `600`).
514
+ */
515
+ maxDurationSeconds?: number;
516
+ /**
517
+ * The maximum number of times to retry the check/monitor. Value must be between `1` and `10`. Available when `type` is `FIXED`, `LINEAR`, or `EXPONENTIAL`. (Default `2`).
518
+ */
519
+ maxRetries?: number;
520
+ /**
521
+ * Apply the retry strategy only if the defined conditions match.
522
+ */
523
+ onlyOn?: outputs.DnsMonitorRetryStrategyOnlyOn;
524
+ /**
525
+ * Whether retries should be run in the same region as the initial check/monitor run. (Default `true`).
526
+ */
527
+ sameRegion?: boolean;
528
+ /**
529
+ * Determines which type of retry strategy to use. Possible values are `FIXED`, `LINEAR`, `EXPONENTIAL`, `SINGLE_RETRY`, and `NO_RETRIES`.
530
+ */
531
+ type: string;
532
+ }
533
+ export interface DnsMonitorRetryStrategyOnlyOn {
534
+ /**
535
+ * When `true`, retry only if the cause of the failure is a network error. (Default `false`).
536
+ */
537
+ networkError?: boolean;
538
+ }
539
+ export interface DnsMonitorTriggerIncident {
540
+ /**
541
+ * A detailed description of the incident.
542
+ */
543
+ description: string;
544
+ /**
545
+ * The name of the incident.
546
+ */
547
+ name: string;
548
+ /**
549
+ * Whether to notify subscribers when the incident is triggered.
550
+ */
551
+ notifySubscribers: boolean;
552
+ /**
553
+ * The status page service that this incident will be associated with.
554
+ */
555
+ serviceId: string;
556
+ /**
557
+ * The severity level of the incident. Possible values are `MINOR`, `MEDIUM`, `MAJOR`, and `CRITICAL`.
558
+ */
559
+ severity: string;
560
+ }
372
561
  export interface HeartbeatCheckAlertChannelSubscription {
373
562
  activated: boolean;
374
563
  channelId: number;
375
564
  }
376
565
  export interface HeartbeatCheckAlertSettings {
377
566
  /**
378
- * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
567
+ * Determines the type of escalation to use. Possible values are `RUN_BASED` and `TIME_BASED`. (Default `RUN_BASED`).
379
568
  */
380
569
  escalationType?: string;
570
+ /**
571
+ * Configuration for parallel run failure threshold.
572
+ */
381
573
  parallelRunFailureThresholds: outputs.HeartbeatCheckAlertSettingsParallelRunFailureThreshold[];
574
+ /**
575
+ * Defines how often to send reminder notifications after initial alert.
576
+ */
382
577
  reminders: outputs.HeartbeatCheckAlertSettingsReminder[];
578
+ /**
579
+ * Configuration for run-based escalation.
580
+ */
383
581
  runBasedEscalations: outputs.HeartbeatCheckAlertSettingsRunBasedEscalation[];
384
582
  /**
385
- * @deprecated This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
583
+ * @deprecated This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.
386
584
  */
387
585
  sslCertificates?: outputs.HeartbeatCheckAlertSettingsSslCertificate[];
586
+ /**
587
+ * Configuration for time-based escalation.
588
+ */
388
589
  timeBasedEscalations: outputs.HeartbeatCheckAlertSettingsTimeBasedEscalation[];
389
590
  }
390
591
  export interface HeartbeatCheckAlertSettingsParallelRunFailureThreshold {
391
592
  /**
392
- * Applicable only for checks scheduled in parallel in multiple locations.
593
+ * Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default `false`).
393
594
  */
394
595
  enabled?: boolean;
395
596
  /**
396
- * Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `100`, and `100`. (Default `10`).
597
+ * Percentage of runs that must fail to trigger alert. Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `90`, and `100`. (Default `10`).
397
598
  */
398
599
  percentage?: number;
399
600
  }
400
601
  export interface HeartbeatCheckAlertSettingsReminder {
401
602
  /**
402
- * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
603
+ * Number of reminder notifications to send. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000` (`0` to disable, `100000` for unlimited). (Default `0`).
403
604
  */
404
605
  amount?: number;
405
606
  /**
406
- * Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
607
+ * Interval between reminder notifications in minutes. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
407
608
  */
408
609
  interval?: number;
409
610
  }
410
611
  export interface HeartbeatCheckAlertSettingsRunBasedEscalation {
411
612
  /**
412
- * After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default `1`).
613
+ * Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between `1` and `5`. (Default `1`).
413
614
  */
414
615
  failedRunThreshold?: number;
415
616
  }
416
617
  export interface HeartbeatCheckAlertSettingsSslCertificate {
417
618
  /**
418
- * How long before SSL certificate expiry to send alerts. Possible values `3`, `7`, `14`, `30`. (Default `3`).
619
+ * No longer available.
419
620
  */
420
621
  alertThreshold?: number;
421
622
  /**
422
- * Determines if alert notifications should be sent for expiring SSL certificates. Possible values `true`, and `false`. (Default `false`).
623
+ * No longer available.
423
624
  */
424
625
  enabled?: boolean;
425
626
  }
426
627
  export interface HeartbeatCheckAlertSettingsTimeBasedEscalation {
427
628
  /**
428
- * After how many minutes after a check starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
629
+ * Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
429
630
  */
430
631
  minutesFailingThreshold?: number;
431
632
  }
@@ -479,57 +680,69 @@ export interface HeartbeatMonitorAlertChannelSubscription {
479
680
  }
480
681
  export interface HeartbeatMonitorAlertSettings {
481
682
  /**
482
- * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
683
+ * Determines the type of escalation to use. Possible values are `RUN_BASED` and `TIME_BASED`. (Default `RUN_BASED`).
483
684
  */
484
685
  escalationType?: string;
686
+ /**
687
+ * Configuration for parallel run failure threshold.
688
+ */
485
689
  parallelRunFailureThresholds: outputs.HeartbeatMonitorAlertSettingsParallelRunFailureThreshold[];
690
+ /**
691
+ * Defines how often to send reminder notifications after initial alert.
692
+ */
486
693
  reminders: outputs.HeartbeatMonitorAlertSettingsReminder[];
694
+ /**
695
+ * Configuration for run-based escalation.
696
+ */
487
697
  runBasedEscalations: outputs.HeartbeatMonitorAlertSettingsRunBasedEscalation[];
488
698
  /**
489
- * @deprecated This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
699
+ * @deprecated This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.
490
700
  */
491
701
  sslCertificates?: outputs.HeartbeatMonitorAlertSettingsSslCertificate[];
702
+ /**
703
+ * Configuration for time-based escalation.
704
+ */
492
705
  timeBasedEscalations: outputs.HeartbeatMonitorAlertSettingsTimeBasedEscalation[];
493
706
  }
494
707
  export interface HeartbeatMonitorAlertSettingsParallelRunFailureThreshold {
495
708
  /**
496
- * Applicable only for checks scheduled in parallel in multiple locations.
709
+ * Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default `false`).
497
710
  */
498
711
  enabled?: boolean;
499
712
  /**
500
- * Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `100`, and `100`. (Default `10`).
713
+ * Percentage of runs that must fail to trigger alert. Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `90`, and `100`. (Default `10`).
501
714
  */
502
715
  percentage?: number;
503
716
  }
504
717
  export interface HeartbeatMonitorAlertSettingsReminder {
505
718
  /**
506
- * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
719
+ * Number of reminder notifications to send. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000` (`0` to disable, `100000` for unlimited). (Default `0`).
507
720
  */
508
721
  amount?: number;
509
722
  /**
510
- * Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
723
+ * Interval between reminder notifications in minutes. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
511
724
  */
512
725
  interval?: number;
513
726
  }
514
727
  export interface HeartbeatMonitorAlertSettingsRunBasedEscalation {
515
728
  /**
516
- * After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default `1`).
729
+ * Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between `1` and `5`. (Default `1`).
517
730
  */
518
731
  failedRunThreshold?: number;
519
732
  }
520
733
  export interface HeartbeatMonitorAlertSettingsSslCertificate {
521
734
  /**
522
- * How long before SSL certificate expiry to send alerts. Possible values `3`, `7`, `14`, `30`. (Default `3`).
735
+ * No longer available.
523
736
  */
524
737
  alertThreshold?: number;
525
738
  /**
526
- * Determines if alert notifications should be sent for expiring SSL certificates. Possible values `true`, and `false`. (Default `false`).
739
+ * No longer available.
527
740
  */
528
741
  enabled?: boolean;
529
742
  }
530
743
  export interface HeartbeatMonitorAlertSettingsTimeBasedEscalation {
531
744
  /**
532
- * After how many minutes after a check starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
745
+ * Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
533
746
  */
534
747
  minutesFailingThreshold?: number;
535
748
  }
@@ -599,43 +812,55 @@ export interface TcpCheckAlertChannelSubscription {
599
812
  }
600
813
  export interface TcpCheckAlertSettings {
601
814
  /**
602
- * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
815
+ * Determines the type of escalation to use. Possible values are `RUN_BASED` and `TIME_BASED`. (Default `RUN_BASED`).
603
816
  */
604
817
  escalationType?: string;
818
+ /**
819
+ * Configuration for parallel run failure threshold.
820
+ */
605
821
  parallelRunFailureThresholds: outputs.TcpCheckAlertSettingsParallelRunFailureThreshold[];
822
+ /**
823
+ * Defines how often to send reminder notifications after initial alert.
824
+ */
606
825
  reminders: outputs.TcpCheckAlertSettingsReminder[];
826
+ /**
827
+ * Configuration for run-based escalation.
828
+ */
607
829
  runBasedEscalations: outputs.TcpCheckAlertSettingsRunBasedEscalation[];
830
+ /**
831
+ * Configuration for time-based escalation.
832
+ */
608
833
  timeBasedEscalations: outputs.TcpCheckAlertSettingsTimeBasedEscalation[];
609
834
  }
610
835
  export interface TcpCheckAlertSettingsParallelRunFailureThreshold {
611
836
  /**
612
- * Applicable only for checks scheduled in parallel in multiple locations.
837
+ * Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default `false`).
613
838
  */
614
839
  enabled?: boolean;
615
840
  /**
616
- * Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `100`, and `100`. (Default `10`).
841
+ * Percentage of runs that must fail to trigger alert. Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `90`, and `100`. (Default `10`).
617
842
  */
618
843
  percentage?: number;
619
844
  }
620
845
  export interface TcpCheckAlertSettingsReminder {
621
846
  /**
622
- * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
847
+ * Number of reminder notifications to send. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000` (`0` to disable, `100000` for unlimited). (Default `0`).
623
848
  */
624
849
  amount?: number;
625
850
  /**
626
- * Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
851
+ * Interval between reminder notifications in minutes. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
627
852
  */
628
853
  interval?: number;
629
854
  }
630
855
  export interface TcpCheckAlertSettingsRunBasedEscalation {
631
856
  /**
632
- * After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default `1`).
857
+ * Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between `1` and `5`. (Default `1`).
633
858
  */
634
859
  failedRunThreshold?: number;
635
860
  }
636
861
  export interface TcpCheckAlertSettingsTimeBasedEscalation {
637
862
  /**
638
- * After how many minutes after a check starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
863
+ * Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
639
864
  */
640
865
  minutesFailingThreshold?: number;
641
866
  }
@@ -733,43 +958,55 @@ export interface TcpMonitorAlertChannelSubscription {
733
958
  }
734
959
  export interface TcpMonitorAlertSettings {
735
960
  /**
736
- * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
961
+ * Determines the type of escalation to use. Possible values are `RUN_BASED` and `TIME_BASED`. (Default `RUN_BASED`).
737
962
  */
738
963
  escalationType?: string;
964
+ /**
965
+ * Configuration for parallel run failure threshold.
966
+ */
739
967
  parallelRunFailureThresholds: outputs.TcpMonitorAlertSettingsParallelRunFailureThreshold[];
968
+ /**
969
+ * Defines how often to send reminder notifications after initial alert.
970
+ */
740
971
  reminders: outputs.TcpMonitorAlertSettingsReminder[];
972
+ /**
973
+ * Configuration for run-based escalation.
974
+ */
741
975
  runBasedEscalations: outputs.TcpMonitorAlertSettingsRunBasedEscalation[];
976
+ /**
977
+ * Configuration for time-based escalation.
978
+ */
742
979
  timeBasedEscalations: outputs.TcpMonitorAlertSettingsTimeBasedEscalation[];
743
980
  }
744
981
  export interface TcpMonitorAlertSettingsParallelRunFailureThreshold {
745
982
  /**
746
- * Applicable only for checks scheduled in parallel in multiple locations.
983
+ * Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default `false`).
747
984
  */
748
985
  enabled?: boolean;
749
986
  /**
750
- * Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `100`, and `100`. (Default `10`).
987
+ * Percentage of runs that must fail to trigger alert. Possible values are `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `90`, and `100`. (Default `10`).
751
988
  */
752
989
  percentage?: number;
753
990
  }
754
991
  export interface TcpMonitorAlertSettingsReminder {
755
992
  /**
756
- * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
993
+ * Number of reminder notifications to send. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000` (`0` to disable, `100000` for unlimited). (Default `0`).
757
994
  */
758
995
  amount?: number;
759
996
  /**
760
- * Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
997
+ * Interval between reminder notifications in minutes. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
761
998
  */
762
999
  interval?: number;
763
1000
  }
764
1001
  export interface TcpMonitorAlertSettingsRunBasedEscalation {
765
1002
  /**
766
- * After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default `1`).
1003
+ * Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between `1` and `5`. (Default `1`).
767
1004
  */
768
1005
  failedRunThreshold?: number;
769
1006
  }
770
1007
  export interface TcpMonitorAlertSettingsTimeBasedEscalation {
771
1008
  /**
772
- * After how many minutes after a check starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
1009
+ * Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
773
1010
  */
774
1011
  minutesFailingThreshold?: number;
775
1012
  }
@@ -873,9 +1110,9 @@ export interface UrlMonitorAlertChannelSubscription {
873
1110
  }
874
1111
  export interface UrlMonitorAlertSettings {
875
1112
  /**
876
- * Determines what type of escalation to use. Possible values are `RUN_BASED` and `TIME_BASED`.
1113
+ * Determines the type of escalation to use. Possible values are `RUN_BASED` and `TIME_BASED`. (Default `RUN_BASED`).
877
1114
  */
878
- escalationType: string;
1115
+ escalationType?: string;
879
1116
  /**
880
1117
  * Configuration for parallel run failure threshold.
881
1118
  */
@@ -895,7 +1132,7 @@ export interface UrlMonitorAlertSettings {
895
1132
  }
896
1133
  export interface UrlMonitorAlertSettingsParallelRunFailureThreshold {
897
1134
  /**
898
- * Whether parallel run failure threshold is enabled. Applicable only for monitors scheduled in parallel in multiple locations. (Default `false`).
1135
+ * Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default `false`).
899
1136
  */
900
1137
  enabled?: boolean;
901
1138
  /**
@@ -915,13 +1152,13 @@ export interface UrlMonitorAlertSettingsReminder {
915
1152
  }
916
1153
  export interface UrlMonitorAlertSettingsRunBasedEscalation {
917
1154
  /**
918
- * After how many failed consecutive check runs an alert notification should be sent. Possible values are between `1` and `5`. (Default `1`).
1155
+ * Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between `1` and `5`. (Default `1`).
919
1156
  */
920
1157
  failedRunThreshold?: number;
921
1158
  }
922
1159
  export interface UrlMonitorAlertSettingsTimeBasedEscalation {
923
1160
  /**
924
- * After how many minutes after a monitor starts failing an alert should be sent. Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
1161
+ * Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are `5`, `10`, `15`, and `30`. (Default `5`).
925
1162
  */
926
1163
  minutesFailingThreshold?: number;
927
1164
  }