import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * Checks allows you to monitor key webapp flows, backend API's and set up alerting, so you get a notification when things break or slow down. */ export declare class Check extends pulumi.CustomResource { /** * Get an existing Check 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. */ static get(name: string, id: pulumi.Input, state?: CheckState, opts?: pulumi.CustomResourceOptions): Check; /** * Returns true if the given object is an instance of Check. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Check; /** * Determines if the check is running or not. Possible values `true`, and `false`. */ readonly activated: pulumi.Output; /** * An array of channel IDs and whether they're activated or not. If you don't set at least one alert channel subscription for your check, we won't be able to alert you even if it starts failing. */ readonly alertChannelSubscriptions: pulumi.Output; /** * Determines the alert escalation policy for the check. */ readonly alertSettings: pulumi.Output; /** * The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default `15000`). */ readonly degradedResponseTime: pulumi.Output; /** * A description of the check. */ readonly description: pulumi.Output; /** * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default `false`). * * @deprecated The property `doubleCheck` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retryStrategy` property instead. */ readonly doubleCheck: pulumi.Output; /** * Insert environment variables into the runtime environment. Only relevant for browser checks. Use global environment variables whenever possible. */ readonly environmentVariable: pulumi.Output; /** * Key/value pairs of environment variables to insert into the runtime environment. * * @deprecated This attribute is deprecated and will be removed in a future version. Use the `environmentVariable` attribute instead. */ readonly environmentVariables: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Controls how often the check should run. Defined in minutes. The allowed values are `0` (high frequency - use `frequencyOffset` to define the actual frequency), `1` (1 minute), `2` (2 minutes), `5` (5 minutes), `10` (10 minutes), `15` (15 minutes), `30` (30 minutes), `60` (1 hour), `120` (2 hours), `180` (3 hours), `360` (6 hours), `720` (12 hours) and `1440` (24 hours). */ readonly frequency: pulumi.Output; /** * Only relevant when `type` is `API`. When `frequency` is `0` (high frequency), `frequencyOffset` is required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are `0` (disabled - use `frequency` to define the actual frequency), `10` (10 seconds), `20` (20 seconds) and `30` (30 seconds). */ readonly frequencyOffset: pulumi.Output; /** * The id of the check group this check is part of. */ readonly groupId: pulumi.Output; /** * The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD. */ readonly groupOrder: pulumi.Output; /** * A valid piece of Node.js code to run in the setup phase. */ readonly localSetupScript: pulumi.Output; /** * A valid piece of Node.js code to run in the teardown phase. */ readonly localTeardownScript: pulumi.Output; /** * An array of one or more data center locations where to run the this check. (Default ["us-east-1"]) */ readonly locations: pulumi.Output; /** * The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default `30000`). */ readonly maxResponseTime: pulumi.Output; /** * Determines if any notifications will be sent out when a check fails/degrades/recovers. */ readonly muted: pulumi.Output; /** * The name of the check. */ readonly name: pulumi.Output; /** * An array of one or more private locations slugs. */ readonly privateLocations: pulumi.Output; /** * An API check might have one request config. */ readonly request: pulumi.Output; /** * A strategy for retrying failed check/monitor runs. */ readonly retryStrategy: pulumi.Output; /** * Determines if the check should run in all selected locations in parallel or round-robin. */ readonly runParallel: pulumi.Output; /** * The id of the runtime to use for this check. */ readonly runtimeId: pulumi.Output; /** * A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file. */ readonly script: pulumi.Output; /** * An ID reference to a snippet to use in the setup phase of an API check. */ readonly setupSnippetId: pulumi.Output; /** * Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404. */ readonly shouldFail: pulumi.Output; /** * Determines if the SSL certificate should be validated for expiry. * * @deprecated The property `sslCheck` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version. */ readonly sslCheck: pulumi.Output; /** * A valid fully qualified domain name (FQDN) to check its SSL certificate. */ readonly sslCheckDomain: pulumi.Output; /** * A list of tags for organizing and filtering checks. */ readonly tags: pulumi.Output; /** * An ID reference to a snippet to use in the teardown phase of an API check. */ readonly teardownSnippetId: pulumi.Output; /** * Create and resolve an incident based on the alert configuration. Useful for status page automation. */ readonly triggerIncident: pulumi.Output; /** * The type of the check. Possible values are `API`, `BROWSER`, and `MULTI_STEP`. */ readonly type: pulumi.Output; /** * When true, the account level alert settings will be used, not the alert setting defined on this check. */ readonly useGlobalAlertSettings: pulumi.Output; /** * Create a Check 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: CheckArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Check resources. */ export interface CheckState { /** * Determines if the check is running or not. Possible values `true`, and `false`. */ activated?: pulumi.Input; /** * An array of channel IDs and whether they're activated or not. If you don't set at least one alert channel subscription for your check, we won't be able to alert you even if it starts failing. */ alertChannelSubscriptions?: pulumi.Input[]>; /** * Determines the alert escalation policy for the check. */ alertSettings?: pulumi.Input; /** * The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default `15000`). */ degradedResponseTime?: pulumi.Input; /** * A description of the check. */ description?: pulumi.Input; /** * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default `false`). * * @deprecated The property `doubleCheck` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retryStrategy` property instead. */ doubleCheck?: pulumi.Input; /** * Insert environment variables into the runtime environment. Only relevant for browser checks. Use global environment variables whenever possible. */ environmentVariable?: pulumi.Input[]>; /** * Key/value pairs of environment variables to insert into the runtime environment. * * @deprecated This attribute is deprecated and will be removed in a future version. Use the `environmentVariable` attribute instead. */ environmentVariables?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Controls how often the check should run. Defined in minutes. The allowed values are `0` (high frequency - use `frequencyOffset` to define the actual frequency), `1` (1 minute), `2` (2 minutes), `5` (5 minutes), `10` (10 minutes), `15` (15 minutes), `30` (30 minutes), `60` (1 hour), `120` (2 hours), `180` (3 hours), `360` (6 hours), `720` (12 hours) and `1440` (24 hours). */ frequency?: pulumi.Input; /** * Only relevant when `type` is `API`. When `frequency` is `0` (high frequency), `frequencyOffset` is required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are `0` (disabled - use `frequency` to define the actual frequency), `10` (10 seconds), `20` (20 seconds) and `30` (30 seconds). */ frequencyOffset?: pulumi.Input; /** * The id of the check group this check is part of. */ groupId?: pulumi.Input; /** * The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD. */ groupOrder?: pulumi.Input; /** * A valid piece of Node.js code to run in the setup phase. */ localSetupScript?: pulumi.Input; /** * A valid piece of Node.js code to run in the teardown phase. */ localTeardownScript?: pulumi.Input; /** * An array of one or more data center locations where to run the this check. (Default ["us-east-1"]) */ locations?: pulumi.Input[]>; /** * The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default `30000`). */ maxResponseTime?: pulumi.Input; /** * Determines if any notifications will be sent out when a check fails/degrades/recovers. */ muted?: pulumi.Input; /** * The name of the check. */ name?: pulumi.Input; /** * An array of one or more private locations slugs. */ privateLocations?: pulumi.Input[]>; /** * An API check might have one request config. */ request?: pulumi.Input; /** * A strategy for retrying failed check/monitor runs. */ retryStrategy?: pulumi.Input; /** * Determines if the check should run in all selected locations in parallel or round-robin. */ runParallel?: pulumi.Input; /** * The id of the runtime to use for this check. */ runtimeId?: pulumi.Input; /** * A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file. */ script?: pulumi.Input; /** * An ID reference to a snippet to use in the setup phase of an API check. */ setupSnippetId?: pulumi.Input; /** * Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404. */ shouldFail?: pulumi.Input; /** * Determines if the SSL certificate should be validated for expiry. * * @deprecated The property `sslCheck` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version. */ sslCheck?: pulumi.Input; /** * A valid fully qualified domain name (FQDN) to check its SSL certificate. */ sslCheckDomain?: pulumi.Input; /** * A list of tags for organizing and filtering checks. */ tags?: pulumi.Input[]>; /** * An ID reference to a snippet to use in the teardown phase of an API check. */ teardownSnippetId?: pulumi.Input; /** * Create and resolve an incident based on the alert configuration. Useful for status page automation. */ triggerIncident?: pulumi.Input; /** * The type of the check. Possible values are `API`, `BROWSER`, and `MULTI_STEP`. */ type?: pulumi.Input; /** * When true, the account level alert settings will be used, not the alert setting defined on this check. */ useGlobalAlertSettings?: pulumi.Input; } /** * The set of arguments for constructing a Check resource. */ export interface CheckArgs { /** * Determines if the check is running or not. Possible values `true`, and `false`. */ activated: pulumi.Input; /** * An array of channel IDs and whether they're activated or not. If you don't set at least one alert channel subscription for your check, we won't be able to alert you even if it starts failing. */ alertChannelSubscriptions?: pulumi.Input[]>; /** * Determines the alert escalation policy for the check. */ alertSettings?: pulumi.Input; /** * The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default `15000`). */ degradedResponseTime?: pulumi.Input; /** * A description of the check. */ description?: pulumi.Input; /** * Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default `false`). * * @deprecated The property `doubleCheck` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retryStrategy` property instead. */ doubleCheck?: pulumi.Input; /** * Insert environment variables into the runtime environment. Only relevant for browser checks. Use global environment variables whenever possible. */ environmentVariable?: pulumi.Input[]>; /** * Key/value pairs of environment variables to insert into the runtime environment. * * @deprecated This attribute is deprecated and will be removed in a future version. Use the `environmentVariable` attribute instead. */ environmentVariables?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Controls how often the check should run. Defined in minutes. The allowed values are `0` (high frequency - use `frequencyOffset` to define the actual frequency), `1` (1 minute), `2` (2 minutes), `5` (5 minutes), `10` (10 minutes), `15` (15 minutes), `30` (30 minutes), `60` (1 hour), `120` (2 hours), `180` (3 hours), `360` (6 hours), `720` (12 hours) and `1440` (24 hours). */ frequency: pulumi.Input; /** * Only relevant when `type` is `API`. When `frequency` is `0` (high frequency), `frequencyOffset` is required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are `0` (disabled - use `frequency` to define the actual frequency), `10` (10 seconds), `20` (20 seconds) and `30` (30 seconds). */ frequencyOffset?: pulumi.Input; /** * The id of the check group this check is part of. */ groupId?: pulumi.Input; /** * The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD. */ groupOrder?: pulumi.Input; /** * A valid piece of Node.js code to run in the setup phase. */ localSetupScript?: pulumi.Input; /** * A valid piece of Node.js code to run in the teardown phase. */ localTeardownScript?: pulumi.Input; /** * An array of one or more data center locations where to run the this check. (Default ["us-east-1"]) */ locations?: pulumi.Input[]>; /** * The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default `30000`). */ maxResponseTime?: pulumi.Input; /** * Determines if any notifications will be sent out when a check fails/degrades/recovers. */ muted?: pulumi.Input; /** * The name of the check. */ name?: pulumi.Input; /** * An array of one or more private locations slugs. */ privateLocations?: pulumi.Input[]>; /** * An API check might have one request config. */ request?: pulumi.Input; /** * A strategy for retrying failed check/monitor runs. */ retryStrategy?: pulumi.Input; /** * Determines if the check should run in all selected locations in parallel or round-robin. */ runParallel?: pulumi.Input; /** * The id of the runtime to use for this check. */ runtimeId?: pulumi.Input; /** * A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file. */ script?: pulumi.Input; /** * An ID reference to a snippet to use in the setup phase of an API check. */ setupSnippetId?: pulumi.Input; /** * Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404. */ shouldFail?: pulumi.Input; /** * Determines if the SSL certificate should be validated for expiry. * * @deprecated The property `sslCheck` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version. */ sslCheck?: pulumi.Input; /** * A valid fully qualified domain name (FQDN) to check its SSL certificate. */ sslCheckDomain?: pulumi.Input; /** * A list of tags for organizing and filtering checks. */ tags?: pulumi.Input[]>; /** * An ID reference to a snippet to use in the teardown phase of an API check. */ teardownSnippetId?: pulumi.Input; /** * Create and resolve an incident based on the alert configuration. Useful for status page automation. */ triggerIncident?: pulumi.Input; /** * The type of the check. Possible values are `API`, `BROWSER`, and `MULTI_STEP`. */ type: pulumi.Input; /** * When true, the account level alert settings will be used, not the alert setting defined on this check. */ useGlobalAlertSettings?: pulumi.Input; }