@checkly/pulumi 0.0.1-alpha.9 → 0.0.1

package/README.md

@@ -1,4 +1,9 @@
-# Checkly Pulumi Provider
+<p>
+  <img height="128" src="https://www.checklyhq.com/images/footer-logo.svg" align="right" />
+  <h1>Checkly Pulumi Provider</h1>
+</p>
+
+![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)
 
 The Checkly Pulumi provider enables you to create and configure Checkly resources using your favourite programming language.
 Note that this project is in its early stages and breaking changes could happen.
@@ -25,7 +30,7 @@ yarn add @checkly/pulumi
 Install the provider binary plugin. This is only needed due to an outstanding bug in with Pulumi registry
 
 ```bash
-pulumi plugin install resource checkly v0.0.1-alpha.5 --server https://github.com/checkly/pulumi-checkly/releases/download/v0.0.1-alpha.5
+pulumi plugin install resource checkly v0.0.1-alpha.9 --server https://github.com/checkly/pulumi-checkly/releases/download/v0.0.1-alpha.9
 ```
 
 ### Python, Go & .NET
@@ -102,7 +107,7 @@ async function run () {
   const response = await page.goto('https://google.com')
 
   if (response.status() > 399) {
-    throw new Error('Failed with response code ${response.status()}')
+    throw new Error('Failed with response code \${response.status()}')
   }
 
   await page.screenshot({ path: 'screenshot.jpg' })

package/package.json

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

package/alertChannel.ts

@@ -1,236 +0,0 @@
-// *** 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 { input as inputs, output as outputs } from "./types";
-import * as utilities from "./utilities";
-
-/**
- * Allows you to define alerting channels for the checks and groups in your account
- *
- * ## Example Usage
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as pulumi from "@checkly/pulumi";
- *
- * // An Email alert channel
- * const emailAc = new checkly.AlertChannel("emailAc", {
- *     email: {
- *         address: "john@example.com",
- *     },
- *     sendRecovery: true,
- *     sendFailure: false,
- *     sendDegraded: true,
- *     sslExpiry: true,
- *     sslExpiryThreshold: 22,
- * });
- * // A SMS alert channel
- * const smsAc = new checkly.AlertChannel("smsAc", {
- *     sms: {
- *         name: "john",
- *         number: "+5491100001111",
- *     },
- *     sendRecovery: true,
- *     sendFailure: true,
- * });
- * // A Slack alert channel
- * const slackAc = new checkly.AlertChannel("slackAc", {slack: {
- *     channel: "#checkly-notifications",
- *     url: "https://slack.com/webhook",
- * }});
- * // An Opsgenie alert channel
- * const opsgenieAc = new checkly.AlertChannel("opsgenieAc", {opsgenie: {
- *     name: "opsalerts",
- *     apiKey: "fookey",
- *     region: "fooregion",
- *     priority: "foopriority",
- * }});
- * // An Pagerduty alert channel
- * const pagerdutyAc = new checkly.AlertChannel("pagerdutyAc", {pagerduty: {
- *     account: "checkly",
- *     serviceKey: "key1",
- *     serviceName: "pdalert",
- * }});
- * // An Webhook alert channel
- * const webhookAc = new checkly.AlertChannel("webhookAc", {webhook: {
- *     name: "foo",
- *     method: "get",
- *     template: "footemplate",
- *     url: "https://example.com/foo",
- *     webhookSecret: "foosecret",
- * }});
- * // Connecting the alert channel to a check
- * const example_check = new checkly.Check("example-check", {alertChannelSubscriptions: [
- *     {
- *         channelId: emailAc.id,
- *         activated: true,
- *     },
- *     {
- *         channelId: smsAc.id,
- *         activated: true,
- *     },
- * ]});
- * ```
- */
-export class AlertChannel extends pulumi.CustomResource {
-    /**
-     * Get an existing AlertChannel 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?: AlertChannelState, opts?: pulumi.CustomResourceOptions): AlertChannel {
-        return new AlertChannel(name, <any>state, { ...opts, id: id });
-    }
-
-    /** @internal */
-    public static readonly __pulumiType = 'checkly:index/alertChannel:AlertChannel';
-
-    /**
-     * Returns true if the given object is an instance of AlertChannel.  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 AlertChannel {
-        if (obj === undefined || obj === null) {
-            return false;
-        }
-        return obj['__pulumiType'] === AlertChannel.__pulumiType;
-    }
-
-    public readonly email!: pulumi.Output<outputs.AlertChannelEmail | undefined>;
-    public readonly opsgenie!: pulumi.Output<outputs.AlertChannelOpsgenie | undefined>;
-    public readonly pagerduty!: pulumi.Output<outputs.AlertChannelPagerduty | undefined>;
-    /**
-     * (Default `false`)
-     */
-    public readonly sendDegraded!: pulumi.Output<boolean | undefined>;
-    /**
-     * (Default `true`)
-     */
-    public readonly sendFailure!: pulumi.Output<boolean | undefined>;
-    /**
-     * (Default `true`)
-     */
-    public readonly sendRecovery!: pulumi.Output<boolean | undefined>;
-    public readonly slack!: pulumi.Output<outputs.AlertChannelSlack | undefined>;
-    public readonly sms!: pulumi.Output<outputs.AlertChannelSms | undefined>;
-    /**
-     * (Default `false`)
-     */
-    public readonly sslExpiry!: pulumi.Output<boolean | undefined>;
-    /**
-     * Value must be between 1 and 30 (Default `30`)
-     */
-    public readonly sslExpiryThreshold!: pulumi.Output<number | undefined>;
-    public readonly webhook!: pulumi.Output<outputs.AlertChannelWebhook | undefined>;
-
-    /**
-     * Create a AlertChannel 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?: AlertChannelArgs, opts?: pulumi.CustomResourceOptions)
-    constructor(name: string, argsOrState?: AlertChannelArgs | AlertChannelState, opts?: pulumi.CustomResourceOptions) {
-        let resourceInputs: pulumi.Inputs = {};
-        opts = opts || {};
-        if (opts.id) {
-            const state = argsOrState as AlertChannelState | undefined;
-            resourceInputs["email"] = state ? state.email : undefined;
-            resourceInputs["opsgenie"] = state ? state.opsgenie : undefined;
-            resourceInputs["pagerduty"] = state ? state.pagerduty : undefined;
-            resourceInputs["sendDegraded"] = state ? state.sendDegraded : undefined;
-            resourceInputs["sendFailure"] = state ? state.sendFailure : undefined;
-            resourceInputs["sendRecovery"] = state ? state.sendRecovery : undefined;
-            resourceInputs["slack"] = state ? state.slack : undefined;
-            resourceInputs["sms"] = state ? state.sms : undefined;
-            resourceInputs["sslExpiry"] = state ? state.sslExpiry : undefined;
-            resourceInputs["sslExpiryThreshold"] = state ? state.sslExpiryThreshold : undefined;
-            resourceInputs["webhook"] = state ? state.webhook : undefined;
-        } else {
-            const args = argsOrState as AlertChannelArgs | undefined;
-            resourceInputs["email"] = args ? args.email : undefined;
-            resourceInputs["opsgenie"] = args ? args.opsgenie : undefined;
-            resourceInputs["pagerduty"] = args ? args.pagerduty : undefined;
-            resourceInputs["sendDegraded"] = args ? args.sendDegraded : undefined;
-            resourceInputs["sendFailure"] = args ? args.sendFailure : undefined;
-            resourceInputs["sendRecovery"] = args ? args.sendRecovery : undefined;
-            resourceInputs["slack"] = args ? args.slack : undefined;
-            resourceInputs["sms"] = args ? args.sms : undefined;
-            resourceInputs["sslExpiry"] = args ? args.sslExpiry : undefined;
-            resourceInputs["sslExpiryThreshold"] = args ? args.sslExpiryThreshold : undefined;
-            resourceInputs["webhook"] = args ? args.webhook : undefined;
-        }
-        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
-        super(AlertChannel.__pulumiType, name, resourceInputs, opts);
-    }
-}
-
-/**
- * Input properties used for looking up and filtering AlertChannel resources.
- */
-export interface AlertChannelState {
-    email?: pulumi.Input<inputs.AlertChannelEmail>;
-    opsgenie?: pulumi.Input<inputs.AlertChannelOpsgenie>;
-    pagerduty?: pulumi.Input<inputs.AlertChannelPagerduty>;
-    /**
-     * (Default `false`)
-     */
-    sendDegraded?: pulumi.Input<boolean>;
-    /**
-     * (Default `true`)
-     */
-    sendFailure?: pulumi.Input<boolean>;
-    /**
-     * (Default `true`)
-     */
-    sendRecovery?: pulumi.Input<boolean>;
-    slack?: pulumi.Input<inputs.AlertChannelSlack>;
-    sms?: pulumi.Input<inputs.AlertChannelSms>;
-    /**
-     * (Default `false`)
-     */
-    sslExpiry?: pulumi.Input<boolean>;
-    /**
-     * Value must be between 1 and 30 (Default `30`)
-     */
-    sslExpiryThreshold?: pulumi.Input<number>;
-    webhook?: pulumi.Input<inputs.AlertChannelWebhook>;
-}
-
-/**
- * The set of arguments for constructing a AlertChannel resource.
- */
-export interface AlertChannelArgs {
-    email?: pulumi.Input<inputs.AlertChannelEmail>;
-    opsgenie?: pulumi.Input<inputs.AlertChannelOpsgenie>;
-    pagerduty?: pulumi.Input<inputs.AlertChannelPagerduty>;
-    /**
-     * (Default `false`)
-     */
-    sendDegraded?: pulumi.Input<boolean>;
-    /**
-     * (Default `true`)
-     */
-    sendFailure?: pulumi.Input<boolean>;
-    /**
-     * (Default `true`)
-     */
-    sendRecovery?: pulumi.Input<boolean>;
-    slack?: pulumi.Input<inputs.AlertChannelSlack>;
-    sms?: pulumi.Input<inputs.AlertChannelSms>;
-    /**
-     * (Default `false`)
-     */
-    sslExpiry?: pulumi.Input<boolean>;
-    /**
-     * Value must be between 1 and 30 (Default `30`)
-     */
-    sslExpiryThreshold?: pulumi.Input<number>;
-    webhook?: pulumi.Input<inputs.AlertChannelWebhook>;
-}

package/bin/README.md

@@ -1,151 +0,0 @@
-# Checkly Pulumi Provider
-
-The Checkly Pulumi provider enables you to create and configure Checkly resources using your favourite programming language.
-Note that this project is in its early stages and breaking changes could happen.
-
-## Installation
-
-1. To use this package, please [install the Pulumi CLI first](https://www.pulumi.com/docs/get-started/install/).
-2. This package is only available for JavaScript and TypeScript but support for other languages will be available soon.
-
-### Node.js (JavaScript/TypeScript)
-
-To use from JavaScript or TypeScript in Node.js, install using either `npm`:
-
-```bash
-npm install @checkly/pulumi
-```
-
-or `yarn`:
-
-```bash
-yarn add @checkly/pulumi
-```
-
-Install the provider binary plugin. This is only needed due to an outstanding bug in with Pulumi registry
-
-```bash
-pulumi plugin install resource checkly v0.0.1-alpha.5 --server https://github.com/checkly/pulumi-checkly/releases/download/v0.0.1-alpha.5
-```
-
-### Python, Go & .NET
-
-*TBA*
-
-## Authentication
-
-The Pulumi Checkly Provider needs to be configured with a Checkly `API Key` and `Account ID` before it can be used to create resources.
-
-> If you don't have an `API Key`, you can create one [here](https://app.checklyhq.com/settings/user/api-keys).
-
-Once you generated the `API Key` there are two ways to communicate your authorization tokens to Pulumi:
-
-1. Set the environment variables `CHECKLY_API_KEY` and `CHECKLY_ACCOUNT_ID`:
-    ```bash
-    $ export CHECKLY_API_KEY=cu_xxx
-    $ export CHECKLY_ACCOUNT_ID=xxx
-    ```
-
-2. Set them using `pulumi config` command, if you prefer that they be stored alongside your Pulumi stack for easy multi-user access:
-    ```bash
-    $ pulumi config set checkly:apiKey cu_xxx --secret
-    $ pulumi config set checkly:accountId xxx
-    ```
-
-> Remember to pass `--secret` when setting `checkly:apiKey` so it is properly encrypted.
-
-## Creating Resources
-
-The example below shows a basic API check and Browser check.
-
-```javascript
-// index.js
-const checkly = require("@checkly/pulumi")
-
-new checkly.Check("api-check", {
-  type: "API",
-  name: "Public SpaceX API",
-  activated: true,
-  frequency: 10,
-  locations: ["us-east-1"],
-  request: {
-    method: "GET",
-    url: "https://api.spacexdata.com/v3",
-    assertions: [
-      {
-        source: 'STATUS_CODE',
-        comparison: 'EQUALS',
-        target: 200
-      },
-      {
-        source: 'JSON_BODY',
-        property: '$.project_name',
-        comparison: 'EQUALS',
-        target: 'SpaceX-API'
-      }
-    ]
-  }
-})
-
-new checkly.Check("browser-check", {
-  type: "BROWSER",
-  name: "Google.com Playwright check",
-  activated: true,
-  frequency: 10,
-  locations: ["us-east-1"],
-  script: `const { chromium } = require('playwright')
-
-async function run () {
-  const browser = await chromium.launch()
-  const page = await browser.newPage()
-
-  const response = await page.goto('https://google.com')
-
-  if (response.status() > 399) {
-    throw new Error('Failed with response code ${response.status()}')
-  }
-
-  await page.screenshot({ path: 'screenshot.jpg' })
-
-  await page.close()
-  await browser.close()
-}
-
-run()`
-})
-```
-
-> Check the [examples directory](https://github.com/checkly/pulumi-checkly/tree/main/examples) for more detailed code samples.
-
-## Syncing resources
-
-Just run the regular `pulumi up` command
-
-
-## Configuration
-
-The following configuration points are available for the `foo` provider:
-
-- `checkly:apiKey` (environment: `CHECKLY_API_KEY`) - the Checkly API Key.
-- `checkly:accountId` (environment: `CHECKLY_ACCOUNT_ID`) - the Checkly account ID.
-
-## Reference
-
-For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/checkly/api-docs/).
-
-## License
-
-[MIT](https://github.com/checkly/pulumi-checkly/blob/main/LICENSE)
-
-<br>
-
-
-<p align="center">
-  <a href="https://checklyhq.com?utm_source=github&utm_medium=sponsor-logo-github&utm_campaign=pulumi-checkly" target="_blank">
-  <img width="100px" src="https://www.checklyhq.com/images/text_racoon_logo.svg" alt="Checkly" />
-  </a>
-  <br />
-  <i><sub>Delightful Active Monitoring for Developers</sub></i>
-  <br>
-  <b><sub>From Checkly with ♥️</sub></b>
-<p>

package/bin/package.json

@@ -1,29 +0,0 @@
-{
-    "name": "@checkly/pulumi",
-    "version": "v0.0.1-alpha.9",
-    "description": "A Pulumi package for creating and managing Checkly monitoring resources.",
-    "keywords": [
-        "pulumi",
-        "checkly",
-        "category/monitoring"
-    ],
-    "homepage": "https://www.pulumi.com/registry/packages/checkly",
-    "repository": "https://github.com/checkly/pulumi-checkly",
-    "license": "MIT",
-    "scripts": {
-        "build": "tsc",
-        "install": "node scripts/install-pulumi-plugin.js resource checkly v0.0.1-alpha.9"
-    },
-    "dependencies": {
-        "@pulumi/pulumi": "^3.0.0"
-    },
-    "devDependencies": {
-        "@types/mime": "^2.0.0",
-        "@types/node": "^10.0.0",
-        "typescript": "^4.3.5"
-    },
-    "pulumi": {
-        "resource": true,
-        "pluginDownloadURL": "https://github.com/checkly/pulumi-checkly/releases/download/v0.0.1-alpha.9"
-    }
-}