@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
@@ -1,242 +1,104 @@
1
1
  import { output as outputs } from "../types";
2
2
  export interface AlertChannelEmail {
3
- /**
4
- * the email address of this email alert channel.
5
- */
6
3
  address: string;
7
4
  }
8
5
  export interface AlertChannelOpsgenie {
9
- /**
10
- * .
11
- */
12
6
  apiKey: string;
13
- /**
14
- * Webhook's channel name.
15
- */
16
7
  name: string;
17
- /**
18
- * .
19
- */
20
8
  priority: string;
21
- /**
22
- * .
23
- */
24
9
  region: string;
25
10
  }
26
11
  export interface AlertChannelPagerduty {
27
- /**
28
- * Pagerduty's account name.
29
- */
30
12
  account?: string;
31
- /**
32
- * Pagerduty's service integration key.
33
- */
34
13
  serviceKey: string;
35
- /**
36
- * Pagerduty's service name.
37
- */
38
14
  serviceName?: string;
39
15
  }
40
16
  export interface AlertChannelSlack {
41
- /**
42
- * Slack's channel name.
43
- */
44
17
  channel: string;
45
- /**
46
- * .
47
- */
48
18
  url: string;
49
19
  }
50
20
  export interface AlertChannelSms {
51
- /**
52
- * Webhook's channel name.
53
- */
54
21
  name: string;
55
- /**
56
- * Mobile number to receive alerts.
57
- */
58
22
  number: string;
59
23
  }
60
24
  export interface AlertChannelWebhook {
61
- /**
62
- * .
63
- */
64
25
  headers: {
65
26
  [key: string]: any;
66
27
  };
67
- /**
68
- * Default is `POST`.
69
- */
70
28
  method?: string;
71
- /**
72
- * Webhook's channel name.
73
- */
74
29
  name: string;
75
- /**
76
- * .
77
- */
78
30
  queryParameters: {
79
31
  [key: string]: any;
80
32
  };
81
- /**
82
- * .
83
- */
84
33
  template?: string;
85
- /**
86
- * .
87
- */
88
34
  url: string;
89
- /**
90
- * .
91
- */
92
35
  webhookSecret?: string;
93
36
  }
94
37
  export interface CheckAlertChannelSubscription {
95
- /**
96
- * Determines if the check is running or not. Possible values `true`, and `false`.
97
- */
98
38
  activated: boolean;
99
39
  channelId: number;
100
40
  }
101
41
  export interface CheckAlertSettings {
102
- /**
103
- * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
104
- */
105
42
  escalationType?: string;
106
- /**
107
- * . Possible arguments:
108
- */
109
43
  reminders?: outputs.CheckAlertSettingsReminder[];
110
- /**
111
- * . Possible arguments:
112
- */
113
44
  runBasedEscalations?: outputs.CheckAlertSettingsRunBasedEscalation[];
114
45
  /**
115
- * At what interval the reminders should be send. Possible arguments:
46
+ * @deprecated The property `ssl_certificates` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
116
47
  */
117
48
  sslCertificates?: outputs.CheckAlertSettingsSslCertificate[];
118
- /**
119
- * . Possible arguments:
120
- */
121
49
  timeBasedEscalations?: outputs.CheckAlertSettingsTimeBasedEscalation[];
122
50
  }
123
51
  export interface CheckAlertSettingsReminder {
124
- /**
125
- * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
126
- */
127
52
  amount?: number;
128
- /**
129
- * . Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
130
- */
131
53
  interval?: number;
132
54
  }
133
55
  export interface CheckAlertSettingsRunBasedEscalation {
134
- /**
135
- * After how many failed consecutive check runs an alert notification should be send. Possible values are between 1 and 5. Defaults to `1`.
136
- */
137
56
  failedRunThreshold?: number;
138
57
  }
139
58
  export interface CheckAlertSettingsSslCertificate {
140
- /**
141
- * At what moment in time to start alerting on SSL certificates. Possible values `3`, `7`, `14`, `30`. Defaults to `3`.
142
- */
143
59
  alertThreshold?: number;
144
- /**
145
- * Determines if alert notifications should be send for expiring SSL certificates. Possible values `true`, and `false`. Defaults to `true`.
146
- */
147
60
  enabled?: boolean;
148
61
  }
149
62
  export interface CheckAlertSettingsTimeBasedEscalation {
150
- /**
151
- * After how many minutes after a check starts failing an alert should be send. Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
152
- */
153
63
  minutesFailingThreshold?: number;
154
64
  }
155
65
  export interface CheckGroupAlertChannelSubscription {
156
- /**
157
- * Determines if the checks in the group are running or not.
158
- */
159
66
  activated: boolean;
160
67
  channelId: number;
161
68
  }
