@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/bin/checkGroup.d.ts CHANGED
@@ -1,5 +1,93 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  import { input as inputs, output as outputs } from "./types";
3
+ /**
4
+ * Check groups allow you to group together a set of related checks, which can also share default settings for various attributes.
5
+ *
6
+ * ## Example Usage
7
+ *
8
+ * ```typescript
9
+ * import * as pulumi from "@pulumi/pulumi";
10
+ * import * as pulumi from "@checkly/pulumi";
11
+ *
12
+ * const test_group1CheckGroup = new checkly.CheckGroup("test-group1CheckGroup", {
13
+ * activated: true,
14
+ * muted: false,
15
+ * tags: ["auto"],
16
+ * locations: ["eu-west-1"],
17
+ * concurrency: 3,
18
+ * apiCheckDefaults: {
19
+ * url: "http://example.com/",
20
+ * headers: {
21
+ * "X-Test": "foo",
22
+ * },
23
+ * queryParameters: {
24
+ * query: "foo",
25
+ * },
26
+ * assertions: [
27
+ * {
28
+ * source: "STATUS_CODE",
29
+ * property: "",
30
+ * comparison: "EQUALS",
31
+ * target: "200",
32
+ * },
33
+ * {
34
+ * source: "TEXT_BODY",
35
+ * property: "",
36
+ * comparison: "CONTAINS",
37
+ * target: "welcome",
38
+ * },
39
+ * ],
40
+ * basicAuth: {
41
+ * username: "user",
42
+ * password: "pass",
43
+ * },
44
+ * },
45
+ * environmentVariables: {
46
+ * ENVTEST: "Hello world",
47
+ * },
48
+ * doubleCheck: true,
49
+ * useGlobalAlertSettings: false,
50
+ * alertSettings: {
51
+ * escalationType: "RUN_BASED",
52
+ * runBasedEscalations: [{
53
+ * failedRunThreshold: 1,
54
+ * }],
55
+ * timeBasedEscalations: [{
56
+ * minutesFailingThreshold: 5,
57
+ * }],
58
+ * reminders: [{
59
+ * amount: 2,
60
+ * interval: 5,
61
+ * }],
62
+ * },
63
+ * localSetupScript: "setup-test",
64
+ * localTeardownScript: "teardown-test",
65
+ * });
66
+ * // Add a check to a group
67
+ * const test_check1 = new checkly.Check("test-check1", {
68
+ * groupId: test_group1CheckGroup.id,
69
+ * groupOrder: 1,
70
+ * });
71
+ * // Using with alert channels
72
+ * const emailAc1 = new checkly.AlertChannel("emailAc1", {email: {
73
+ * address: "info@example.com",
74
+ * }});
75
+ * const emailAc2 = new checkly.AlertChannel("emailAc2", {email: {
76
+ * address: "info2@example.com",
77
+ * }});
78
+ * // Connect the check group to the alert channels
79
+ * const test_group1Index_checkGroupCheckGroup = new checkly.CheckGroup("test-group1Index/checkGroupCheckGroup", {alertChannelSubscriptions: [
80
+ * {
81
+ * channelId: emailAc1.id,
82
+ * activated: true,
83
+ * },
84
+ * {
85
+ * channelId: emailAc2.id,
86
+ * activated: true,
87
+ * },
88
+ * ]});
89
+ * ```
90
+ */
3
91
  export declare class CheckGroup extends pulumi.CustomResource {
4
92
  /**
5
93
  * Get an existing CheckGroup resource's state with the given name, ID, and optional extra
@@ -21,24 +109,20 @@ export declare class CheckGroup extends pulumi.CustomResource {
21
109
  */
22
110
  readonly activated: pulumi.Output<boolean>;
23
111
  readonly alertChannelSubscriptions: pulumi.Output<outputs.CheckGroupAlertChannelSubscription[] | undefined>;
24
- /**
25
- * . Supported values documented below.
26
- */
27
112
  readonly alertSettings: pulumi.Output<outputs.CheckGroupAlertSettings>;
28
- /**
29
- * Default configs to use for all api checks belonging to this group. Supported values documented below.
30
- */
31
113
  readonly apiCheckDefaults: pulumi.Output<outputs.CheckGroupApiCheckDefaults>;
32
114
  /**
33
- * Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.
115
+ * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
34
116
  */
35
117
  readonly concurrency: pulumi.Output<number>;
36
118
  /**
37
- * 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.
119
+ * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
120
+ * region before marking the check as failed.
38
121
  */
39
122
  readonly doubleCheck: pulumi.Output<boolean | undefined>;
40
123
  /**
41
- * Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
124
+ * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
125
+ * Use global environment variables whenever possible.
42
126
  */
43
127
  readonly environmentVariables: pulumi.Output<{
44
128
  [key: string]: any;
@@ -56,7 +140,7 @@ export declare class CheckGroup extends pulumi.CustomResource {
56
140
  */
57
141
  readonly locations: pulumi.Output<string[]>;
58
142
  /**
59
- * Determines if any notifications will be send out when a check in this group fails and/or recovers.
143
+ * Determines if any notifications will be sent out when a check in this group fails and/or recovers.
60
144
  */
61
145
  readonly muted: pulumi.Output<boolean | undefined>;
62
146
  /**
@@ -64,7 +148,7 @@ export declare class CheckGroup extends pulumi.CustomResource {
64
148
  */
65
149
  readonly name: pulumi.Output<string>;
66
150
  /**
67
- * . The id of the runtime to use for this group.
151
+ * The id of the runtime to use for this group.
68
152
  */
69
153
  readonly runtimeId: pulumi.Output<string | undefined>;
70
154
  /**
@@ -80,7 +164,7 @@ export declare class CheckGroup extends pulumi.CustomResource {
80
164
  */
81
165
  readonly teardownSnippetId: pulumi.Output<number | undefined>;
82
166
  /**
83
- * When true, the account level alert setting will be used, not the alert setting defined on this check group.
167
+ * When true, the account level alert settings will be used, not the alert setting defined on this check group.
84
168
  */
85
169
  readonly useGlobalAlertSettings: pulumi.Output<boolean | undefined>;
86
170
  /**
@@ -101,24 +185,20 @@ export interface CheckGroupState {
101
185
  */
102
186
  activated?: pulumi.Input<boolean>;
103
187
  alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertChannelSubscription>[]>;
104
- /**
105
- * . Supported values documented below.
106
- */
107
188
  alertSettings?: pulumi.Input<inputs.CheckGroupAlertSettings>;
108
- /**
109
- * Default configs to use for all api checks belonging to this group. Supported values documented below.
110
- */
111
189
  apiCheckDefaults?: pulumi.Input<inputs.CheckGroupApiCheckDefaults>;
112
190
  /**
113
- * Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.
191
+ * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
114
192
  */
115
193
  concurrency?: pulumi.Input<number>;
116
194
  /**
117
- * 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.
195
+ * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
196
+ * region before marking the check as failed.
118
197
  */
119
198
  doubleCheck?: pulumi.Input<boolean>;
120
199
  /**
121
- * Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
200
+ * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
201
+ * Use global environment variables whenever possible.
122
202
  */
123
203
  environmentVariables?: pulumi.Input<{
124
204
  [key: string]: any;
@@ -136,7 +216,7 @@ export interface CheckGroupState {
136
216
  */
137
217
  locations?: pulumi.Input<pulumi.Input<string>[]>;
138
218
  /**
139
- * Determines if any notifications will be send out when a check in this group fails and/or recovers.
219
+ * Determines if any notifications will be sent out when a check in this group fails and/or recovers.
140
220
  */
141
221
  muted?: pulumi.Input<boolean>;
142
222
  /**
@@ -144,7 +224,7 @@ export interface CheckGroupState {
144
224
  */
145
225
  name?: pulumi.Input<string>;
146
226
  /**
147
- * . The id of the runtime to use for this group.
227
+ * The id of the runtime to use for this group.
148
228
  */
149
229
  runtimeId?: pulumi.Input<string>;
150
230
  /**
@@ -160,7 +240,7 @@ export interface CheckGroupState {
160
240
  */
161
241
  teardownSnippetId?: pulumi.Input<number>;
162
242
  /**
163
- * When true, the account level alert setting will be used, not the alert setting defined on this check group.
243
+ * When true, the account level alert settings will be used, not the alert setting defined on this check group.
164
244
  */
165
245
  useGlobalAlertSettings?: pulumi.Input<boolean>;
166
246
  }
@@ -173,24 +253,20 @@ export interface CheckGroupArgs {
173
253
  */
174
254
  activated: pulumi.Input<boolean>;
175
255
  alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertChannelSubscription>[]>;
176
- /**
177
- * . Supported values documented below.
178
- */
179
256
  alertSettings?: pulumi.Input<inputs.CheckGroupAlertSettings>;
180
- /**
181
- * Default configs to use for all api checks belonging to this group. Supported values documented below.
182
- */
183
257
  apiCheckDefaults?: pulumi.Input<inputs.CheckGroupApiCheckDefaults>;
184
258
  /**
185
- * Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.
259
+ * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
186
260
  */
187
261
  concurrency: pulumi.Input<number>;
188
262
  /**
189
- * 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.
263
+ * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
264
+ * region before marking the check as failed.
190
265
  */
191
266
  doubleCheck?: pulumi.Input<boolean>;
192
267
  /**
193
- * Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
268
+ * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
269
+ * Use global environment variables whenever possible.
194
270
  */
195
271
  environmentVariables?: pulumi.Input<{
196
272
  [key: string]: any;
@@ -208,7 +284,7 @@ export interface CheckGroupArgs {
208
284
  */
209
285
  locations: pulumi.Input<pulumi.Input<string>[]>;
210
286
  /**
211
- * Determines if any notifications will be send out when a check in this group fails and/or recovers.
287
+ * Determines if any notifications will be sent out when a check in this group fails and/or recovers.
212
288
  */
213
289
  muted?: pulumi.Input<boolean>;
214
290
  /**
@@ -216,7 +292,7 @@ export interface CheckGroupArgs {
216
292
  */
217
293
  name?: pulumi.Input<string>;
218
294
  /**
219
- * . The id of the runtime to use for this group.
295
+ * The id of the runtime to use for this group.
220
296
  */
221
297
  runtimeId?: pulumi.Input<string>;
222
298
  /**
@@ -232,7 +308,7 @@ export interface CheckGroupArgs {
232
308
  */
233
309
  teardownSnippetId?: pulumi.Input<number>;
234
310
  /**
235
- * When true, the account level alert setting will be used, not the alert setting defined on this check group.
311
+ * When true, the account level alert settings will be used, not the alert setting defined on this check group.
236
312
  */
237
313
  useGlobalAlertSettings?: pulumi.Input<boolean>;
238
314
  }
package/bin/checkGroup.js CHANGED
@@ -6,6 +6,94 @@ exports.CheckGroup = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const types_1 = require("./types");
8
8
  const utilities = require("./utilities");
9
+ /**
10
+ * Check groups allow you to group together a set of related checks, which can also share default settings for various attributes.
11
+ *
12
+ * ## Example Usage
13
+ *
14
+ * ```typescript
15
+ * import * as pulumi from "@pulumi/pulumi";
16
+ * import * as pulumi from "@checkly/pulumi";
17
+ *
18
+ * const test_group1CheckGroup = new checkly.CheckGroup("test-group1CheckGroup", {
19
+ * activated: true,
20
+ * muted: false,
21
+ * tags: ["auto"],
22
+ * locations: ["eu-west-1"],
23
+ * concurrency: 3,
24
+ * apiCheckDefaults: {
25
+ * url: "http://example.com/",
26
+ * headers: {
27
+ * "X-Test": "foo",
28
+ * },
29
+ * queryParameters: {
30
+ * query: "foo",
31
+ * },
32
+ * assertions: [
33
+ * {
34
+ * source: "STATUS_CODE",
35
+ * property: "",
36
+ * comparison: "EQUALS",
37
+ * target: "200",
38
+ * },
39
+ * {
40
+ * source: "TEXT_BODY",
41
+ * property: "",
42
+ * comparison: "CONTAINS",
43
+ * target: "welcome",
44
+ * },
45
+ * ],
46
+ * basicAuth: {
47
+ * username: "user",
48
+ * password: "pass",
49
+ * },
50
+ * },
51
+ * environmentVariables: {
52
+ * ENVTEST: "Hello world",
53
+ * },
54
+ * doubleCheck: true,
55
+ * useGlobalAlertSettings: false,
56
+ * alertSettings: {
57
+ * escalationType: "RUN_BASED",
58
+ * runBasedEscalations: [{
59
+ * failedRunThreshold: 1,
60
+ * }],
61
+ * timeBasedEscalations: [{
62
+ * minutesFailingThreshold: 5,
63
+ * }],
64
+ * reminders: [{
65
+ * amount: 2,
66
+ * interval: 5,
67
+ * }],
68
+ * },
69
+ * localSetupScript: "setup-test",
70
+ * localTeardownScript: "teardown-test",
71
+ * });
72
+ * // Add a check to a group
73
+ * const test_check1 = new checkly.Check("test-check1", {
74
+ * groupId: test_group1CheckGroup.id,
75
+ * groupOrder: 1,
76
+ * });
77
+ * // Using with alert channels
78
+ * const emailAc1 = new checkly.AlertChannel("emailAc1", {email: {
79
+ * address: "info@example.com",
80
+ * }});
81
+ * const emailAc2 = new checkly.AlertChannel("emailAc2", {email: {
82
+ * address: "info2@example.com",
83
+ * }});
84
+ * // Connect the check group to the alert channels
85
+ * const test_group1Index_checkGroupCheckGroup = new checkly.CheckGroup("test-group1Index/checkGroupCheckGroup", {alertChannelSubscriptions: [
86
+ * {
87
+ * channelId: emailAc1.id,
88
+ * activated: true,
89
+ * },
90
+ * {
91
+ * channelId: emailAc2.id,
92
+ * activated: true,
93
+ * },
94
+ * ]});
95
+ * ```
96
+ */
9
97
  class CheckGroup extends pulumi.CustomResource {
10
98
  constructor(name, argsOrState, opts) {
11
99
  let resourceInputs = {};
@@ -59,9 +147,7 @@ class CheckGroup extends pulumi.CustomResource {
59
147
  resourceInputs["teardownSnippetId"] = args ? args.teardownSnippetId : undefined;
60
148
  resourceInputs["useGlobalAlertSettings"] = args ? args.useGlobalAlertSettings : undefined;
61
149
  }
62
- if (!opts.version) {
63
- opts = pulumi.mergeOptions(opts, { version: utilities.getVersion() });
64
- }
150
+ opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
65
151
  super(CheckGroup.__pulumiType, name, resourceInputs, opts);
66
152
  }
67
153
  /**
package/bin/checkGroup.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"checkGroup.js","sourceRoot":"","sources":["../checkGroup.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,mCAA6D;AAC7D,yCAAyC;AAEzC,MAAa,UAAW,SAAQ,MAAM,CAAC,cAAc;IAsGjD,YAAY,IAAY,EAAE,WAA8C,EAAE,IAAmC;QACzG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA0C,CAAC;YACzD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,2BAA2B,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClG,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,cAAc,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,wBAAwB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/F;aAAM;YACH,MAAM,IAAI,GAAG,WAAyC,CAAC;YACvD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,2BAA2B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,aAAM,CAAC,yCAAyC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3L,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,cAAc,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7F;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,UAAU,EAAE,EAAC,CAAC,CAAC;SACxE;QACD,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;IA5JD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAuB,EAAE,IAAmC;QACrH,OAAO,IAAI,UAAU,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACjE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,UAAU,CAAC,YAAY,CAAC;IAC3D,CAAC;;AA1BL,gCA8JC;AAhJG,gBAAgB;AACO,uBAAY,GAAG,qCAAqC,CAAC"}
1
+ {"version":3,"file":"checkGroup.js","sourceRoot":"","sources":["../checkGroup.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,mCAA6D;AAC7D,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuFG;AACH,MAAa,UAAW,SAAQ,MAAM,CAAC,cAAc;IAkGjD,YAAY,IAAY,EAAE,WAA8C,EAAE,IAAmC;QACzG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA0C,CAAC;YACzD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,2BAA2B,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClG,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,cAAc,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,wBAAwB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/F;aAAM;YACH,MAAM,IAAI,GAAG,WAAyC,CAAC;YACvD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,2BAA2B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,aAAM,CAAC,yCAAyC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3L,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,cAAc,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7F;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;IAtJD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAuB,EAAE,IAAmC;QACrH,OAAO,IAAI,UAAU,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACjE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,UAAU,CAAC,YAAY,CAAC;IAC3D,CAAC;;AA1BL,gCAwJC;AA1IG,gBAAgB;AACO,uBAAY,GAAG,qCAAqC,CAAC"}
package/bin/dashboard.d.ts CHANGED
@@ -1,4 +1,25 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
+ /**
3
+ * ## Example Usage
4
+ *
5
+ * ```typescript
6
+ * import * as pulumi from "@pulumi/pulumi";
7
+ * import * as checkly from "@pulumi/checkly";
8
+ *
9
+ * const dashboard_1 = new checkly.Dashboard("dashboard-1", {
10
+ * customDomain: "status.example.com",
11
+ * customUrl: "checkly",
12
+ * header: "Public dashboard",
13
+ * hideTags: false,
14
+ * logo: "https://www.checklyhq.com/logo.png",
15
+ * paginate: false,
16
+ * paginationRate: 30,
17
+ * refreshRate: 60,
18
+ * tags: ["production"],
19
+ * width: "FULL",
20
+ * });
21
+ * ```
22
+ */
2
23
  export declare class Dashboard extends pulumi.CustomResource {
3
24
  /**
4
25
  * Get an existing Dashboard resource's state with the given name, ID, and optional extra
@@ -15,15 +36,45 @@ export declare class Dashboard extends pulumi.CustomResource {
15
36
  * when multiple copies of the Pulumi SDK have been loaded into the same process.
16
37
  */
17
38
  static isInstance(obj: any): obj is Dashboard;
18
- readonly customDomain: pulumi.Output<string>;
39
+ /**
40
+ * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
41
+ */
42
+ readonly customDomain: pulumi.Output<string | undefined>;
43
+ /**
44
+ * A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
45
+ */
19
46
  readonly customUrl: pulumi.Output<string>;
20
- readonly header: pulumi.Output<string>;
21
- readonly hideTags: pulumi.Output<boolean>;
22
- readonly logo: pulumi.Output<string>;
23
- readonly paginate: pulumi.Output<boolean>;
24
- readonly paginationRate: pulumi.Output<number>;
25
- readonly refreshRate: pulumi.Output<number>;
47
+ /**
48
+ * A piece of text displayed at the top of your dashboard.
49
+ */
50
+ readonly header: pulumi.Output<string | undefined>;
51
+ /**
52
+ * Show or hide the tags on the dashboard.
53
+ */
54
+ readonly hideTags: pulumi.Output<boolean | undefined>;
55
+ /**
56
+ * A URL pointing to an image file.
57
+ */
58
+ readonly logo: pulumi.Output<string | undefined>;
59
+ /**
60
+ * Determines if pagination is on or off.
61
+ */
62
+ readonly paginate: pulumi.Output<boolean | undefined>;
63
+ /**
64
+ * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`.
65
+ */
66
+ readonly paginationRate: pulumi.Output<number | undefined>;
67
+ /**
68
+ * How often to refresh the dashboard in seconds. Possible values `30`, `60` and `600`.
69
+ */
70
+ readonly refreshRate: pulumi.Output<number | undefined>;
71
+ /**
72
+ * A list of one or more tags that filter which checks to display on the dashboard.
73
+ */
26
74
  readonly tags: pulumi.Output<string[] | undefined>;
75
+ /**
76
+ * Determines whether to use the full screen or focus in the center. Possible values `FULL` and `960PX`.
77
+ */
27
78
  readonly width: pulumi.Output<string | undefined>;
28
79
  /**
29
80
  * Create a Dashboard resource with the given unique name, arguments, and options.
@@ -38,29 +89,89 @@ export declare class Dashboard extends pulumi.CustomResource {
38
89
  * Input properties used for looking up and filtering Dashboard resources.
39
90
  */
40
91
  export interface DashboardState {
92
+ /**
93
+ * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
94
+ */
41
95
  customDomain?: pulumi.Input<string>;
96
+ /**
97
+ * A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
98
+ */
42
99
  customUrl?: pulumi.Input<string>;
100
+ /**
101
+ * A piece of text displayed at the top of your dashboard.
102
+ */
43
103
  header?: pulumi.Input<string>;
104
+ /**
105
+ * Show or hide the tags on the dashboard.
106
+ */
44
107
  hideTags?: pulumi.Input<boolean>;
108
+ /**
109
+ * A URL pointing to an image file.
110
+ */
45
111
  logo?: pulumi.Input<string>;
112
+ /**
113
+ * Determines if pagination is on or off.
114
+ */
46
115
  paginate?: pulumi.Input<boolean>;
116
+ /**
117
+ * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`.
118
+ */
47
119
  paginationRate?: pulumi.Input<number>;
120
+ /**
121
+ * How often to refresh the dashboard in seconds. Possible values `30`, `60` and `600`.
122
+ */
48
123
  refreshRate?: pulumi.Input<number>;
124
+ /**
125
+ * A list of one or more tags that filter which checks to display on the dashboard.
126
+ */
49
127
  tags?: pulumi.Input<pulumi.Input<string>[]>;
128
+ /**
129
+ * Determines whether to use the full screen or focus in the center. Possible values `FULL` and `960PX`.
130
+ */
50
131
  width?: pulumi.Input<string>;
51
132
  }
52
133
  /**
53
134
  * The set of arguments for constructing a Dashboard resource.
54
135
  */
55
136
  export interface DashboardArgs {
56
- customDomain: pulumi.Input<string>;
137
+ /**
138
+ * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
139
+ */
140
+ customDomain?: pulumi.Input<string>;
141
+ /**
142
+ * A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
143
+ */
57
144
  customUrl: pulumi.Input<string>;
58
- header: pulumi.Input<string>;
59
- hideTags: pulumi.Input<boolean>;
60
- logo: pulumi.Input<string>;
61
- paginate: pulumi.Input<boolean>;
62
- paginationRate: pulumi.Input<number>;
63
- refreshRate: pulumi.Input<number>;
145
+ /**
146
+ * A piece of text displayed at the top of your dashboard.
147
+ */
148
+ header?: pulumi.Input<string>;
149
+ /**
150
+ * Show or hide the tags on the dashboard.
151
+ */
152
+ hideTags?: pulumi.Input<boolean>;
153
+ /**
154
+ * A URL pointing to an image file.
155
+ */
156
+ logo?: pulumi.Input<string>;
157
+ /**
158
+ * Determines if pagination is on or off.
159
+ */
160
+ paginate?: pulumi.Input<boolean>;
161
+ /**
162
+ * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`.
163
+ */
164
+ paginationRate?: pulumi.Input<number>;
165
+ /**
166
+ * How often to refresh the dashboard in seconds. Possible values `30`, `60` and `600`.
167
+ */
168
+ refreshRate?: pulumi.Input<number>;
169
+ /**
170
+ * A list of one or more tags that filter which checks to display on the dashboard.
171
+ */
64
172
  tags?: pulumi.Input<pulumi.Input<string>[]>;
173
+ /**
174
+ * Determines whether to use the full screen or focus in the center. Possible values `FULL` and `960PX`.
175
+ */
65
176
  width?: pulumi.Input<string>;
66
177
  }
package/bin/dashboard.js CHANGED
@@ -5,6 +5,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
5
5
  exports.Dashboard = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
+ /**
9
+ * ## Example Usage
10
+ *
11
+ * ```typescript
12
+ * import * as pulumi from "@pulumi/pulumi";
13
+ * import * as checkly from "@pulumi/checkly";
14
+ *
15
+ * const dashboard_1 = new checkly.Dashboard("dashboard-1", {
16
+ * customDomain: "status.example.com",
17
+ * customUrl: "checkly",
18
+ * header: "Public dashboard",
19
+ * hideTags: false,
20
+ * logo: "https://www.checklyhq.com/logo.png",
21
+ * paginate: false,
22
+ * paginationRate: 30,
23
+ * refreshRate: 60,
24
+ * tags: ["production"],
25
+ * width: "FULL",
26
+ * });
27
+ * ```
28
+ */
8
29
  class Dashboard extends pulumi.CustomResource {
9
30
  constructor(name, argsOrState, opts) {
10
31
  let resourceInputs = {};
@@ -24,30 +45,9 @@ class Dashboard extends pulumi.CustomResource {
24
45
  }
25
46
  else {
26
47
  const args = argsOrState;
27
- if ((!args || args.customDomain === undefined) && !opts.urn) {
28
- throw new Error("Missing required property 'customDomain'");
29
- }
30
48
  if ((!args || args.customUrl === undefined) && !opts.urn) {
31
49
  throw new Error("Missing required property 'customUrl'");
32
50
  }
33
- if ((!args || args.header === undefined) && !opts.urn) {
34
- throw new Error("Missing required property 'header'");
35
- }
36
- if ((!args || args.hideTags === undefined) && !opts.urn) {
37
- throw new Error("Missing required property 'hideTags'");
38
- }
39
- if ((!args || args.logo === undefined) && !opts.urn) {
40
- throw new Error("Missing required property 'logo'");
41
- }
42
- if ((!args || args.paginate === undefined) && !opts.urn) {
43
- throw new Error("Missing required property 'paginate'");
44
- }
45
- if ((!args || args.paginationRate === undefined) && !opts.urn) {
46
- throw new Error("Missing required property 'paginationRate'");
47
- }
48
- if ((!args || args.refreshRate === undefined) && !opts.urn) {
49
- throw new Error("Missing required property 'refreshRate'");
50
- }
51
51
  resourceInputs["customDomain"] = args ? args.customDomain : undefined;
52
52
  resourceInputs["customUrl"] = args ? args.customUrl : undefined;
53
53
  resourceInputs["header"] = args ? args.header : undefined;
@@ -59,9 +59,7 @@ class Dashboard extends pulumi.CustomResource {
59
59
  resourceInputs["tags"] = args ? args.tags : undefined;
60
60
  resourceInputs["width"] = args ? args.width : undefined;
61
61
  }
62
- if (!opts.version) {
63
- opts = pulumi.mergeOptions(opts, { version: utilities.getVersion() });
64
- }
62
+ opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
65
63
  super(Dashboard.__pulumiType, name, resourceInputs, opts);
66
64
  }
67
65
  /**
package/bin/dashboard.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"dashboard.js","sourceRoot":"","sources":["../dashboard.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,MAAa,SAAU,SAAQ,MAAM,CAAC,cAAc;IA+ChD,YAAY,IAAY,EAAE,WAA4C,EAAE,IAAmC;QACvG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAyC,CAAC;YACxD,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7D;aAAM;YACH,MAAM,IAAI,GAAG,WAAwC,CAAC;YACtD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACzD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;aAC/D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjD,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC3D,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;aACjE;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;YACD,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3D;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,UAAU,EAAE,EAAC,CAAC,CAAC;SACxE;QACD,KAAK,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;IAtGD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAsB,EAAE,IAAmC;QACpH,OAAO,IAAI,SAAS,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAChE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,SAAS,CAAC,YAAY,CAAC;IAC1D,CAAC;;AA1BL,8BAwGC;AA1FG,gBAAgB;AACO,sBAAY,GAAG,mCAAmC,CAAC"}
1
+ {"version":3,"file":"dashboard.js","sourceRoot":"","sources":["../dashboard.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,SAAU,SAAQ,MAAM,CAAC,cAAc;IA6EhD,YAAY,IAAY,EAAE,WAA4C,EAAE,IAAmC;QACvG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAyC,CAAC;YACxD,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7D;aAAM;YACH,MAAM,IAAI,GAAG,WAAwC,CAAC;YACtD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3D;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;IA7GD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAsB,EAAE,IAAmC;QACpH,OAAO,IAAI,SAAS,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAChE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,SAAS,CAAC,YAAY,CAAC;IAC1D,CAAC;;AA1BL,8BA+GC;AAjGG,gBAAgB;AACO,sBAAY,GAAG,mCAAmC,CAAC"}