@checkly/pulumi 0.0.1-alpha.2 → 0.0.1-alpha.6

package/dashboard.ts

@@ -4,6 +4,27 @@
 import * as pulumi from "@pulumi/pulumi";
 import * as utilities from "./utilities";
 
+/**
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as checkly from "@pulumi/checkly";
+ *
+ * const dashboard_1 = new checkly.Dashboard("dashboard-1", {
+ *     customDomain: "status.example.com",
+ *     customUrl: "checkly",
+ *     header: "Public dashboard",
+ *     hideTags: false,
+ *     logo: "https://www.checklyhq.com/logo.png",
+ *     paginate: false,
+ *     paginationRate: 30,
+ *     refreshRate: 60,
+ *     tags: ["production"],
+ *     width: "FULL",
+ * });
+ * ```
+ */
 export class Dashboard extends pulumi.CustomResource {
     /**
      * Get an existing Dashboard resource's state with the given name, ID, and optional extra
@@ -32,15 +53,45 @@ export class Dashboard extends pulumi.CustomResource {
         return obj['__pulumiType'] === Dashboard.__pulumiType;
     }
 
-    public readonly customDomain!: pulumi.Output<string>;
+    /**
+     * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
+     */
+    public readonly customDomain!: pulumi.Output<string | undefined>;
+    /**
+     * A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
+     */
     public readonly customUrl!: pulumi.Output<string>;
-    public readonly header!: pulumi.Output<string>;
-    public readonly hideTags!: pulumi.Output<boolean>;
-    public readonly logo!: pulumi.Output<string>;
-    public readonly paginate!: pulumi.Output<boolean>;
-    public readonly paginationRate!: pulumi.Output<number>;
-    public readonly refreshRate!: pulumi.Output<number>;
+    /**
+     * A piece of text displayed at the top of your dashboard.
+     */
+    public readonly header!: pulumi.Output<string | undefined>;
+    /**
+     * Show or hide the tags on the dashboard.
+     */
+    public readonly hideTags!: pulumi.Output<boolean | undefined>;
+    /**
+     * A URL pointing to an image file.
+     */
+    public readonly logo!: pulumi.Output<string | undefined>;
+    /**
+     * Determines if pagination is on or off.
+     */
+    public readonly paginate!: pulumi.Output<boolean | undefined>;
+    /**
+     * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`.
+     */
+    public readonly paginationRate!: pulumi.Output<number | undefined>;
+    /**
+     * How often to refresh the dashboard in seconds. Possible values `30`, `60` and `600`.
+     */
+    public readonly refreshRate!: pulumi.Output<number | undefined>;
+    /**
+     * A list of one or more tags that filter which checks to display on the dashboard.
+     */
     public readonly tags!: pulumi.Output<string[] | undefined>;
+    /**
+     * Determines whether to use the full screen or focus in the center. Possible values `FULL` and `960PX`.
+     */
     public readonly width!: pulumi.Output<string | undefined>;
 
     /**
@@ -68,30 +119,9 @@ export class Dashboard extends pulumi.CustomResource {
             resourceInputs["width"] = state ? state.width : undefined;
         } else {
             const args = argsOrState as DashboardArgs | undefined;
-            if ((!args || args.customDomain === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'customDomain'");
-            }
             if ((!args || args.customUrl === undefined) && !opts.urn) {
                 throw new Error("Missing required property 'customUrl'");
             }
-            if ((!args || args.header === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'header'");
-            }
-            if ((!args || args.hideTags === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'hideTags'");
-            }
-            if ((!args || args.logo === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'logo'");
-            }
-            if ((!args || args.paginate === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'paginate'");
-            }
-            if ((!args || args.paginationRate === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'paginationRate'");
-            }
-            if ((!args || args.refreshRate === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'refreshRate'");
-            }
             resourceInputs["customDomain"] = args ? args.customDomain : undefined;
             resourceInputs["customUrl"] = args ? args.customUrl : undefined;
             resourceInputs["header"] = args ? args.header : undefined;
@@ -103,9 +133,7 @@ export class Dashboard extends pulumi.CustomResource {
             resourceInputs["tags"] = args ? args.tags : undefined;
             resourceInputs["width"] = args ? args.width : undefined;
         }
-        if (!opts.version) {
-            opts = pulumi.mergeOptions(opts, { version: utilities.getVersion()});
-        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(Dashboard.__pulumiType, name, resourceInputs, opts);
     }
 }
@@ -114,15 +142,45 @@ export class Dashboard extends pulumi.CustomResource {
  * Input properties used for looking up and filtering Dashboard resources.
  */
 export interface DashboardState {
+    /**
+     * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
+     */
     customDomain?: pulumi.Input<string>;
+    /**
+     * A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
+     */
     customUrl?: pulumi.Input<string>;
+    /**
+     * A piece of text displayed at the top of your dashboard.
+     */
     header?: pulumi.Input<string>;
+    /**
+     * Show or hide the tags on the dashboard.
+     */
     hideTags?: pulumi.Input<boolean>;
+    /**
+     * A URL pointing to an image file.
+     */
     logo?: pulumi.Input<string>;
+    /**
+     * Determines if pagination is on or off.
+     */
     paginate?: pulumi.Input<boolean>;
+    /**
+     * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`.
+     */
     paginationRate?: pulumi.Input<number>;
+    /**
+     * How often to refresh the dashboard in seconds. Possible values `30`, `60` and `600`.
+     */
     refreshRate?: pulumi.Input<number>;
+    /**
+     * A list of one or more tags that filter which checks to display on the dashboard.
+     */
     tags?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Determines whether to use the full screen or focus in the center. Possible values `FULL` and `960PX`.
+     */
     width?: pulumi.Input<string>;
 }
 
@@ -130,14 +188,44 @@ export interface DashboardState {
  * The set of arguments for constructing a Dashboard resource.
  */
 export interface DashboardArgs {
-    customDomain: pulumi.Input<string>;
+    /**
+     * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
+     */
+    customDomain?: pulumi.Input<string>;
+    /**
+     * A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
+     */
     customUrl: pulumi.Input<string>;
-    header: pulumi.Input<string>;
-    hideTags: pulumi.Input<boolean>;
-    logo: pulumi.Input<string>;
-    paginate: pulumi.Input<boolean>;
-    paginationRate: pulumi.Input<number>;
-    refreshRate: pulumi.Input<number>;
+    /**
+     * A piece of text displayed at the top of your dashboard.
+     */
+    header?: pulumi.Input<string>;
+    /**
+     * Show or hide the tags on the dashboard.
+     */
+    hideTags?: pulumi.Input<boolean>;
+    /**
+     * A URL pointing to an image file.
+     */
+    logo?: pulumi.Input<string>;
+    /**
+     * Determines if pagination is on or off.
+     */
+    paginate?: pulumi.Input<boolean>;
+    /**
+     * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`.
+     */
+    paginationRate?: pulumi.Input<number>;
+    /**
+     * How often to refresh the dashboard in seconds. Possible values `30`, `60` and `600`.
+     */
+    refreshRate?: pulumi.Input<number>;
+    /**
+     * A list of one or more tags that filter which checks to display on the dashboard.
+     */
     tags?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Determines whether to use the full screen or focus in the center. Possible values `FULL` and `960PX`.
+     */
     width?: pulumi.Input<string>;
 }

package/environmentVariable.ts

@@ -0,0 +1,107 @@
+// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import * as pulumi from "@pulumi/pulumi";
+import * as utilities from "./utilities";
+
+/**
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as checkly from "@pulumi/checkly";
+ *
+ * // Simple Enviroment Variable example
+ * const variable_1 = new checkly.EnvironmentVariable("variable-1", {
+ *     key: "API_KEY",
+ *     locked: true,
+ *     value: "loZd9hOGHDUrGvmW",
+ * });
+ * const variable_2 = new checkly.EnvironmentVariable("variable-2", {
+ *     key: "API_URL",
+ *     value: "http://localhost:3000",
+ * });
+ * ```
+ */
+export class EnvironmentVariable extends pulumi.CustomResource {
+    /**
+     * Get an existing EnvironmentVariable resource's state with the given name, ID, and optional extra
+     * properties used to qualify the lookup.
+     *
+     * @param name The _unique_ name of the resulting resource.
+     * @param id The _unique_ provider ID of the resource to lookup.
+     * @param state Any extra arguments used during the lookup.
+     * @param opts Optional settings to control the behavior of the CustomResource.
+     */
+    public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EnvironmentVariableState, opts?: pulumi.CustomResourceOptions): EnvironmentVariable {
+        return new EnvironmentVariable(name, <any>state, { ...opts, id: id });
+    }
+
+    /** @internal */
+    public static readonly __pulumiType = 'checkly:index/environmentVariable:EnvironmentVariable';
+
+    /**
+     * Returns true if the given object is an instance of EnvironmentVariable.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    public static isInstance(obj: any): obj is EnvironmentVariable {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === EnvironmentVariable.__pulumiType;
+    }
+
+    public readonly key!: pulumi.Output<string>;
+    public readonly locked!: pulumi.Output<boolean | undefined>;
+    public readonly value!: pulumi.Output<string>;
+
+    /**
+     * Create a EnvironmentVariable resource with the given unique name, arguments, and options.
+     *
+     * @param name The _unique_ name of the resource.
+     * @param args The arguments to use to populate this resource's properties.
+     * @param opts A bag of options that control this resource's behavior.
+     */
+    constructor(name: string, args: EnvironmentVariableArgs, opts?: pulumi.CustomResourceOptions)
+    constructor(name: string, argsOrState?: EnvironmentVariableArgs | EnvironmentVariableState, opts?: pulumi.CustomResourceOptions) {
+        let resourceInputs: pulumi.Inputs = {};
+        opts = opts || {};
+        if (opts.id) {
+            const state = argsOrState as EnvironmentVariableState | undefined;
+            resourceInputs["key"] = state ? state.key : undefined;
+            resourceInputs["locked"] = state ? state.locked : undefined;
+            resourceInputs["value"] = state ? state.value : undefined;
+        } else {
+            const args = argsOrState as EnvironmentVariableArgs | undefined;
+            if ((!args || args.key === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'key'");
+            }
+            if ((!args || args.value === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'value'");
+            }
+            resourceInputs["key"] = args ? args.key : undefined;
+            resourceInputs["locked"] = args ? args.locked : undefined;
+            resourceInputs["value"] = args ? args.value : undefined;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        super(EnvironmentVariable.__pulumiType, name, resourceInputs, opts);
+    }
+}
+
+/**
+ * Input properties used for looking up and filtering EnvironmentVariable resources.
+ */
+export interface EnvironmentVariableState {
+    key?: pulumi.Input<string>;
+    locked?: pulumi.Input<boolean>;
+    value?: pulumi.Input<string>;
+}
+
+/**
+ * The set of arguments for constructing a EnvironmentVariable resource.
+ */
+export interface EnvironmentVariableArgs {
+    key: pulumi.Input<string>;
+    locked?: pulumi.Input<boolean>;
+    value: pulumi.Input<string>;
+}

package/index.ts

@@ -9,6 +9,7 @@ export * from "./alertChannel";
 export * from "./check";
 export * from "./checkGroup";
 export * from "./dashboard";
+export * from "./environmentVariable";
 export * from "./maintenanceWindow";
 export * from "./provider";
 export * from "./snippet";
@@ -29,6 +30,7 @@ import { AlertChannel } from "./alertChannel";
 import { Check } from "./check";
 import { CheckGroup } from "./checkGroup";
 import { Dashboard } from "./dashboard";
+import { EnvironmentVariable } from "./environmentVariable";
 import { MaintenanceWindow } from "./maintenanceWindow";
 import { Snippet } from "./snippet";
 import { TriggerCheck } from "./triggerCheck";
@@ -46,6 +48,8 @@ const _module = {
                 return new CheckGroup(name, <any>undefined, { urn })
             case "checkly:index/dashboard:Dashboard":
                 return new Dashboard(name, <any>undefined, { urn })
+            case "checkly:index/environmentVariable:EnvironmentVariable":
+                return new EnvironmentVariable(name, <any>undefined, { urn })
             case "checkly:index/maintenanceWindow:MaintenanceWindow":
                 return new MaintenanceWindow(name, <any>undefined, { urn })
             case "checkly:index/snippet:Snippet":
@@ -63,6 +67,7 @@ pulumi.runtime.registerResourceModule("checkly", "index/alertChannel", _module)
 pulumi.runtime.registerResourceModule("checkly", "index/check", _module)
 pulumi.runtime.registerResourceModule("checkly", "index/checkGroup", _module)
 pulumi.runtime.registerResourceModule("checkly", "index/dashboard", _module)
+pulumi.runtime.registerResourceModule("checkly", "index/environmentVariable", _module)
 pulumi.runtime.registerResourceModule("checkly", "index/maintenanceWindow", _module)
 pulumi.runtime.registerResourceModule("checkly", "index/snippet", _module)
 pulumi.runtime.registerResourceModule("checkly", "index/triggerCheck", _module)

package/maintenanceWindow.ts

@@ -5,28 +5,8 @@ import * as pulumi from "@pulumi/pulumi";
 import * as utilities from "./utilities";
 
 /**
- * ## # checkly.MaintenanceWindow
- *
- * `checkly.MaintenanceWindow` allows users to manage Checkly maintenance windows. Add a `checkly.MaintenanceWindow` resource to your resource file.
- *
  * ## Example Usage
  *
- * Minimal maintenance windows example
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
- *
- * const maintenance_1 = new checkly.MaintenanceWindow("maintenance-1", {
- *     endsAt: "2014-08-25T00:00:00.000Z",
- *     repeatUnit: "MONTH",
- *     startsAt: "2014-08-24T00:00:00.000Z",
- *     tags: ["auto"],
- * });
- * ```
- *
- * Full maintenance windows example (includes optional fields)
- *
  * ```typescript
  * import * as pulumi from "@pulumi/pulumi";
  * import * as checkly from "@pulumi/checkly";
@@ -37,7 +17,7 @@ import * as utilities from "./utilities";
  *     repeatInterval: 1,
  *     repeatUnit: "MONTH",
  *     startsAt: "2014-08-24T00:00:00.000Z",
- *     tags: ["auto"],
+ *     tags: ["production"],
  * });
  * ```
  */
@@ -78,17 +58,17 @@ export class MaintenanceWindow extends pulumi.CustomResource {
      */
     public readonly name!: pulumi.Output<string>;
     /**
-     * The end date where the maintenance window should stop repeating.
+     * The date on which the maintenance window should stop repeating.
      */
-    public readonly repeatEndsAt!: pulumi.Output<string>;
+    public readonly repeatEndsAt!: pulumi.Output<string | undefined>;
     /**
-     * The repeat interval of the maintenance window from the first occurance.
+     * The repeat interval of the maintenance window from the first occurrence.
      */
-    public readonly repeatInterval!: pulumi.Output<number>;
+    public readonly repeatInterval!: pulumi.Output<number | undefined>;
     /**
-     * The repeat strategy for the maintenance window. Possible values `DAY`, `WEEK` and `MONTH`.
+     * The repeat cadence for the maintenance window. Possible values `DAY`, `WEEK` and `MONTH`.
      */
-    public readonly repeatUnit!: pulumi.Output<string>;
+    public readonly repeatUnit!: pulumi.Output<string | undefined>;
     /**
      * The start date of the maintenance window.
      */
@@ -123,15 +103,6 @@ export class MaintenanceWindow extends pulumi.CustomResource {
             if ((!args || args.endsAt === undefined) && !opts.urn) {
                 throw new Error("Missing required property 'endsAt'");
             }
-            if ((!args || args.repeatEndsAt === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'repeatEndsAt'");
-            }
-            if ((!args || args.repeatInterval === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'repeatInterval'");
-            }
-            if ((!args || args.repeatUnit === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'repeatUnit'");
-            }
             if ((!args || args.startsAt === undefined) && !opts.urn) {
                 throw new Error("Missing required property 'startsAt'");
             }
@@ -143,9 +114,7 @@ export class MaintenanceWindow extends pulumi.CustomResource {
             resourceInputs["startsAt"] = args ? args.startsAt : undefined;
             resourceInputs["tags"] = args ? args.tags : undefined;
         }
-        if (!opts.version) {
-            opts = pulumi.mergeOptions(opts, { version: utilities.getVersion()});
-        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(MaintenanceWindow.__pulumiType, name, resourceInputs, opts);
     }
 }
@@ -163,15 +132,15 @@ export interface MaintenanceWindowState {
      */
     name?: pulumi.Input<string>;
     /**
-     * The end date where the maintenance window should stop repeating.
+     * The date on which the maintenance window should stop repeating.
      */
     repeatEndsAt?: pulumi.Input<string>;
     /**
-     * The repeat interval of the maintenance window from the first occurance.
+     * The repeat interval of the maintenance window from the first occurrence.
      */
     repeatInterval?: pulumi.Input<number>;
     /**
-     * The repeat strategy for the maintenance window. Possible values `DAY`, `WEEK` and `MONTH`.
+     * The repeat cadence for the maintenance window. Possible values `DAY`, `WEEK` and `MONTH`.
      */
     repeatUnit?: pulumi.Input<string>;
     /**
@@ -197,17 +166,17 @@ export interface MaintenanceWindowArgs {
      */
     name?: pulumi.Input<string>;
     /**
-     * The end date where the maintenance window should stop repeating.
+     * The date on which the maintenance window should stop repeating.
      */
-    repeatEndsAt: pulumi.Input<string>;
+    repeatEndsAt?: pulumi.Input<string>;
     /**
-     * The repeat interval of the maintenance window from the first occurance.
+     * The repeat interval of the maintenance window from the first occurrence.
      */
-    repeatInterval: pulumi.Input<number>;
+    repeatInterval?: pulumi.Input<number>;
     /**
-     * The repeat strategy for the maintenance window. Possible values `DAY`, `WEEK` and `MONTH`.
+     * The repeat cadence for the maintenance window. Possible values `DAY`, `WEEK` and `MONTH`.
      */
-    repeatUnit: pulumi.Input<string>;
+    repeatUnit?: pulumi.Input<string>;
     /**
      * The start date of the maintenance window.
      */

package/package.json

@@ -1,9 +1,7 @@
 {
   "name": "@checkly/pulumi",
-  "version": "0.0.1-alpha.2",
+  "version": "0.0.1-alpha.6",
   "description": "A Pulumi package for creating and managing Checkly monitoring resources.",
-  "main": "./bin/index.js",
-  "types": "./bin/index.d.ts",
   "keywords": [
     "pulumi",
     "checkly",
@@ -13,7 +11,8 @@
   "repository": "https://github.com/checkly/pulumi-checkly",
   "license": "MIT",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "install": "node scripts/install-pulumi-plugin.js resource checkly ${VERSION}"
   },
   "dependencies": {
     "@pulumi/pulumi": "^3.0.0"
@@ -25,6 +24,8 @@
   },
   "pulumi": {
     "resource": true,
-    "pluginDownloadURL": "https://github.com/checkly/pulumi-checkly/releases/0.0.1-alpha.2"
-  }
+    "pluginDownloadURL": "https://github.com/checkly/pulumi-checkly/releases/0.0.1-alpha.6"
+  },
+  "main": "./bin/index.js",
+  "types": "./bin/index.d.ts"
 }

package/provider.ts

@@ -47,9 +47,7 @@ export class Provider extends pulumi.ProviderResource {
             resourceInputs["apiKey"] = args ? args.apiKey : undefined;
             resourceInputs["apiUrl"] = args ? args.apiUrl : undefined;
         }
-        if (!opts.version) {
-            opts = pulumi.mergeOptions(opts, { version: utilities.getVersion()});
-        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(Provider.__pulumiType, name, resourceInputs, opts);
     }
 }

package/scripts/install-pulumi-plugin.js

@@ -0,0 +1,26 @@
+"use strict";
+var childProcess = require("child_process");
+
+var args = process.argv.slice(2);
+
+if (args.indexOf("${VERSION}") !== -1) {
+	process.exit(0);
+}
+
+var res = childProcess.spawnSync("pulumi", ["plugin", "install", "--server", "https://github.com/checkly/pulumi-checkly/releases/${VERSION}"].concat(args), {
+    stdio: ["ignore", "inherit", "inherit"]
+});
+
+if (res.error && res.error.code === "ENOENT") {
+    console.error("\nThere was an error installing the resource provider plugin. " +
+            "It looks like `pulumi` is not installed on your system. " +
+            "Please visit https://pulumi.com/ to install the Pulumi CLI.\n" +
+            "You may try manually installing the plugin by running " +
+            "`pulumi plugin install " + args.join(" ") + "`");
+} else if (res.error || res.status !== 0) {
+    console.error("\nThere was an error installing the resource provider plugin. " +
+            "You may try to manually installing the plugin by running " +
+            "`pulumi plugin install " + args.join(" ") + "`");
+}
+
+process.exit(0);

package/snippet.ts

@@ -33,7 +33,7 @@ export class Snippet extends pulumi.CustomResource {
     }
 
     /**
-     * The name of the snippet.
+     * The name of the snippet
      */
     public readonly name!: pulumi.Output<string>;
     /**
@@ -64,9 +64,7 @@ export class Snippet extends pulumi.CustomResource {
             resourceInputs["name"] = args ? args.name : undefined;
             resourceInputs["script"] = args ? args.script : undefined;
         }
-        if (!opts.version) {
-            opts = pulumi.mergeOptions(opts, { version: utilities.getVersion()});
-        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(Snippet.__pulumiType, name, resourceInputs, opts);
     }
 }
@@ -76,7 +74,7 @@ export class Snippet extends pulumi.CustomResource {
  */
 export interface SnippetState {
     /**
-     * The name of the snippet.
+     * The name of the snippet
      */
     name?: pulumi.Input<string>;
     /**
@@ -90,7 +88,7 @@ export interface SnippetState {
  */
 export interface SnippetArgs {
     /**
-     * The name of the snippet.
+     * The name of the snippet
      */
     name?: pulumi.Input<string>;
     /**

package/triggerCheck.ts

@@ -5,17 +5,11 @@ import * as pulumi from "@pulumi/pulumi";
 import * as utilities from "./utilities";
 
 /**
- * ## # checkly.TriggerCheck
- *
- * `checkly.TriggerCheck` allows users to manage Checkly trigger checks. Add a `checkly.TriggerCheck` resource to your resource file.
- *
  * ## Example Usage
  *
- * Trigger check example
- *
  * ```typescript
  * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
+ * import * as pulumi from "@checkly/pulumi";
  *
  * const test_trigger_check = new checkly.TriggerCheck("test-trigger-check", {checkId: "c1ff95c5-d7f6-4a90-9ce2-1e605f117592"});
  * export const test_trigger_check_url = test_trigger_check.url;
@@ -53,7 +47,13 @@ export class TriggerCheck extends pulumi.CustomResource {
      * The id of the check that you want to attach the trigger to.
      */
     public readonly checkId!: pulumi.Output<string>;
+    /**
+     * The token value created to trigger the check
+     */
     public readonly token!: pulumi.Output<string>;
+    /**
+     * The request URL to trigger the check run.
+     */
     public readonly url!: pulumi.Output<string>;
 
     /**
@@ -81,9 +81,7 @@ export class TriggerCheck extends pulumi.CustomResource {
             resourceInputs["token"] = args ? args.token : undefined;
             resourceInputs["url"] = args ? args.url : undefined;
         }
-        if (!opts.version) {
-            opts = pulumi.mergeOptions(opts, { version: utilities.getVersion()});
-        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(TriggerCheck.__pulumiType, name, resourceInputs, opts);
     }
 }
@@ -96,7 +94,13 @@ export interface TriggerCheckState {
      * The id of the check that you want to attach the trigger to.
      */
     checkId?: pulumi.Input<string>;
+    /**
+     * The token value created to trigger the check
+     */
     token?: pulumi.Input<string>;
+    /**
+     * The request URL to trigger the check run.
+     */
     url?: pulumi.Input<string>;
 }
 
@@ -108,6 +112,12 @@ export interface TriggerCheckArgs {
      * The id of the check that you want to attach the trigger to.
      */
     checkId: pulumi.Input<string>;
+    /**
+     * The token value created to trigger the check
+     */
     token?: pulumi.Input<string>;
+    /**
+     * The request URL to trigger the check run.
+     */
     url?: pulumi.Input<string>;
 }