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

package/triggerCheckGroup.ts

@@ -5,17 +5,11 @@ import * as pulumi from "@pulumi/pulumi";
 import * as utilities from "./utilities";
 
 /**
- * ## # checkly.TriggerCheckGroup
- *
- * `checkly.TriggerCheckGroup` allows users to manage Checkly trigger groups. Add a `checkly.TriggerCheckGroup` resource to your resource file.
- *
  * ## Example Usage
  *
- * Trigger group example
- *
  * ```typescript
  * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
+ * import * as pulumi from "@checkly/pulumi";
  *
  * const test_trigger_group = new checkly.TriggerCheckGroup("test-trigger-group", {groupId: "215"});
  * export const test_trigger_group_url = test_trigger_group.url;
@@ -53,7 +47,13 @@ export class TriggerCheckGroup extends pulumi.CustomResource {
      * The id of the group that you want to attach the trigger to.
      */
     public readonly groupId!: pulumi.Output<number>;
+    /**
+     * The token value created to trigger the group
+     */
     public readonly token!: pulumi.Output<string>;
+    /**
+     * The request URL to trigger the group run.
+     */
     public readonly url!: pulumi.Output<string>;
 
     /**
@@ -81,9 +81,7 @@ export class TriggerCheckGroup 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(TriggerCheckGroup.__pulumiType, name, resourceInputs, opts);
     }
 }
@@ -96,7 +94,13 @@ export interface TriggerCheckGroupState {
      * The id of the group that you want to attach the trigger to.
      */
     groupId?: pulumi.Input<number>;
+    /**
+     * The token value created to trigger the group
+     */
     token?: pulumi.Input<string>;
+    /**
+     * The request URL to trigger the group run.
+     */
     url?: pulumi.Input<string>;
 }
 
@@ -108,6 +112,12 @@ export interface TriggerCheckGroupArgs {
      * The id of the group that you want to attach the trigger to.
      */
     groupId: pulumi.Input<number>;
+    /**
+     * The token value created to trigger the group
+     */
     token?: pulumi.Input<string>;
+    /**
+     * The request URL to trigger the group run.
+     */
     url?: pulumi.Input<string>;
 }

package/tsconfig.json

@@ -19,6 +19,7 @@
         "config/index.ts",
         "config/vars.ts",
         "dashboard.ts",
+        "environmentVariable.ts",
         "index.ts",
         "maintenanceWindow.ts",
         "provider.ts",

package/types/input.ts

