@checkly/pulumi 0.0.1-alpha.0

package/bin/types/output.d.ts

@@ -0,0 +1,329 @@
+import { output as outputs } from "../types";
+export interface AlertChannelEmail {
+    /**
+     * the email address of this email alert channel.
+     */
+    address: string;
+}
+export interface AlertChannelOpsgenie {
+    /**
+     * .
+     */
+    apiKey: string;
+    /**
+     * Webhook's channel name.
+     */
+    name: string;
+    /**
+     * .
+     */
+    priority: string;
+    /**
+     * .
+     */
+    region: string;
+}
+export interface AlertChannelPagerduty {
+    /**
+     * Pagerduty's account name.
+     */
+    account?: string;
+    /**
+     * Pagerduty's service integration key.
+     */
+    serviceKey: string;
+    /**
+     * Pagerduty's service name.
+     */
+    serviceName?: string;
+}
+export interface AlertChannelSlack {
+    /**
+     * Slack's channel name.
+     */
+    channel: string;
+    /**
+     * .
+     */
+    url: string;
+}
+export interface AlertChannelSms {
+    /**
+     * Webhook's channel name.
+     */
+    name: string;
+    /**
+     * Mobile number to receive alerts.
+     */
+    number: string;
+}
+export interface AlertChannelWebhook {
+    /**
+     * .
+     */
+    headers: {
+        [key: string]: any;
+    };
+    /**
+     * Default is `POST`.
+     */
+    method?: string;
+    /**
+     * Webhook's channel name.
+     */
+    name: string;
+    /**
+     * .
+     */
+    queryParameters: {
+        [key: string]: any;
+    };
+    /**
+     * .
+     */
+    template?: string;
+    /**
+     * .
+     */
+    url: string;
+    /**
+     * .
+     */
+    webhookSecret?: string;
+}
+export interface CheckAlertChannelSubscription {
+    /**
+     * Determines if the check is running or not. Possible values `true`, and `false`.
+     */
+    activated: boolean;
+    channelId: number;
+}
+export interface CheckAlertSettings {
+    /**
+     * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
+     */
+    escalationType?: string;
+    /**
+     * . Possible arguments:
+     */
+    reminders?: outputs.CheckAlertSettingsReminder[];
+    /**
+     * . Possible arguments:
+     */
+    runBasedEscalations?: outputs.CheckAlertSettingsRunBasedEscalation[];
+    /**
+     * At what interval the reminders should be send.  Possible arguments:
+     */
+    sslCertificates?: outputs.CheckAlertSettingsSslCertificate[];
+    /**
+     * . Possible arguments:
+     */
+    timeBasedEscalations?: outputs.CheckAlertSettingsTimeBasedEscalation[];
+}
+export interface CheckAlertSettingsReminder {
+    /**
+     * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
+     */
+    amount?: number;
+    /**
+     * . Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
+     */
+    interval?: number;
+}
+export interface CheckAlertSettingsRunBasedEscalation {
+    /**
+     * After how many failed consecutive check runs an alert notification should be send. Possible values are between 1 and 5. Defaults to `1`.
+     */
+    failedRunThreshold?: number;
+}
+export interface CheckAlertSettingsSslCertificate {
+    /**
+     * At what moment in time to start alerting on SSL certificates. Possible values `3`, `7`, `14`, `30`. Defaults to `3`.
+     */
+    alertThreshold?: number;
+    /**
+     * Determines if alert notifications should be send for expiring SSL certificates. Possible values `true`, and `false`. Defaults to `true`.
+     */
+    enabled?: boolean;
+}
+export interface CheckAlertSettingsTimeBasedEscalation {
+    /**
+     * After how many minutes after a check starts failing an alert should be send. Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
+     */
+    minutesFailingThreshold?: number;
+}
+export interface CheckGroupAlertChannelSubscription {
+    /**
+     * Determines if the checks in the group are running or not.
+     */
+    activated: boolean;
+    channelId: number;
+}
+export interface CheckGroupAlertSettings {
+    /**
+     * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
+     */
+    escalationType?: string;
+    /**
+     * . Possible arguments:
+     */
+    reminders?: outputs.CheckGroupAlertSettingsReminder[];
+    /**
+     * . Possible arguments:
+     */
+    runBasedEscalations?: outputs.CheckGroupAlertSettingsRunBasedEscalation[];
+    /**
+     * At what interval the reminders should be send.  Possible arguments:
+     */
+    sslCertificates?: outputs.CheckGroupAlertSettingsSslCertificate[];
+    /**
+     * . Possible arguments:
+     */
+    timeBasedEscalations?: outputs.CheckGroupAlertSettingsTimeBasedEscalation[];
+}
+export interface CheckGroupAlertSettingsReminder {
+    /**
+     * How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
+     */
+    amount?: number;
+    /**
+     * . Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
+     */
+    interval?: number;
+}
+export interface CheckGroupAlertSettingsRunBasedEscalation {
+    /**
+     * After how many failed consecutive check runs an alert notification should be send. Possible values are between 1 and 5. Defaults to `1`.
+     */
+    failedRunThreshold?: number;
+}
+export interface CheckGroupAlertSettingsSslCertificate {
+    /**
+     * At what moment in time to start alerting on SSL certificates. Possible values `3`, `7`, `14`, `30`. Defaults to `3`.
+     */
+    alertThreshold?: number;
+    /**
+     * Determines if alert notifications should be send for expiring SSL certificates. Possible values `true`, and `false`. Defaults to `true`.
+     */
+    enabled?: boolean;
+}
+export interface CheckGroupAlertSettingsTimeBasedEscalation {
+    /**
+     * After how many minutes after a check starts failing an alert should be send. Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
+     */
+    minutesFailingThreshold?: number;
+}
+export interface CheckGroupApiCheckDefaults {
+    /**
+     * . Possible arguments:
+     */
+    assertions?: outputs.CheckGroupApiCheckDefaultsAssertion[];
+    /**
+     * . Possible arguments
+     */
+    basicAuth: outputs.CheckGroupApiCheckDefaultsBasicAuth;
+    /**
+     * .
+     */
+    headers: {
+        [key: string]: any;
+    };
+    /**
+     * .
+     */
+    queryParameters: {
+        [key: string]: any;
+    };
+    /**
+     * The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.
+     */
+    url: string;
+}
+/**
+ * checkGroupApiCheckDefaultsProvideDefaults sets the appropriate defaults for CheckGroupApiCheckDefaults
+ */
+export declare function checkGroupApiCheckDefaultsProvideDefaults(val: CheckGroupApiCheckDefaults): CheckGroupApiCheckDefaults;
+export interface CheckGroupApiCheckDefaultsAssertion {
+    /**
+     * Possible values `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
+     */
+    comparison: string;
+    /**
+     * .
+     */
+    property?: string;
+    /**
+     * Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
+     */
+    source: string;
+    target: string;
+}
+export interface CheckGroupApiCheckDefaultsBasicAuth {
+    password: string;
+    username: string;
+}
+export interface CheckRequest {
+    /**
+     * A request can have multiple assetions. Assertion has the following arguments:
+     */
+    assertions?: outputs.CheckRequestAssertion[];
+    /**
+     * A request might have one basicAuth config. basicAuth has two arguments:
+     */
+    basicAuth: outputs.CheckRequestBasicAuth;
+    body?: string;
+    /**
+     * Possible values `NONE`, `JSON`, `FORM`, `RAW`, and `GRAPHQL`.
+     */
+    bodyType?: string;
+    /**
+     * .
+     */
+    followRedirects?: boolean;
+    /**
+     * .
+     */
+    headers: {
+        [key: string]: any;
+    };
+    /**
+     * The HTTP method to use for this API check. Possible values are `GET`, `POST`, `PUT`, `HEAD`, `DELETE`, `PATCH`. Defaults to `GET`.
+     */
+    method?: string;
+    /**
+     * .
+     */
+    queryParameters: {
+        [key: string]: any;
+    };
+    /**
+     * .
+     */
+    skipSsl?: boolean;
+    /**
+     * .
+     */
+    url: string;
+}
+export interface CheckRequestAssertion {
+    /**
+     * Possible values `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
+     */
+    comparison: string;
+    /**
+     * .
+     */
+    property?: string;
+    /**
+     * Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
+     */
+    source: string;
+    /**
+     * .
+     */
+    target?: string;
+}
+export interface CheckRequestBasicAuth {
+    password: string;
+    username: string;
+}

