import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * Check groups allow you to group together a set of related checks, which can also share default settings for various attributes. */ export declare class CheckGroup extends pulumi.CustomResource { /** * Get an existing CheckGroup 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?: CheckGroupState, opts?: pulumi.CustomResourceOptions): CheckGroup; /** * Returns true if the given object is an instance of CheckGroup. 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 CheckGroup; /** * Determines if the checks in the group are running or not. */ 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; readonly apiCheckDefaults: pulumi.Output; /** * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API. */ readonly concurrency: 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>; /** * A valid piece of Node.js code to run in the setup phase of an API check in this group. */ readonly localSetupScript: pulumi.Output; /** * A valid piece of Node.js code to run in the teardown phase of an API check in this group. */ readonly localTeardownScript: pulumi.Output; /** * An array of one or more data center locations where to run the checks. */ readonly locations: pulumi.Output; /** * Determines if any notifications will be sent out when a check in this group fails and/or recovers. */ readonly muted: pulumi.Output; /** * The name of the check group. */ readonly name: pulumi.Output; /** * An array of one or more private locations slugs. */ readonly privateLocations: pulumi.Output; /** * A strategy for retrying failed check/monitor runs. */ readonly retryStrategy: pulumi.Output; /** * Determines if the checks in the group should run in all selected locations in parallel or round-robin. */ readonly runParallel: pulumi.Output; /** * The id of the runtime to use for this group. */ readonly runtimeId: pulumi.Output; /** * An ID reference to a snippet to use in the setup phase of an API check. */ readonly setupSnippetId: pulumi.Output; /** * 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; /** * When true, the account level alert settings will be used, not the alert setting defined on this check group. */ readonly useGlobalAlertSettings: pulumi.Output; /** * Create a CheckGroup 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: CheckGroupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering CheckGroup resources. */ export interface CheckGroupState { /** * Determines if the checks in the group are running or not. */ 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; apiCheckDefaults?: pulumi.Input; /** * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API. */ concurrency?: 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; }>; /** * A valid piece of Node.js code to run in the setup phase of an API check in this group. */ localSetupScript?: pulumi.Input; /** * A valid piece of Node.js code to run in the teardown phase of an API check in this group. */ localTeardownScript?: pulumi.Input; /** * An array of one or more data center locations where to run the checks. */ locations?: pulumi.Input[]>; /** * Determines if any notifications will be sent out when a check in this group fails and/or recovers. */ muted?: pulumi.Input; /** * The name of the check group. */ name?: pulumi.Input; /** * An array of one or more private locations slugs. */ privateLocations?: pulumi.Input[]>; /** * A strategy for retrying failed check/monitor runs. */ retryStrategy?: pulumi.Input; /** * Determines if the checks in the group should run in all selected locations in parallel or round-robin. */ runParallel?: pulumi.Input; /** * The id of the runtime to use for this group. */ runtimeId?: pulumi.Input; /** * An ID reference to a snippet to use in the setup phase of an API check. */ setupSnippetId?: pulumi.Input; /** * 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; /** * When true, the account level alert settings will be used, not the alert setting defined on this check group. */ useGlobalAlertSettings?: pulumi.Input; } /** * The set of arguments for constructing a CheckGroup resource. */ export interface CheckGroupArgs { /** * Determines if the checks in the group are running or not. */ 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; apiCheckDefaults?: pulumi.Input; /** * Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API. */ concurrency: 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; }>; /** * A valid piece of Node.js code to run in the setup phase of an API check in this group. */ localSetupScript?: pulumi.Input; /** * A valid piece of Node.js code to run in the teardown phase of an API check in this group. */ localTeardownScript?: pulumi.Input; /** * An array of one or more data center locations where to run the checks. */ locations?: pulumi.Input[]>; /** * Determines if any notifications will be sent out when a check in this group fails and/or recovers. */ muted?: pulumi.Input; /** * The name of the check group. */ name?: pulumi.Input; /** * An array of one or more private locations slugs. */ privateLocations?: pulumi.Input[]>; /** * A strategy for retrying failed check/monitor runs. */ retryStrategy?: pulumi.Input; /** * Determines if the checks in the group should run in all selected locations in parallel or round-robin. */ runParallel?: pulumi.Input; /** * The id of the runtime to use for this group. */ runtimeId?: pulumi.Input; /** * An ID reference to a snippet to use in the setup phase of an API check. */ setupSnippetId?: pulumi.Input; /** * 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; /** * When true, the account level alert settings will be used, not the alert setting defined on this check group. */ useGlobalAlertSettings?: pulumi.Input; }