@checkly/pulumi 0.0.1-alpha.8 → 0.0.2

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 (78) hide show
  1. package/{bin/LICENSE → LICENSE} +0 -0
  2. package/README.md +8 -3
  3. package/{bin/alertChannel.d.ts → alertChannel.d.ts} +0 -0
  4. package/{bin/alertChannel.js → alertChannel.js} +0 -0
  5. package/{bin/alertChannel.js.map → alertChannel.js.map} +0 -0
  6. package/{bin/check.d.ts → check.d.ts} +0 -0
  7. package/{bin/check.js → check.js} +0 -0
  8. package/{bin/check.js.map → check.js.map} +0 -0
  9. package/{bin/checkGroup.d.ts → checkGroup.d.ts} +0 -0
  10. package/{bin/checkGroup.js → checkGroup.js} +0 -0
  11. package/{bin/checkGroup.js.map → checkGroup.js.map} +0 -0
  12. package/{bin/config → config}/index.d.ts +0 -0
  13. package/{bin/config → config}/index.js +0 -0
  14. package/{bin/config → config}/index.js.map +0 -0
  15. package/{bin/config → config}/vars.d.ts +0 -0
  16. package/{bin/config → config}/vars.js +0 -0
  17. package/{bin/config → config}/vars.js.map +0 -0
  18. package/{bin/dashboard.d.ts → dashboard.d.ts} +0 -0
  19. package/{bin/dashboard.js → dashboard.js} +0 -0
  20. package/{bin/dashboard.js.map → dashboard.js.map} +0 -0
  21. package/{bin/environmentVariable.d.ts → environmentVariable.d.ts} +0 -0
  22. package/{bin/environmentVariable.js → environmentVariable.js} +0 -0
  23. package/{bin/environmentVariable.js.map → environmentVariable.js.map} +0 -0
  24. package/{bin/index.d.ts → index.d.ts} +0 -0
  25. package/{bin/index.js → index.js} +0 -0
  26. package/{bin/index.js.map → index.js.map} +0 -0
  27. package/{bin/maintenanceWindow.d.ts → maintenanceWindow.d.ts} +0 -0
  28. package/{bin/maintenanceWindow.js → maintenanceWindow.js} +0 -0
  29. package/{bin/maintenanceWindow.js.map → maintenanceWindow.js.map} +0 -0
  30. package/package.json +27 -29
  31. package/{bin/package.json.bak → package.json.bak} +1 -1
  32. package/{bin/provider.d.ts → provider.d.ts} +0 -0
  33. package/{bin/provider.js → provider.js} +0 -0
  34. package/{bin/provider.js.map → provider.js.map} +0 -0
  35. package/scripts/install-pulumi-plugin.js +1 -1
  36. package/{bin/snippet.d.ts → snippet.d.ts} +0 -0
  37. package/{bin/snippet.js → snippet.js} +0 -0
  38. package/{bin/snippet.js.map → snippet.js.map} +0 -0
  39. package/{bin/triggerCheck.d.ts → triggerCheck.d.ts} +0 -0
  40. package/{bin/triggerCheck.js → triggerCheck.js} +0 -0
  41. package/{bin/triggerCheck.js.map → triggerCheck.js.map} +0 -0
  42. package/{bin/triggerCheckGroup.d.ts → triggerCheckGroup.d.ts} +0 -0
  43. package/{bin/triggerCheckGroup.js → triggerCheckGroup.js} +0 -0
  44. package/{bin/triggerCheckGroup.js.map → triggerCheckGroup.js.map} +0 -0
  45. package/{bin/types → types}/index.d.ts +0 -0
  46. package/{bin/types → types}/index.js +0 -0
  47. package/{bin/types → types}/index.js.map +0 -0
  48. package/{bin/types → types}/input.d.ts +0 -0
  49. package/{bin/types → types}/input.js +0 -0
  50. package/{bin/types → types}/input.js.map +0 -0
  51. package/{bin/types → types}/output.d.ts +0 -0
  52. package/{bin/types → types}/output.js +0 -0
  53. package/{bin/types → types}/output.js.map +0 -0
  54. package/{bin/utilities.d.ts → utilities.d.ts} +0 -0
  55. package/{bin/utilities.js → utilities.js} +1 -1
  56. package/{bin/utilities.js.map → utilities.js.map} +1 -1
  57. package/Pulumi.yaml +0 -0
  58. package/alertChannel.ts +0 -236
  59. package/bin/README.md +0 -151
  60. package/bin/package.json +0 -29
  61. package/bin/yarn.lock +0 -805
  62. package/check.ts +0 -453
  63. package/checkGroup.ts +0 -382
  64. package/config/index.ts +0 -5
  65. package/config/vars.ts +0 -33
  66. package/dashboard.ts +0 -231
  67. package/environmentVariable.ts +0 -107
  68. package/index.ts +0 -86
  69. package/maintenanceWindow.ts +0 -188
  70. package/provider.ts +0 -62
  71. package/snippet.ts +0 -98
  72. package/triggerCheck.ts +0 -123
  73. package/triggerCheckGroup.ts +0 -123
  74. package/tsconfig.json +0 -34
  75. package/types/index.ts +0 -11
  76. package/types/input.ts +0 -166
  77. package/types/output.ts +0 -167
  78. package/utilities.ts +0 -54