package/bin/types/output.js

@@ -0,0 +1,14 @@
+"use strict";
+// *** 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! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkGroupApiCheckDefaultsProvideDefaults = void 0;
+/**
+ * checkGroupApiCheckDefaultsProvideDefaults sets the appropriate defaults for CheckGroupApiCheckDefaults
+ */
+function checkGroupApiCheckDefaultsProvideDefaults(val) {
+    var _a;
+    return Object.assign(Object.assign({}, val), { url: (_a = (val.url)) !== null && _a !== void 0 ? _a : "" });
+}
+exports.checkGroupApiCheckDefaultsProvideDefaults = checkGroupApiCheckDefaultsProvideDefaults;
+//# sourceMappingURL=output.js.map

package/bin/types/output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../../types/output.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAiQjF;;GAEG;AACH,SAAgB,yCAAyC,CAAC,GAA+B;;IACrF,uCACO,GAAG,KACN,GAAG,EAAE,MAAA,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,EAAE,IACtB;AACN,CAAC;AALD,8FAKC"}

package/bin/utilities.d.ts

@@ -0,0 +1,4 @@
+export declare function getEnv(...vars: string[]): string | undefined;
+export declare function getEnvBoolean(...vars: string[]): boolean | undefined;
+export declare function getEnvNumber(...vars: string[]): number | undefined;
+export declare function getVersion(): string;