162
69
  export interface CheckGroupAlertSettings {
163
- /**
164
- * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
165
- */
166
70
  escalationType?: string;
167
- /**
168
- * . Possible arguments:
169
- */
170
71
  reminders?: outputs.CheckGroupAlertSettingsReminder[];
171
- /**
172
- * . Possible arguments:
173
- */
174
72
  runBasedEscalations?: outputs.CheckGroupAlertSettingsRunBasedEscalation[];
175
73
  /**
176
- * At what interval the reminders should be send. Possible arguments:
74
+ * @deprecated The property `ssl_certificates` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
177
75
  */
178
76
  sslCertificates?: outputs.CheckGroupAlertSettingsSslCertificate[];
179
- /**
180
- * . Possible arguments:
181
- */
182
77
  timeBasedEscalations?: outputs.CheckGroupAlertSettingsTimeBasedEscalation[];
183
78
  }
184
79
  export interface CheckGroupAlertSettingsReminder {
185
- /**
186
- * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
187
- */
188
80
  amount?: number;
189
- /**
190
- * . Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
191
- */
192
81
  interval?: number;
193
82
  }
194
83
  export interface CheckGroupAlertSettingsRunBasedEscalation {
195
- /**
196
- * After how many failed consecutive check runs an alert notification should be send. Possible values are between 1 and 5. Defaults to `1`.
197
- */
198
84
  failedRunThreshold?: number;
199
85
  }
200
86
  export interface CheckGroupAlertSettingsSslCertificate {
201
- /**
202
- * At what moment in time to start alerting on SSL certificates. Possible values `3`, `7`, `14`, `30`. Defaults to `3`.
203
- */
204
87
  alertThreshold?: number;
205
- /**
206
- * Determines if alert notifications should be send for expiring SSL certificates. Possible values `true`, and `false`. Defaults to `true`.
207
- */
208
88
  enabled?: boolean;
209
89
  }
210
90
  export interface CheckGroupAlertSettingsTimeBasedEscalation {
211
- /**
212
- * After how many minutes after a check starts failing an alert should be send. Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
213
- */
214
91
  minutesFailingThreshold?: number;
215
92
  }
216
93
  export interface CheckGroupApiCheckDefaults {
217
- /**
218
- * . Possible arguments:
219
- */
220
94
  assertions?: outputs.CheckGroupApiCheckDefaultsAssertion[];
221
- /**
222
- * . Possible arguments
223
- */
224
95
  basicAuth: outputs.CheckGroupApiCheckDefaultsBasicAuth;
225
- /**
226
- * .
227
- */
228
96
  headers: {
229
97
  [key: string]: any;
230
98
  };
231
- /**
232
- * .
233
- */
234
99
  queryParameters: {
235
100
  [key: string]: any;
236
101
  };
237
- /**
238
- * The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.
239
- */
240
102
  url: string;
241
103
  }
242
104
  /**
@@ -244,17 +106,8 @@ export interface CheckGroupApiCheckDefaults {
244
106
  */
245
107
  export declare function checkGroupApiCheckDefaultsProvideDefaults(val: CheckGroupApiCheckDefaults): CheckGroupApiCheckDefaults;
246
108
  export interface CheckGroupApiCheckDefaultsAssertion {
247
- /**
248
- * Possible values `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
249
- */
250
109
  comparison: string;
251
- /**
252
- * .
253
- */
254
110
  property?: string;
255
- /**
256
- * Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
257
- */
258
111
  source: string;
259
112
  target: string;
260
113
  }
@@ -263,64 +116,25 @@ export interface CheckGroupApiCheckDefaultsBasicAuth {
263
116
  username: string;
264
117
  }
265
118
  export interface CheckRequest {
266
- /**
267
- * A request can have multiple assetions. Assertion has the following arguments:
268
- */
269
119
  assertions?: outputs.CheckRequestAssertion[];
270
- /**
271
- * A request might have one basicAuth config. basicAuth has two arguments:
272
- */
273
120
  basicAuth: outputs.CheckRequestBasicAuth;
274
121
  body?: string;
275
- /**
276
- * Possible values `NONE`, `JSON`, `FORM`, `RAW`, and `GRAPHQL`.
277
- */
278
122
  bodyType?: string;
279
- /**
280
- * .
281
- */
282
123
  followRedirects?: boolean;
283
- /**
284
- * .
285
- */
286
124
  headers: {
287
125
  [key: string]: any;
288
126
  };
289
- /**
290
- * The HTTP method to use for this API check. Possible values are `GET`, `POST`, `PUT`, `HEAD`, `DELETE`, `PATCH`. Defaults to `GET`.
291
- */
292
127
  method?: string;
293
- /**
294
- * .
295
- */
296
128
  queryParameters: {
297
129
  [key: string]: any;
298
130
  };
299
- /**
300
- * .
301
- */
302
131
  skipSsl?: boolean;
303
- /**
304
- * .
305
- */
306
132
  url: string;
307
133
  }