@@ -7,253 +7,115 @@ import { input as inputs, output as outputs } from "../types";
 import * as utilities from "../utilities";
 
 export interface AlertChannelEmail {
-    /**
-     * the email address of this email alert channel.
-     */
     address: pulumi.Input<string>;
 }
 
 export interface AlertChannelOpsgenie {
-    /**
-     * .
-     */
     apiKey: pulumi.Input<string>;
-    /**
-     * Webhook's channel name.
-     */
     name: pulumi.Input<string>;
-    /**
-     * .
-     */
     priority: pulumi.Input<string>;
-    /**
-     * .
-     */
     region: pulumi.Input<string>;
 }
 
 export interface AlertChannelPagerduty {
-    /**
-     * Pagerduty's account name.
-     */
     account?: pulumi.Input<string>;
-    /**
-     * Pagerduty's service integration key.
-     */
     serviceKey: pulumi.Input<string>;
-    /**
-     * Pagerduty's service name.
-     */
     serviceName?: pulumi.Input<string>;
 }
 
 export interface AlertChannelSlack {
-    /**
-     * Slack's channel name.
-     */
     channel: pulumi.Input<string>;
-    /**
-     * .
-     */
     url: pulumi.Input<string>;
 }
 
 export interface AlertChannelSms {
-    /**
-     * Webhook's channel name.
-     */
     name: pulumi.Input<string>;
-    /**
-     * Mobile number to receive alerts.
-     */
     number: pulumi.Input<string>;
 }
 
 export interface AlertChannelWebhook {
-    /**
-     * .
-     */
     headers?: pulumi.Input<{[key: string]: any}>;
-    /**
-     * Default is `POST`.
-     */
     method?: pulumi.Input<string>;
-    /**
-     * Webhook's channel name.
-     */
     name: pulumi.Input<string>;
-    /**
-     * .
-     */
     queryParameters?: pulumi.Input<{[key: string]: any}>;
-    /**
-     * .
-     */
     template?: pulumi.Input<string>;
-    /**
-     * .
-     */
     url: pulumi.Input<string>;
-    /**
-     * .
-     */
     webhookSecret?: pulumi.Input<string>;
 }
 
 export interface CheckAlertChannelSubscription {
-    /**
-     * Determines if the check is running or not. Possible values `true`, and `false`.
-     */
     activated: pulumi.Input<boolean>;
     channelId: pulumi.Input<number>;
 }
 
 export interface CheckAlertSettings {
-    /**
-     * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
-     */
     escalationType?: pulumi.Input<string>;
-    /**
-     * . Possible arguments:
-     */
     reminders?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsReminder>[]>;
-    /**
-     * . Possible arguments:
-     */
     runBasedEscalations?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsRunBasedEscalation>[]>;
     /**
-     * At what interval the reminders should be send.  Possible arguments:
+     * @deprecated The property `ssl_certificates` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
      */
     sslCertificates?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsSslCertificate>[]>;
-    /**
-     * . Possible arguments:
-     */
     timeBasedEscalations?: pulumi.Input<pulumi.Input<inputs.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?: pulumi.Input<number>;
-    /**
-     * . Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
-     */
     interval?: pulumi.Input<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?: pulumi.Input<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?: pulumi.Input<number>;
-    /**
-     * Determines if alert notifications should be send for expiring SSL certificates. Possible values `true`, and `false`. Defaults to `true`.
-     */
     enabled?: pulumi.Input<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?: pulumi.Input<number>;
 }
 
 export interface CheckGroupAlertChannelSubscription {
-    /**
-     * Determines if the checks in the group are running or not.
-     */
     activated: pulumi.Input<boolean>;
     channelId: pulumi.Input<number>;
 }
 
 export interface CheckGroupAlertSettings {
-    /**
-     * Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
-     */
     escalationType?: pulumi.Input<string>;
-    /**
-     * . Possible arguments:
-     */
     reminders?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsReminder>[]>;
-    /**
-     * . Possible arguments:
-     */
     runBasedEscalations?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsRunBasedEscalation>[]>;
     /**
-     * At what interval the reminders should be send.  Possible arguments:
+     * @deprecated The property `ssl_certificates` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
      */
     sslCertificates?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsSslCertificate>[]>;
-    /**
-     * . Possible arguments:
-     */
     timeBasedEscalations?: pulumi.Input<pulumi.Input<inputs.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?: pulumi.Input<number>;
-    /**
-     * . Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
-     */
     interval?: pulumi.Input<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?: pulumi.Input<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?: pulumi.Input<number>;
-    /**
-     * Determines if alert notifications should be send for expiring SSL certificates. Possible values `true`, and `false`. Defaults to `true`.
-     */
     enabled?: pulumi.Input<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?: pulumi.Input<number>;
 }
 
 export interface CheckGroupApiCheckDefaults {
-    /**
-     * . Possible arguments:
-     */
     assertions?: pulumi.Input<pulumi.Input<inputs.CheckGroupApiCheckDefaultsAssertion>[]>;
-    /**
-     * . Possible arguments
-     */
     basicAuth?: pulumi.Input<inputs.CheckGroupApiCheckDefaultsBasicAuth>;
-    /**
-     * .
-     */
     headers?: pulumi.Input<{[key: string]: any}>;
-    /**
-     * .
-     */
     queryParameters?: pulumi.Input<{[key: string]: any}>;
-    /**
-     * The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.
-     */
     url?: pulumi.Input<string>;
 }
 /**
@@ -267,17 +129,8 @@ export function checkGroupApiCheckDefaultsProvideDefaults(val: CheckGroupApiChec
 }
 
 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: pulumi.Input<string>;
-    /**
-     * .
-     */
     property?: pulumi.Input<string>;
-    /**
-     * Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
-     */
     source: pulumi.Input<string>;
     target: pulumi.Input<string>;
 }
@@ -288,61 +141,22 @@ export interface CheckGroupApiCheckDefaultsBasicAuth {
 }
 
 export interface CheckRequest {
-    /**
-     * A request can have multiple assetions. Assertion has the following arguments:
-     */
     assertions?: pulumi.Input<pulumi.Input<inputs.CheckRequestAssertion>[]>;
-    /**
-     * A request might have one basicAuth config. basicAuth has two arguments:
-     */
     basicAuth?: pulumi.Input<inputs.CheckRequestBasicAuth>;
     body?: pulumi.Input<string>;
-    /**
-     * Possible values `NONE`, `JSON`, `FORM`, `RAW`, and `GRAPHQL`.
-     */
     bodyType?: pulumi.Input<string>;
-    /**
-     * .
-     */
     followRedirects?: pulumi.Input<boolean>;
-    /**
-     * .
-     */
     headers?: pulumi.Input<{[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?: pulumi.Input<string>;
-    /**
-     * .
-     */
     queryParameters?: pulumi.Input<{[key: string]: any}>;
-    /**
-     * .
-     */
     skipSsl?: pulumi.Input<boolean>;
-    /**
-     * .
-     */
     url: pulumi.Input<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: pulumi.Input<string>;
-    /**
-     * .
-     */
     property?: pulumi.Input<string>;
-    /**
-     * Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
-     */
     source: pulumi.Input<string>;
-    /**
-     * .
-     */
     target?: pulumi.Input<string>;
 }