package/bin/utilities.js

@@ -0,0 +1,52 @@
+"use strict";
+// *** 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! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVersion = exports.getEnvNumber = exports.getEnvBoolean = exports.getEnv = void 0;
+function getEnv(...vars) {
+    for (const v of vars) {
+        const value = process.env[v];
+        if (value) {
+            return value;
+        }
+    }
+    return undefined;
+}
+exports.getEnv = getEnv;
+function getEnvBoolean(...vars) {
+    const s = getEnv(...vars);
+    if (s !== undefined) {
+        // NOTE: these values are taken from https://golang.org/src/strconv/atob.go?s=351:391#L1, which is what
+        // Terraform uses internally when parsing boolean values.
+        if (["1", "t", "T", "true", "TRUE", "True"].find(v => v === s) !== undefined) {
+            return true;
+        }
+        if (["0", "f", "F", "false", "FALSE", "False"].find(v => v === s) !== undefined) {
+            return false;
+        }
+    }
+    return undefined;
+}
+exports.getEnvBoolean = getEnvBoolean;
+function getEnvNumber(...vars) {
+    const s = getEnv(...vars);
+    if (s !== undefined) {
+        const f = parseFloat(s);
+        if (!isNaN(f)) {
+            return f;
+        }
+    }
+    return undefined;
+}
+exports.getEnvNumber = getEnvNumber;
+function getVersion() {
+    let version = require('./package.json').version;
+    // Node allows for the version to be prefixed by a "v", while semver doesn't.
+    // If there is a v, strip it off.
+    if (version.indexOf('v') === 0) {
+        version = version.slice(1);
+    }
+    return version;
+}
+exports.getVersion = getVersion;
+//# sourceMappingURL=utilities.js.map

package/bin/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../utilities.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAGjF,SAAgB,MAAM,CAAC,GAAG,IAAc;IACpC,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;QAClB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,KAAK,EAAE;YACP,OAAO,KAAK,CAAC;SAChB;KACJ;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AARD,wBAQC;AAED,SAAgB,aAAa,CAAC,GAAG,IAAc;IAC3C,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,IAAI,CAAC,KAAK,SAAS,EAAE;QACjB,uGAAuG;QACvG,yDAAyD;QACzD,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,SAAS,EAAE;YAC1E,OAAO,IAAI,CAAC;SACf;QACD,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,SAAS,EAAE;YAC7E,OAAO,KAAK,CAAC;SAChB;KACJ;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAbD,sCAaC;AAED,SAAgB,YAAY,CAAC,GAAG,IAAc;IAC1C,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,IAAI,CAAC,KAAK,SAAS,EAAE;QACjB,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACX,OAAO,CAAC,CAAC;SACZ;KACJ;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AATD,oCASC;AAED,SAAgB,UAAU;IACtB,IAAI,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC;IAChD,6EAA6E;IAC7E,iCAAiC;IACjC,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC5B,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC9B;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AARD,gCAQC"}