308
134
  export interface CheckRequestAssertion {
309
- /**
310
- * Possible values `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
311
- */
312
135
  comparison: string;
313
- /**
314
- * .
315
- */
316
136
  property?: string;
317
- /**
318
- * Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
319
- */
320
137
  source: string;
321
- /**
322
- * .
323
- */
324
138
  target?: string;
325
139
  }
326
140
  export interface CheckRequestBasicAuth {
@@ -1 +1 @@
1
- {"version":3,"file":"output.js","sourceRoot":"","sources":["../../types/output.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAiQjF;;GAEG;AACH,SAAgB,yCAAyC,CAAC,GAA+B;;IACrF,uCACO,GAAG,KACN,GAAG,EAAE,MAAA,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,EAAE,IACtB;AACN,CAAC;AALD,8FAKC"}
1
+ {"version":3,"file":"output.js","sourceRoot":"","sources":["../../types/output.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAuHjF;;GAEG;AACH,SAAgB,yCAAyC,CAAC,GAA+B;;IACrF,uCACO,GAAG,KACN,GAAG,EAAE,MAAA,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,EAAE,IACtB;AACN,CAAC;AALD,8FAKC"}
package/bin/utilities.js CHANGED
@@ -2,7 +2,7 @@
2
2
  // *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
3
3
  // *** Do not edit by hand unless you're certain you know what you are doing! ***
4
4
  Object.defineProperty(exports, "__esModule", { value: true });
5
- exports.getVersion = exports.getEnvNumber = exports.getEnvBoolean = exports.getEnv = void 0;
5
+ exports.resourceOptsDefaults = exports.getVersion = exports.getEnvNumber = exports.getEnvBoolean = exports.getEnv = void 0;
6
6
  function getEnv(...vars) {
7
7
  for (const v of vars) {
8
8
  const value = process.env[v];
@@ -49,4 +49,9 @@ function getVersion() {
49
49
  return version;
50
50
  }
51
51
  exports.getVersion = getVersion;
52
+ /** @internal */
53
+ function resourceOptsDefaults() {
54
+ return { version: getVersion(), pluginDownloadURL: "https://github.com/checkly/pulumi-checkly/releases/${VERSION}" };
55
+ }
56
+ exports.resourceOptsDefaults = resourceOptsDefaults;
52
57
  //# sourceMappingURL=utilities.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"utilities.js","sourceRoot":"","sources":["../utilities.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAGjF,SAAgB,MAAM,CAAC,GAAG,IAAc;IACpC,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;QAClB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,KAAK,EAAE;YACP,OAAO,KAAK,CAAC;SAChB;KACJ;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AARD,wBAQC;AAED,SAAgB,aAAa,CAAC,GAAG,IAAc;IAC3C,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,IAAI,CAAC,KAAK,SAAS,EAAE;QACjB,uGAAuG;QACvG,yDAAyD;QACzD,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,SAAS,EAAE;YAC1E,OAAO,IAAI,CAAC;SACf;QACD,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,SAAS,EAAE;YAC7E,OAAO,KAAK,CAAC;SAChB;KACJ;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAbD,sCAaC;AAED,SAAgB,YAAY,CAAC,GAAG,IAAc;IAC1C,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,IAAI,CAAC,KAAK,SAAS,EAAE;QACjB,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACX,OAAO,CAAC,CAAC;SACZ;KACJ;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AATD,oCASC;AAED,SAAgB,UAAU;IACtB,IAAI,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC;IAChD,6EAA6E;IAC7E,iCAAiC;IACjC,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC5B,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC9B;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AARD,gCAQC"}
1
+ {"version":3,"file":"utilities.js","sourceRoot":"","sources":["../utilities.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAGjF,SAAgB,MAAM,CAAC,GAAG,IAAc;IACpC,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;QAClB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,KAAK,EAAE;YACP,OAAO,KAAK,CAAC;SAChB;KACJ;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AARD,wBAQC;AAED,SAAgB,aAAa,CAAC,GAAG,IAAc;IAC3C,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,IAAI,CAAC,KAAK,SAAS,EAAE;QACjB,uGAAuG;QACvG,yDAAyD;QACzD,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,SAAS,EAAE;YAC1E,OAAO,IAAI,CAAC;SACf;QACD,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,SAAS,EAAE;YAC7E,OAAO,KAAK,CAAC;SAChB;KACJ;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAbD,sCAaC;AAED,SAAgB,YAAY,CAAC,GAAG,IAAc;IAC1C,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,IAAI,CAAC,KAAK,SAAS,EAAE;QACjB,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACX,OAAO,CAAC,CAAC;SACZ;KACJ;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AATD,oCASC;AAED,SAAgB,UAAU;IACtB,IAAI,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC;IAChD,6EAA6E;IAC7E,iCAAiC;IACjC,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC5B,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC9B;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AARD,gCAQC;AAED,gBAAgB;AAChB,SAAgB,oBAAoB;IAChC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,iBAAiB,EAAE,+DAA+D,EAAE,CAAC;AACzH,CAAC;AAFD,oDAEC"}