import * as pulumi from "@pulumi/pulumi"; export declare class Monitor extends pulumi.CustomResource { /** * Get an existing Monitor 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?: MonitorState, opts?: pulumi.CustomResourceOptions): Monitor; /** * Returns true if the given object is an instance of Monitor. 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 Monitor; /** * Basic HTTP authentication password to include with the request. */ readonly authPassword: pulumi.Output; /** * Basic HTTP authentication username to include with the request. */ readonly authUsername: pulumi.Output; /** * Whether to call when a new incident is created. */ readonly call: pulumi.Output; /** * How often should we check your website? In seconds. */ readonly checkFrequency: pulumi.Output; /** * How long should we wait after observing a failure before we start a new incident? In seconds. */ readonly confirmationPeriod: pulumi.Output; /** * The time when this monitor was created. */ readonly createdAt: pulumi.Output; /** * Whether to send a critical push notification that ignores the mute switch and Do not Disturb mode when a new incident is * created. */ readonly criticalAlert: pulumi.Output; /** * How many days before the domain expires do you want to be alerted? Valid values are 1, 2, 3, 7, 14, 30, and 60. Set to * -1 to disable domain expiration check. */ readonly domainExpiration: pulumi.Output; /** * Whether to send an email when a new incident is created. */ readonly email: pulumi.Output; /** * For Playwright monitors, the environment variables that can be used in the scenario. Example: `{ "PASSWORD" = "passw0rd" * }`. */ readonly environmentVariables: pulumi.Output<{ [key: string]: string; }>; /** * Required if monitor_type is set to expected_status_code. We will create a new incident if the status code returned from * the server is not in the list of expected status codes. */ readonly expectedStatusCodes: pulumi.Output; /** * Set the expiration escalation policy for the monitor. It is used for SSL certificate and domain expiration checks. When * set to null, an e-mail is sent to the entire team. */ readonly expirationPolicyId: pulumi.Output; /** * Set to true for the monitor to follow redirects. */ readonly followRedirects: pulumi.Output; /** * HTTP Method used to make a request. Valid options: GET, HEAD, POST, PUT, PATCH */ readonly httpMethod: pulumi.Output; /** * Valid values: `ipv4` Use IPv4 only, `ipv6` Use IPv6 only. */ readonly ipVersion: pulumi.Output; /** * When the website was last checked. */ readonly lastCheckedAt: pulumi.Output; /** * An array of maintenance days to set. If a maintenance window is overnight both affected days should be set. Allowed * values are ["mon", "tue", "wed", "thu", "fri", "sat", "sun"] or any subset of these days. */ readonly maintenanceDays: pulumi.Output; /** * Start of the maintenance window each day. We won't check your website during this window. Example: "01:00:00" */ readonly maintenanceFrom: pulumi.Output; /** * The timezone to use for the maintenance window each day. Defaults to UTC. The accepted values can be found in the Rails * TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html */ readonly maintenanceTimezone: pulumi.Output; /** * End of the maintenance window each day. Example: "03:00:00" */ readonly maintenanceTo: pulumi.Output; /** * Set this attribute if you want to add this monitor to a monitor group. */ readonly monitorGroupId: pulumi.Output; /** * Valid values: `status` We will check your website for 2XX HTTP status code. `expected_status_code` We will check if your * website returned one of the values in expected_status_codes. `keyword` We will check if your website contains the * required_keyword. `keyword_absence` We will check if your website doesn't contain the required_keyword. `ping` We will * ping your host specified in the url parameter. `tcp` We will test a TCP port at your host specified in the url parameter * (port is required). `udp` We will test a UDP port at your host specified in the url parameter (port and required_keyword * are required). `smtp` We will check for a SMTP server at the host specified in the url parameter (port is required, and * can be one of 25, 465, 587, or a combination of those ports separated by comma). `pop` We will check for a POP3 server * at the host specified in the url parameter (port is required, and can be 110, 995, or both). `imap` We will check for an * IMAP server at the host specified in the url parameter (port is required, and can be 143, 993, or both). `dns` We will * check for a DNS server at the host specified in the url parameter (request_body is required, and should contain the * domain to query the DNS server with). `playwright` We will run the scenario defined by playwright_script, identified in * the UI by scenario_name */ readonly monitorType: pulumi.Output; /** * Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring. */ readonly paused: pulumi.Output; /** * The time when this monitor was paused. */ readonly pausedAt: pulumi.Output; /** * For Playwright monitors, the JavaScript source code of the scenario. */ readonly playwrightScript: pulumi.Output; /** * Set the escalation policy for the monitor. */ readonly policyId: pulumi.Output; /** * Required if monitor_type is set to tcp, udp, smtp, pop, or imap. tcp and udp monitors accept any ports, while smtp, pop, * and imap accept only the specified ports corresponding with their servers (e.g. "25,465,587" for smtp). */ readonly port: pulumi.Output; /** * Pronounceable name of the monitor. We will use this when we call you. Try to make it tongue-friendly, please? */ readonly pronounceableName: pulumi.Output; /** * Whether to send a push notification when a new incident is created. */ readonly push: pulumi.Output; /** * How long the monitor must be up to automatically mark an incident as resolved after being down. In seconds. */ readonly recoveryPeriod: pulumi.Output; /** * An array of regions to set. Allowed values are ["us", "eu", "as", "au"] or any subset of these regions. */ readonly regions: pulumi.Output; /** * Set to true to keep cookies when redirecting. */ readonly rememberCookies: pulumi.Output; /** * Request body for POST, PUT, PATCH requests. Required if monitor_type is set to dns (domain to query the DNS server * with). */ readonly requestBody: pulumi.Output; /** * An array of request headers, consisting of name and value pairs */ readonly requestHeaders: pulumi.Output<{ [key: string]: string; }[]>; /** * How long to wait before timing out the request? - For Server and Port monitors (types `ping`, `tcp`, `udp`, `smtp`, * `pop`, `imap` and `dns`) the timeout is specified in *milliseconds*. Valid options: 500, 1000, 2000, 3000, 5000. - For * Playwright monitors (type `playwright`), this determines the Playwright scenario timeout instead in *seconds*. Valid * options: 15, 30, 45, 60. - For all other monitors, the timeout is specified in *seconds*. Valid options: 2, 3, 5, 10, * 15, 30, 45, 60. */ readonly requestTimeout: pulumi.Output; /** * Required if monitor_type is set to keyword or udp. We will create a new incident if this keyword is missing on your * page. */ readonly requiredKeyword: pulumi.Output; /** * For Playwright monitors, the scenario name identifying the monitor in the UI. For Playwright monitors, either `url` or * `scenario_name` must be provided. */ readonly scenarioName: pulumi.Output; /** * Whether to send an SMS when a new incident is created. */ readonly sms: pulumi.Output; /** * How many days before the SSL certificate expires do you want to be alerted? Valid values are 1, 2, 3, 7, 14, 30, and 60. * Set to -1 to disable SSL expiration check. */ readonly sslExpiration: pulumi.Output; /** * The status of this website check. */ readonly status: pulumi.Output; /** * Used to specify the team the resource should be created in when using global tokens. */ readonly teamName: pulumi.Output; /** * How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. * In seconds. */ readonly teamWait: pulumi.Output; /** * The time when this monitor was updated. */ readonly updatedAt: pulumi.Output; /** * URL of your website or the host you want to ping (see monitor_type below). Required for all monitor types except * Playwright. For Playwright monitors, either `url` or `scenario_name` must be provided. */ readonly url: pulumi.Output; /** * Should we verify SSL certificate validity? */ readonly verifySsl: pulumi.Output; /** * Create a Monitor 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: MonitorArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Monitor resources. */ export interface MonitorState { /** * Basic HTTP authentication password to include with the request. */ authPassword?: pulumi.Input; /** * Basic HTTP authentication username to include with the request. */ authUsername?: pulumi.Input; /** * Whether to call when a new incident is created. */ call?: pulumi.Input; /** * How often should we check your website? In seconds. */ checkFrequency?: pulumi.Input; /** * How long should we wait after observing a failure before we start a new incident? In seconds. */ confirmationPeriod?: pulumi.Input; /** * The time when this monitor was created. */ createdAt?: pulumi.Input; /** * Whether to send a critical push notification that ignores the mute switch and Do not Disturb mode when a new incident is * created. */ criticalAlert?: pulumi.Input; /** * How many days before the domain expires do you want to be alerted? Valid values are 1, 2, 3, 7, 14, 30, and 60. Set to * -1 to disable domain expiration check. */ domainExpiration?: pulumi.Input; /** * Whether to send an email when a new incident is created. */ email?: pulumi.Input; /** * For Playwright monitors, the environment variables that can be used in the scenario. Example: `{ "PASSWORD" = "passw0rd" * }`. */ environmentVariables?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Required if monitor_type is set to expected_status_code. We will create a new incident if the status code returned from * the server is not in the list of expected status codes. */ expectedStatusCodes?: pulumi.Input[]>; /** * Set the expiration escalation policy for the monitor. It is used for SSL certificate and domain expiration checks. When * set to null, an e-mail is sent to the entire team. */ expirationPolicyId?: pulumi.Input; /** * Set to true for the monitor to follow redirects. */ followRedirects?: pulumi.Input; /** * HTTP Method used to make a request. Valid options: GET, HEAD, POST, PUT, PATCH */ httpMethod?: pulumi.Input; /** * Valid values: `ipv4` Use IPv4 only, `ipv6` Use IPv6 only. */ ipVersion?: pulumi.Input; /** * When the website was last checked. */ lastCheckedAt?: pulumi.Input; /** * An array of maintenance days to set. If a maintenance window is overnight both affected days should be set. Allowed * values are ["mon", "tue", "wed", "thu", "fri", "sat", "sun"] or any subset of these days. */ maintenanceDays?: pulumi.Input[]>; /** * Start of the maintenance window each day. We won't check your website during this window. Example: "01:00:00" */ maintenanceFrom?: pulumi.Input; /** * The timezone to use for the maintenance window each day. Defaults to UTC. The accepted values can be found in the Rails * TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html */ maintenanceTimezone?: pulumi.Input; /** * End of the maintenance window each day. Example: "03:00:00" */ maintenanceTo?: pulumi.Input; /** * Set this attribute if you want to add this monitor to a monitor group. */ monitorGroupId?: pulumi.Input; /** * Valid values: `status` We will check your website for 2XX HTTP status code. `expected_status_code` We will check if your * website returned one of the values in expected_status_codes. `keyword` We will check if your website contains the * required_keyword. `keyword_absence` We will check if your website doesn't contain the required_keyword. `ping` We will * ping your host specified in the url parameter. `tcp` We will test a TCP port at your host specified in the url parameter * (port is required). `udp` We will test a UDP port at your host specified in the url parameter (port and required_keyword * are required). `smtp` We will check for a SMTP server at the host specified in the url parameter (port is required, and * can be one of 25, 465, 587, or a combination of those ports separated by comma). `pop` We will check for a POP3 server * at the host specified in the url parameter (port is required, and can be 110, 995, or both). `imap` We will check for an * IMAP server at the host specified in the url parameter (port is required, and can be 143, 993, or both). `dns` We will * check for a DNS server at the host specified in the url parameter (request_body is required, and should contain the * domain to query the DNS server with). `playwright` We will run the scenario defined by playwright_script, identified in * the UI by scenario_name */ monitorType?: pulumi.Input; /** * Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring. */ paused?: pulumi.Input; /** * The time when this monitor was paused. */ pausedAt?: pulumi.Input; /** * For Playwright monitors, the JavaScript source code of the scenario. */ playwrightScript?: pulumi.Input; /** * Set the escalation policy for the monitor. */ policyId?: pulumi.Input; /** * Required if monitor_type is set to tcp, udp, smtp, pop, or imap. tcp and udp monitors accept any ports, while smtp, pop, * and imap accept only the specified ports corresponding with their servers (e.g. "25,465,587" for smtp). */ port?: pulumi.Input; /** * Pronounceable name of the monitor. We will use this when we call you. Try to make it tongue-friendly, please? */ pronounceableName?: pulumi.Input; /** * Whether to send a push notification when a new incident is created. */ push?: pulumi.Input; /** * How long the monitor must be up to automatically mark an incident as resolved after being down. In seconds. */ recoveryPeriod?: pulumi.Input; /** * An array of regions to set. Allowed values are ["us", "eu", "as", "au"] or any subset of these regions. */ regions?: pulumi.Input[]>; /** * Set to true to keep cookies when redirecting. */ rememberCookies?: pulumi.Input; /** * Request body for POST, PUT, PATCH requests. Required if monitor_type is set to dns (domain to query the DNS server * with). */ requestBody?: pulumi.Input; /** * An array of request headers, consisting of name and value pairs */ requestHeaders?: pulumi.Input; }>[]>; /** * How long to wait before timing out the request? - For Server and Port monitors (types `ping`, `tcp`, `udp`, `smtp`, * `pop`, `imap` and `dns`) the timeout is specified in *milliseconds*. Valid options: 500, 1000, 2000, 3000, 5000. - For * Playwright monitors (type `playwright`), this determines the Playwright scenario timeout instead in *seconds*. Valid * options: 15, 30, 45, 60. - For all other monitors, the timeout is specified in *seconds*. Valid options: 2, 3, 5, 10, * 15, 30, 45, 60. */ requestTimeout?: pulumi.Input; /** * Required if monitor_type is set to keyword or udp. We will create a new incident if this keyword is missing on your * page. */ requiredKeyword?: pulumi.Input; /** * For Playwright monitors, the scenario name identifying the monitor in the UI. For Playwright monitors, either `url` or * `scenario_name` must be provided. */ scenarioName?: pulumi.Input; /** * Whether to send an SMS when a new incident is created. */ sms?: pulumi.Input; /** * How many days before the SSL certificate expires do you want to be alerted? Valid values are 1, 2, 3, 7, 14, 30, and 60. * Set to -1 to disable SSL expiration check. */ sslExpiration?: pulumi.Input; /** * The status of this website check. */ status?: pulumi.Input; /** * Used to specify the team the resource should be created in when using global tokens. */ teamName?: pulumi.Input; /** * How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. * In seconds. */ teamWait?: pulumi.Input; /** * The time when this monitor was updated. */ updatedAt?: pulumi.Input; /** * URL of your website or the host you want to ping (see monitor_type below). Required for all monitor types except * Playwright. For Playwright monitors, either `url` or `scenario_name` must be provided. */ url?: pulumi.Input; /** * Should we verify SSL certificate validity? */ verifySsl?: pulumi.Input; } /** * The set of arguments for constructing a Monitor resource. */ export interface MonitorArgs { /** * Basic HTTP authentication password to include with the request. */ authPassword?: pulumi.Input; /** * Basic HTTP authentication username to include with the request. */ authUsername?: pulumi.Input; /** * Whether to call when a new incident is created. */ call?: pulumi.Input; /** * How often should we check your website? In seconds. */ checkFrequency?: pulumi.Input; /** * How long should we wait after observing a failure before we start a new incident? In seconds. */ confirmationPeriod?: pulumi.Input; /** * Whether to send a critical push notification that ignores the mute switch and Do not Disturb mode when a new incident is * created. */ criticalAlert?: pulumi.Input; /** * How many days before the domain expires do you want to be alerted? Valid values are 1, 2, 3, 7, 14, 30, and 60. Set to * -1 to disable domain expiration check. */ domainExpiration?: pulumi.Input; /** * Whether to send an email when a new incident is created. */ email?: pulumi.Input; /** * For Playwright monitors, the environment variables that can be used in the scenario. Example: `{ "PASSWORD" = "passw0rd" * }`. */ environmentVariables?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Required if monitor_type is set to expected_status_code. We will create a new incident if the status code returned from * the server is not in the list of expected status codes. */ expectedStatusCodes?: pulumi.Input[]>; /** * Set the expiration escalation policy for the monitor. It is used for SSL certificate and domain expiration checks. When * set to null, an e-mail is sent to the entire team. */ expirationPolicyId?: pulumi.Input; /** * Set to true for the monitor to follow redirects. */ followRedirects?: pulumi.Input; /** * HTTP Method used to make a request. Valid options: GET, HEAD, POST, PUT, PATCH */ httpMethod?: pulumi.Input; /** * Valid values: `ipv4` Use IPv4 only, `ipv6` Use IPv6 only. */ ipVersion?: pulumi.Input; /** * An array of maintenance days to set. If a maintenance window is overnight both affected days should be set. Allowed * values are ["mon", "tue", "wed", "thu", "fri", "sat", "sun"] or any subset of these days. */ maintenanceDays?: pulumi.Input[]>; /** * Start of the maintenance window each day. We won't check your website during this window. Example: "01:00:00" */ maintenanceFrom?: pulumi.Input; /** * The timezone to use for the maintenance window each day. Defaults to UTC. The accepted values can be found in the Rails * TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html */ maintenanceTimezone?: pulumi.Input; /** * End of the maintenance window each day. Example: "03:00:00" */ maintenanceTo?: pulumi.Input; /** * Set this attribute if you want to add this monitor to a monitor group. */ monitorGroupId?: pulumi.Input; /** * Valid values: `status` We will check your website for 2XX HTTP status code. `expected_status_code` We will check if your * website returned one of the values in expected_status_codes. `keyword` We will check if your website contains the * required_keyword. `keyword_absence` We will check if your website doesn't contain the required_keyword. `ping` We will * ping your host specified in the url parameter. `tcp` We will test a TCP port at your host specified in the url parameter * (port is required). `udp` We will test a UDP port at your host specified in the url parameter (port and required_keyword * are required). `smtp` We will check for a SMTP server at the host specified in the url parameter (port is required, and * can be one of 25, 465, 587, or a combination of those ports separated by comma). `pop` We will check for a POP3 server * at the host specified in the url parameter (port is required, and can be 110, 995, or both). `imap` We will check for an * IMAP server at the host specified in the url parameter (port is required, and can be 143, 993, or both). `dns` We will * check for a DNS server at the host specified in the url parameter (request_body is required, and should contain the * domain to query the DNS server with). `playwright` We will run the scenario defined by playwright_script, identified in * the UI by scenario_name */ monitorType: pulumi.Input; /** * Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring. */ paused?: pulumi.Input; /** * For Playwright monitors, the JavaScript source code of the scenario. */ playwrightScript?: pulumi.Input; /** * Set the escalation policy for the monitor. */ policyId?: pulumi.Input; /** * Required if monitor_type is set to tcp, udp, smtp, pop, or imap. tcp and udp monitors accept any ports, while smtp, pop, * and imap accept only the specified ports corresponding with their servers (e.g. "25,465,587" for smtp). */ port?: pulumi.Input; /** * Pronounceable name of the monitor. We will use this when we call you. Try to make it tongue-friendly, please? */ pronounceableName?: pulumi.Input; /** * Whether to send a push notification when a new incident is created. */ push?: pulumi.Input; /** * How long the monitor must be up to automatically mark an incident as resolved after being down. In seconds. */ recoveryPeriod?: pulumi.Input; /** * An array of regions to set. Allowed values are ["us", "eu", "as", "au"] or any subset of these regions. */ regions?: pulumi.Input[]>; /** * Set to true to keep cookies when redirecting. */ rememberCookies?: pulumi.Input; /** * Request body for POST, PUT, PATCH requests. Required if monitor_type is set to dns (domain to query the DNS server * with). */ requestBody?: pulumi.Input; /** * An array of request headers, consisting of name and value pairs */ requestHeaders?: pulumi.Input; }>[]>; /** * How long to wait before timing out the request? - For Server and Port monitors (types `ping`, `tcp`, `udp`, `smtp`, * `pop`, `imap` and `dns`) the timeout is specified in *milliseconds*. Valid options: 500, 1000, 2000, 3000, 5000. - For * Playwright monitors (type `playwright`), this determines the Playwright scenario timeout instead in *seconds*. Valid * options: 15, 30, 45, 60. - For all other monitors, the timeout is specified in *seconds*. Valid options: 2, 3, 5, 10, * 15, 30, 45, 60. */ requestTimeout?: pulumi.Input; /** * Required if monitor_type is set to keyword or udp. We will create a new incident if this keyword is missing on your * page. */ requiredKeyword?: pulumi.Input; /** * For Playwright monitors, the scenario name identifying the monitor in the UI. For Playwright monitors, either `url` or * `scenario_name` must be provided. */ scenarioName?: pulumi.Input; /** * Whether to send an SMS when a new incident is created. */ sms?: pulumi.Input; /** * How many days before the SSL certificate expires do you want to be alerted? Valid values are 1, 2, 3, 7, 14, 30, and 60. * Set to -1 to disable SSL expiration check. */ sslExpiration?: pulumi.Input; /** * Used to specify the team the resource should be created in when using global tokens. */ teamName?: pulumi.Input; /** * How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. * In seconds. */ teamWait?: pulumi.Input; /** * URL of your website or the host you want to ping (see monitor_type below). Required for all monitor types except * Playwright. For Playwright monitors, either `url` or `scenario_name` must be provided. */ url?: pulumi.Input; /** * Should we verify SSL certificate validity? */ verifySsl?: pulumi.Input; }