package/checkGroup.ts DELETED
@@ -1,382 +0,0 @@
1
- // *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
2
- // *** Do not edit by hand unless you're certain you know what you are doing! ***
3
-
4
- import * as pulumi from "@pulumi/pulumi";
5
- import { input as inputs, output as outputs } from "./types";
6
- import * as utilities from "./utilities";
7
-
8
- /**
9
- * Check groups allow you to group together a set of related checks, which can also share default settings for various attributes.
10
- *
11
- * ## Example Usage
12
- *
13
- * ```typescript
14
- * import * as pulumi from "@pulumi/pulumi";
15
- * import * as pulumi from "@checkly/pulumi";
16
- *
17
- * const test_group1CheckGroup = new checkly.CheckGroup("test-group1CheckGroup", {
18
- * activated: true,
19
- * muted: false,
20
- * tags: ["auto"],
21
- * locations: ["eu-west-1"],
22
- * concurrency: 3,
23
- * apiCheckDefaults: {
24
- * url: "http://example.com/",
25
- * headers: {
26
- * "X-Test": "foo",
27
- * },
28
- * queryParameters: {
29
- * query: "foo",
30
- * },
31
- * assertions: [
32
- * {
33
- * source: "STATUS_CODE",
34
- * property: "",
35
- * comparison: "EQUALS",
36
- * target: "200",
37
- * },
38
- * {
39
- * source: "TEXT_BODY",
40
- * property: "",
41
- * comparison: "CONTAINS",
42
- * target: "welcome",
43
- * },
44
- * ],
45
- * basicAuth: {
46
- * username: "user",
47
- * password: "pass",
48
- * },
49
- * },
50
- * environmentVariables: {
51
- * ENVTEST: "Hello world",
52
- * },
53
- * doubleCheck: true,
54
- * useGlobalAlertSettings: false,
55
- * alertSettings: {
56
- * escalationType: "RUN_BASED",
57
- * runBasedEscalations: [{
58
- * failedRunThreshold: 1,
59
- * }],
60
- * timeBasedEscalations: [{
61
- * minutesFailingThreshold: 5,
62
- * }],
63
- * reminders: [{
64
- * amount: 2,
65
- * interval: 5,
66
- * }],
67
- * },
68
- * localSetupScript: "setup-test",
69
- * localTeardownScript: "teardown-test",
70
- * });
71
- * // Add a check to a group
72
- * const test_check1 = new checkly.Check("test-check1", {
73
- * groupId: test_group1CheckGroup.id,
74
- * groupOrder: 1,
75
- * });
76
- * // Using with alert channels
77
- * const emailAc1 = new checkly.AlertChannel("emailAc1", {email: {
78
- * address: "info@example.com",
79
- * }});
80
- * const emailAc2 = new checkly.AlertChannel("emailAc2", {email: {
81
- * address: "info2@example.com",
82
- * }});
83
- * // Connect the check group to the alert channels
84
- * const test_group1Index_checkGroupCheckGroup = new checkly.CheckGroup("test-group1Index/checkGroupCheckGroup", {alertChannelSubscriptions: [
85
- * {
86
- * channelId: emailAc1.id,
87
- * activated: true,
88
- * },
89
- * {
90
- * channelId: emailAc2.id,
91
- * activated: true,
92
- * },
93
- * ]});
94
- * ```
95
- */
96
- export class CheckGroup extends pulumi.CustomResource {
97
- /**
98
- * Get an existing CheckGroup resource's state with the given name, ID, and optional extra
99
- * properties used to qualify the lookup.
100
- *
101
- * @param name The _unique_ name of the resulting resource.
102
- * @param id The _unique_ provider ID of the resource to lookup.
103
- * @param state Any extra arguments used during the lookup.
104
- * @param opts Optional settings to control the behavior of the CustomResource.
105
- */
106
- public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CheckGroupState, opts?: pulumi.CustomResourceOptions): CheckGroup {
107
- return new CheckGroup(name, <any>state, { ...opts, id: id });
108
- }
109
-
110
- /** @internal */
111
- public static readonly __pulumiType = 'checkly:index/checkGroup:CheckGroup';
112
-
113
- /**
114
- * Returns true if the given object is an instance of CheckGroup. This is designed to work even
115
- * when multiple copies of the Pulumi SDK have been loaded into the same process.
116
- */
117
- public static isInstance(obj: any): obj is CheckGroup {
118
- if (obj === undefined || obj === null) {
119
- return false;
120
- }
121
- return obj['__pulumiType'] === CheckGroup.__pulumiType;
122
- }
123
-
124
- /**
125
- * Determines if the checks in the group are running or not.
126
- */
127
- public readonly activated!: pulumi.Output<boolean>;
128
- public readonly alertChannelSubscriptions!: pulumi.Output<outputs.CheckGroupAlertChannelSubscription[] | undefined>;
129
- public readonly alertSettings!: pulumi.Output<outputs.CheckGroupAlertSettings>;
130
- public readonly apiCheckDefaults!: pulumi.Output<outputs.CheckGroupApiCheckDefaults>;
131
- /**
132
- * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
133
- */
134
- public readonly concurrency!: pulumi.Output<number>;
135
- /**
136
- * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
137
- * region before marking the check as failed.
138
- */
139
- public readonly doubleCheck!: pulumi.Output<boolean | undefined>;
140
- /**
141
- * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
142
- * Use global environment variables whenever possible.
143
- */
144
- public readonly environmentVariables!: pulumi.Output<{[key: string]: any} | undefined>;
145
- /**
146
- * A valid piece of Node.js code to run in the setup phase of an API check in this group.
147
- */
148
- public readonly localSetupScript!: pulumi.Output<string | undefined>;
149
- /**
150
- * A valid piece of Node.js code to run in the teardown phase of an API check in this group.
151
- */
152
- public readonly localTeardownScript!: pulumi.Output<string | undefined>;
153
- /**
154
- * An array of one or more data center locations where to run the checks.
155
- */
156
- public readonly locations!: pulumi.Output<string[]>;
157
- /**
158
- * Determines if any notifications will be sent out when a check in this group fails and/or recovers.
159
- */
160
- public readonly muted!: pulumi.Output<boolean | undefined>;
161
- /**
162
- * The name of the check group.
163
- */
164
- public readonly name!: pulumi.Output<string>;
165
- /**
166
- * The id of the runtime to use for this group.
167
- */
168
- public readonly runtimeId!: pulumi.Output<string | undefined>;
169
- /**
170
- * An ID reference to a snippet to use in the setup phase of an API check.
171
- */
172
- public readonly setupSnippetId!: pulumi.Output<number | undefined>;
173
- /**
174
- * Tags for organizing and filtering checks.
175
- */
176
- public readonly tags!: pulumi.Output<string[] | undefined>;
177
- /**
178
- * An ID reference to a snippet to use in the teardown phase of an API check.
179
- */
180
- public readonly teardownSnippetId!: pulumi.Output<number | undefined>;
181
- /**
182
- * When true, the account level alert settings will be used, not the alert setting defined on this check group.
183
- */
184
- public readonly useGlobalAlertSettings!: pulumi.Output<boolean | undefined>;
185
-
186
- /**
187
- * Create a CheckGroup resource with the given unique name, arguments, and options.
188
- *
189
- * @param name The _unique_ name of the resource.
190
- * @param args The arguments to use to populate this resource's properties.
191
- * @param opts A bag of options that control this resource's behavior.
192
- */
193
- constructor(name: string, args: CheckGroupArgs, opts?: pulumi.CustomResourceOptions)
194
- constructor(name: string, argsOrState?: CheckGroupArgs | CheckGroupState, opts?: pulumi.CustomResourceOptions) {
195
- let resourceInputs: pulumi.Inputs = {};
196
- opts = opts || {};
197
- if (opts.id) {
198
- const state = argsOrState as CheckGroupState | undefined;
199
- resourceInputs["activated"] = state ? state.activated : undefined;
200
- resourceInputs["alertChannelSubscriptions"] = state ? state.alertChannelSubscriptions : undefined;
201
- resourceInputs["alertSettings"] = state ? state.alertSettings : undefined;
202
- resourceInputs["apiCheckDefaults"] = state ? state.apiCheckDefaults : undefined;
203
- resourceInputs["concurrency"] = state ? state.concurrency : undefined;
204
- resourceInputs["doubleCheck"] = state ? state.doubleCheck : undefined;
205
- resourceInputs["environmentVariables"] = state ? state.environmentVariables : undefined;
206
- resourceInputs["localSetupScript"] = state ? state.localSetupScript : undefined;
207
- resourceInputs["localTeardownScript"] = state ? state.localTeardownScript : undefined;
208
- resourceInputs["locations"] = state ? state.locations : undefined;
209
- resourceInputs["muted"] = state ? state.muted : undefined;
210
- resourceInputs["name"] = state ? state.name : undefined;
211
- resourceInputs["runtimeId"] = state ? state.runtimeId : undefined;
212
- resourceInputs["setupSnippetId"] = state ? state.setupSnippetId : undefined;
213
- resourceInputs["tags"] = state ? state.tags : undefined;
214
- resourceInputs["teardownSnippetId"] = state ? state.teardownSnippetId : undefined;
215
- resourceInputs["useGlobalAlertSettings"] = state ? state.useGlobalAlertSettings : undefined;
216
- } else {
217
- const args = argsOrState as CheckGroupArgs | undefined;
218
- if ((!args || args.activated === undefined) && !opts.urn) {
219
- throw new Error("Missing required property 'activated'");
220
- }
221
- if ((!args || args.concurrency === undefined) && !opts.urn) {
222
- throw new Error("Missing required property 'concurrency'");
223
- }
224
- if ((!args || args.locations === undefined) && !opts.urn) {
225
- throw new Error("Missing required property 'locations'");
226
- }
227
- resourceInputs["activated"] = args ? args.activated : undefined;
228
- resourceInputs["alertChannelSubscriptions"] = args ? args.alertChannelSubscriptions : undefined;
229
- resourceInputs["alertSettings"] = args ? args.alertSettings : undefined;
230
- resourceInputs["apiCheckDefaults"] = args ? (args.apiCheckDefaults ? pulumi.output(args.apiCheckDefaults).apply(inputs.checkGroupApiCheckDefaultsProvideDefaults) : undefined) : undefined;
231
- resourceInputs["concurrency"] = args ? args.concurrency : undefined;
232
- resourceInputs["doubleCheck"] = args ? args.doubleCheck : undefined;
233
- resourceInputs["environmentVariables"] = args ? args.environmentVariables : undefined;
234
- resourceInputs["localSetupScript"] = args ? args.localSetupScript : undefined;
235
- resourceInputs["localTeardownScript"] = args ? args.localTeardownScript : undefined;
236
- resourceInputs["locations"] = args ? args.locations : undefined;
237
- resourceInputs["muted"] = args ? args.muted : undefined;
238
- resourceInputs["name"] = args ? args.name : undefined;
239
- resourceInputs["runtimeId"] = args ? args.runtimeId : undefined;
240
- resourceInputs["setupSnippetId"] = args ? args.setupSnippetId : undefined;
241
- resourceInputs["tags"] = args ? args.tags : undefined;
242
- resourceInputs["teardownSnippetId"] = args ? args.teardownSnippetId : undefined;
243
- resourceInputs["useGlobalAlertSettings"] = args ? args.useGlobalAlertSettings : undefined;
244
- }
245
- opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
246
- super(CheckGroup.__pulumiType, name, resourceInputs, opts);
247
- }
248
- }
249
-
250
- /**
251
- * Input properties used for looking up and filtering CheckGroup resources.
252
- */
253
- export interface CheckGroupState {
254
- /**
255
- * Determines if the checks in the group are running or not.
256
- */
257
- activated?: pulumi.Input<boolean>;
258
- alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertChannelSubscription>[]>;
259
- alertSettings?: pulumi.Input<inputs.CheckGroupAlertSettings>;
260
- apiCheckDefaults?: pulumi.Input<inputs.CheckGroupApiCheckDefaults>;
261
- /**
262
- * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
263
- */
264
- concurrency?: pulumi.Input<number>;
265
- /**
266
- * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
267
- * region before marking the check as failed.
268
- */
269
- doubleCheck?: pulumi.Input<boolean>;
270
- /**
271
- * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
272
- * Use global environment variables whenever possible.
273
- */
274
- environmentVariables?: pulumi.Input<{[key: string]: any}>;
275
- /**
276
- * A valid piece of Node.js code to run in the setup phase of an API check in this group.
277
- */
278
- localSetupScript?: pulumi.Input<string>;
279
- /**
280
- * A valid piece of Node.js code to run in the teardown phase of an API check in this group.
281
- */
282
- localTeardownScript?: pulumi.Input<string>;
283
- /**
284
- * An array of one or more data center locations where to run the checks.
285
- */
286
- locations?: pulumi.Input<pulumi.Input<string>[]>;
287
- /**
288
- * Determines if any notifications will be sent out when a check in this group fails and/or recovers.
289
- */
290
- muted?: pulumi.Input<boolean>;
291
- /**
292
- * The name of the check group.
293
- */
294
- name?: pulumi.Input<string>;
295
- /**
296
- * The id of the runtime to use for this group.
297
- */
298
- runtimeId?: pulumi.Input<string>;
299
- /**
300
- * An ID reference to a snippet to use in the setup phase of an API check.
301
- */
302
- setupSnippetId?: pulumi.Input<number>;
303
- /**
304
- * Tags for organizing and filtering checks.
305
- */
306
- tags?: pulumi.Input<pulumi.Input<string>[]>;
307
- /**
308
- * An ID reference to a snippet to use in the teardown phase of an API check.
309
- */
310
- teardownSnippetId?: pulumi.Input<number>;
311
- /**
312
- * When true, the account level alert settings will be used, not the alert setting defined on this check group.
313
- */
314
- useGlobalAlertSettings?: pulumi.Input<boolean>;
315
- }
316
-
317
- /**
318
- * The set of arguments for constructing a CheckGroup resource.
319
- */
320
- export interface CheckGroupArgs {
321
- /**
322
- * Determines if the checks in the group are running or not.
323
- */
324
- activated: pulumi.Input<boolean>;
325
- alertChannelSubscriptions?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertChannelSubscription>[]>;
326
- alertSettings?: pulumi.Input<inputs.CheckGroupAlertSettings>;
327
- apiCheckDefaults?: pulumi.Input<inputs.CheckGroupApiCheckDefaults>;
328
- /**
329
- * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
330
- */
331
- concurrency: pulumi.Input<number>;
332
- /**
333
- * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected
334
- * region before marking the check as failed.
335
- */
336
- doubleCheck?: pulumi.Input<boolean>;
337
- /**
338
- * Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks.
339
- * Use global environment variables whenever possible.
340
- */
341
- environmentVariables?: pulumi.Input<{[key: string]: any}>;
342
- /**
343
- * A valid piece of Node.js code to run in the setup phase of an API check in this group.
344
- */
345
- localSetupScript?: pulumi.Input<string>;
346
- /**
347
- * A valid piece of Node.js code to run in the teardown phase of an API check in this group.
348
- */
349
- localTeardownScript?: pulumi.Input<string>;
350
- /**
351
- * An array of one or more data center locations where to run the checks.
352
- */
353
- locations: pulumi.Input<pulumi.Input<string>[]>;
354
- /**
355
- * Determines if any notifications will be sent out when a check in this group fails and/or recovers.
356
- */
357
- muted?: pulumi.Input<boolean>;
358
- /**
359
- * The name of the check group.
360
- */
361
- name?: pulumi.Input<string>;
362
- /**
363
- * The id of the runtime to use for this group.
364
- */
365
- runtimeId?: pulumi.Input<string>;
366
- /**
367
- * An ID reference to a snippet to use in the setup phase of an API check.
368
- */
369
- setupSnippetId?: pulumi.Input<number>;
370
- /**
371
- * Tags for organizing and filtering checks.
372
- */
373
- tags?: pulumi.Input<pulumi.Input<string>[]>;
374
- /**
375
- * An ID reference to a snippet to use in the teardown phase of an API check.
376
- */
377
- teardownSnippetId?: pulumi.Input<number>;
378
- /**
379
- * When true, the account level alert settings will be used, not the alert setting defined on this check group.
380
- */
381
- useGlobalAlertSettings?: pulumi.Input<boolean>;
382
- }
package/config/index.ts DELETED
@@ -1,5 +0,0 @@
1
- // *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
2
- // *** Do not edit by hand unless you're certain you know what you are doing! ***
3
-
4
- // Export members:
5
- export * from "./vars";
package/config/vars.ts DELETED
@@ -1,33 +0,0 @@
1
- // *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
2
- // *** Do not edit by hand unless you're certain you know what you are doing! ***
3
-
4
- import * as pulumi from "@pulumi/pulumi";
5
- import * as utilities from "../utilities";
6
-
7
- declare var exports: any;
8
- const __config = new pulumi.Config("checkly");
9
-
10
- export declare const accountId: string | undefined;
11
- Object.defineProperty(exports, "accountId", {
12
- get() {
13
- return __config.get("accountId");
14
- },
15
- enumerable: true,
16
- });
17
-
18
- export declare const apiKey: string | undefined;
19
- Object.defineProperty(exports, "apiKey", {
20
- get() {
21
- return __config.get("apiKey");
22
- },
23
- enumerable: true,
24
- });
25
-
26
- export declare const apiUrl: string | undefined;
27
- Object.defineProperty(exports, "apiUrl", {
28
- get() {
29
- return __config.get("apiUrl");
30
- },
31
- enumerable: true,
32
- });
33
-
package/dashboard.ts DELETED
@@ -1,231 +0,0 @@
1
- // *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
2
- // *** Do not edit by hand unless you're certain you know what you are doing! ***
3
-
4
- import * as pulumi from "@pulumi/pulumi";
5
- import * as utilities from "./utilities";
6
-
7
- /**
8
- * ## Example Usage
9
- *
10
- * ```typescript
11
- * import * as pulumi from "@pulumi/pulumi";
12
- * import * as checkly from "@pulumi/checkly";
13
- *
14
- * const dashboard_1 = new checkly.Dashboard("dashboard-1", {
15
- * customDomain: "status.example.com",
16
- * customUrl: "checkly",
17
- * header: "Public dashboard",
18
- * hideTags: false,
19
- * logo: "https://www.checklyhq.com/logo.png",
20
- * paginate: false,
21
- * paginationRate: 30,
22
- * refreshRate: 60,
23
- * tags: ["production"],
24
- * width: "FULL",
25
- * });
26
- * ```
27
- */
28
- export class Dashboard extends pulumi.CustomResource {
29
- /**
30
- * Get an existing Dashboard resource's state with the given name, ID, and optional extra
31
- * properties used to qualify the lookup.
32
- *
33
- * @param name The _unique_ name of the resulting resource.
34
- * @param id The _unique_ provider ID of the resource to lookup.
35
- * @param state Any extra arguments used during the lookup.
36
- * @param opts Optional settings to control the behavior of the CustomResource.
37
- */
38
- public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DashboardState, opts?: pulumi.CustomResourceOptions): Dashboard {
39
- return new Dashboard(name, <any>state, { ...opts, id: id });
40
- }
41
-
42
- /** @internal */
43
- public static readonly __pulumiType = 'checkly:index/dashboard:Dashboard';
44
-
45
- /**
46
- * Returns true if the given object is an instance of Dashboard. This is designed to work even
47
- * when multiple copies of the Pulumi SDK have been loaded into the same process.
48
- */
49
- public static isInstance(obj: any): obj is Dashboard {
50
- if (obj === undefined || obj === null) {
51
- return false;
52
- }
53
- return obj['__pulumiType'] === Dashboard.__pulumiType;
54
- }
55
-
56
- /**
57
- * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
58
- */
59
- public readonly customDomain!: pulumi.Output<string | undefined>;
60
- /**
61
- * A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
62
- */
63
- public readonly customUrl!: pulumi.Output<string>;
64
- /**
65
- * A piece of text displayed at the top of your dashboard.
66
- */
67
- public readonly header!: pulumi.Output<string | undefined>;
68
- /**
69
- * Show or hide the tags on the dashboard.
70
- */
71
- public readonly hideTags!: pulumi.Output<boolean | undefined>;
72
- /**
73
- * A URL pointing to an image file.
74
- */
75
- public readonly logo!: pulumi.Output<string | undefined>;
76
- /**
77
- * Determines if pagination is on or off.
78
- */
79
- public readonly paginate!: pulumi.Output<boolean | undefined>;
80
- /**
81
- * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`.
82
- */
83
- public readonly paginationRate!: pulumi.Output<number | undefined>;
84
- /**
85
- * How often to refresh the dashboard in seconds. Possible values `30`, `60` and `600`.
86
- */
87
- public readonly refreshRate!: pulumi.Output<number | undefined>;
88
- /**
89
- * A list of one or more tags that filter which checks to display on the dashboard.
90
- */
91
- public readonly tags!: pulumi.Output<string[] | undefined>;
92
- /**
93
- * Determines whether to use the full screen or focus in the center. Possible values `FULL` and `960PX`.
94
- */
95
- public readonly width!: pulumi.Output<string | undefined>;
96
-
97
- /**
98
- * Create a Dashboard resource with the given unique name, arguments, and options.
99
- *
100
- * @param name The _unique_ name of the resource.
101
- * @param args The arguments to use to populate this resource's properties.
102
- * @param opts A bag of options that control this resource's behavior.
103
- */
104
- constructor(name: string, args: DashboardArgs, opts?: pulumi.CustomResourceOptions)
105
- constructor(name: string, argsOrState?: DashboardArgs | DashboardState, opts?: pulumi.CustomResourceOptions) {
106
- let resourceInputs: pulumi.Inputs = {};
107
- opts = opts || {};
108
- if (opts.id) {
109
- const state = argsOrState as DashboardState | undefined;
110
- resourceInputs["customDomain"] = state ? state.customDomain : undefined;
111
- resourceInputs["customUrl"] = state ? state.customUrl : undefined;
112
- resourceInputs["header"] = state ? state.header : undefined;
113
- resourceInputs["hideTags"] = state ? state.hideTags : undefined;
114
- resourceInputs["logo"] = state ? state.logo : undefined;
115
- resourceInputs["paginate"] = state ? state.paginate : undefined;
116
- resourceInputs["paginationRate"] = state ? state.paginationRate : undefined;
117
- resourceInputs["refreshRate"] = state ? state.refreshRate : undefined;
118
- resourceInputs["tags"] = state ? state.tags : undefined;
119
- resourceInputs["width"] = state ? state.width : undefined;
120
- } else {
121
- const args = argsOrState as DashboardArgs | undefined;
122
- if ((!args || args.customUrl === undefined) && !opts.urn) {
123
- throw new Error("Missing required property 'customUrl'");
124
- }
125
- resourceInputs["customDomain"] = args ? args.customDomain : undefined;
126
- resourceInputs["customUrl"] = args ? args.customUrl : undefined;
127
- resourceInputs["header"] = args ? args.header : undefined;
128
- resourceInputs["hideTags"] = args ? args.hideTags : undefined;
129
- resourceInputs["logo"] = args ? args.logo : undefined;
130
- resourceInputs["paginate"] = args ? args.paginate : undefined;
131
- resourceInputs["paginationRate"] = args ? args.paginationRate : undefined;
132
- resourceInputs["refreshRate"] = args ? args.refreshRate : undefined;
133
- resourceInputs["tags"] = args ? args.tags : undefined;
134
- resourceInputs["width"] = args ? args.width : undefined;
135
- }
136
- opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
137
- super(Dashboard.__pulumiType, name, resourceInputs, opts);
138
- }
139
- }
140
-
141
- /**
142
- * Input properties used for looking up and filtering Dashboard resources.
143
- */
144
- export interface DashboardState {
145
- /**
146
- * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
147
- */
148
- customDomain?: pulumi.Input<string>;
149
- /**
150
- * A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
151
- */
152
- customUrl?: pulumi.Input<string>;
153
- /**
154
- * A piece of text displayed at the top of your dashboard.
155
- */
156
- header?: pulumi.Input<string>;
157
- /**
158
- * Show or hide the tags on the dashboard.
159
- */
160
- hideTags?: pulumi.Input<boolean>;
161
- /**
162
- * A URL pointing to an image file.
163
- */
164
- logo?: pulumi.Input<string>;
165
- /**
166
- * Determines if pagination is on or off.
167
- */
168
- paginate?: pulumi.Input<boolean>;
169
- /**
170
- * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`.
171
- */
172
- paginationRate?: pulumi.Input<number>;
173
- /**
174
- * How often to refresh the dashboard in seconds. Possible values `30`, `60` and `600`.
175
- */
176
- refreshRate?: pulumi.Input<number>;
177
- /**
178
- * A list of one or more tags that filter which checks to display on the dashboard.
179
- */
180
- tags?: pulumi.Input<pulumi.Input<string>[]>;
181
- /**
182
- * Determines whether to use the full screen or focus in the center. Possible values `FULL` and `960PX`.
183
- */
184
- width?: pulumi.Input<string>;
185
- }
186
-
187
- /**
188
- * The set of arguments for constructing a Dashboard resource.
189
- */
190
- export interface DashboardArgs {
191
- /**
192
- * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
193
- */
194
- customDomain?: pulumi.Input<string>;
195
- /**
196
- * A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
197
- */
198
- customUrl: pulumi.Input<string>;
199
- /**
200
- * A piece of text displayed at the top of your dashboard.
201
- */
202
- header?: pulumi.Input<string>;
203
- /**
204
- * Show or hide the tags on the dashboard.
205
- */
206
- hideTags?: pulumi.Input<boolean>;
207
- /**
208
- * A URL pointing to an image file.
209
- */
210
- logo?: pulumi.Input<string>;
211
- /**
212
- * Determines if pagination is on or off.
213
- */
214
- paginate?: pulumi.Input<boolean>;
215
- /**
216
- * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`.
217
- */
218
- paginationRate?: pulumi.Input<number>;
219
- /**
220
- * How often to refresh the dashboard in seconds. Possible values `30`, `60` and `600`.
221
- */
222
- refreshRate?: pulumi.Input<number>;
223
- /**
224
- * A list of one or more tags that filter which checks to display on the dashboard.
225
- */
226
- tags?: pulumi.Input<pulumi.Input<string>[]>;
227
- /**
228
- * Determines whether to use the full screen or focus in the center. Possible values `FULL` and `960PX`.
229
- */
230
- width?: pulumi.Input<string>;
231
- }