checkly.UrlMonitor
Explore with Pulumi AI
Creates a URL Monitor to check HTTP endpoint availability and response times.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as checkly from "@checkly/pulumi";
const example_url_monitor = new checkly.UrlMonitor("example-url-monitor", {
name: "Example URL monitor",
activated: true,
frequency: 2,
useGlobalAlertSettings: true,
locations: ["eu-west-1"],
request: {
url: "https://welcome.checklyhq.com",
assertions: [{
source: "STATUS_CODE",
comparison: "EQUALS",
target: "200",
}],
},
});
import pulumi
import pulumi_checkly as checkly
example_url_monitor = checkly.UrlMonitor("example-url-monitor",
name="Example URL monitor",
activated=True,
frequency=2,
use_global_alert_settings=True,
locations=["eu-west-1"],
request={
"url": "https://welcome.checklyhq.com",
"assertions": [{
"source": "STATUS_CODE",
"comparison": "EQUALS",
"target": "200",
}],
})
package main
import (
"github.com/checkly/pulumi-checkly/sdk/v2/go/checkly"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := checkly.NewUrlMonitor(ctx, "example-url-monitor", &checkly.UrlMonitorArgs{
Name: pulumi.String("Example URL monitor"),
Activated: pulumi.Bool(true),
Frequency: pulumi.Int(2),
UseGlobalAlertSettings: pulumi.Bool(true),
Locations: pulumi.StringArray{
pulumi.String("eu-west-1"),
},
Request: &checkly.UrlMonitorRequestArgs{
Url: pulumi.String("https://welcome.checklyhq.com"),
Assertions: checkly.UrlMonitorRequestAssertionArray{
&checkly.UrlMonitorRequestAssertionArgs{
Source: pulumi.String("STATUS_CODE"),
Comparison: pulumi.String("EQUALS"),
Target: pulumi.String("200"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkly = Pulumi.Checkly;
return await Deployment.RunAsync(() =>
{
var example_url_monitor = new Checkly.UrlMonitor("example-url-monitor", new()
{
Name = "Example URL monitor",
Activated = true,
Frequency = 2,
UseGlobalAlertSettings = true,
Locations = new[]
{
"eu-west-1",
},
Request = new Checkly.Inputs.UrlMonitorRequestArgs
{
Url = "https://welcome.checklyhq.com",
Assertions = new[]
{
new Checkly.Inputs.UrlMonitorRequestAssertionArgs
{
Source = "STATUS_CODE",
Comparison = "EQUALS",
Target = "200",
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkly.UrlMonitor;
import com.pulumi.checkly.UrlMonitorArgs;
import com.pulumi.checkly.inputs.UrlMonitorRequestArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example_url_monitor = new UrlMonitor("example-url-monitor", UrlMonitorArgs.builder()
.name("Example URL monitor")
.activated(true)
.frequency(2)
.useGlobalAlertSettings(true)
.locations("eu-west-1")
.request(UrlMonitorRequestArgs.builder()
.url("https://welcome.checklyhq.com")
.assertions(UrlMonitorRequestAssertionArgs.builder()
.source("STATUS_CODE")
.comparison("EQUALS")
.target("200")
.build())
.build())
.build());
}
}
resources:
example-url-monitor:
type: checkly:UrlMonitor
properties:
name: Example URL monitor
activated: true
frequency: 2
useGlobalAlertSettings: true
locations:
- eu-west-1
request:
url: https://welcome.checklyhq.com
assertions:
- source: STATUS_CODE
comparison: EQUALS
target: '200'
Create UrlMonitor Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UrlMonitor(name: string, args: UrlMonitorArgs, opts?: CustomResourceOptions);
@overload
def UrlMonitor(resource_name: str,
args: UrlMonitorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def UrlMonitor(resource_name: str,
opts: Optional[ResourceOptions] = None,
frequency: Optional[int] = None,
request: Optional[UrlMonitorRequestArgs] = None,
activated: Optional[bool] = None,
locations: Optional[Sequence[str]] = None,
muted: Optional[bool] = None,
frequency_offset: Optional[int] = None,
group_id: Optional[int] = None,
group_order: Optional[int] = None,
alert_settings: Optional[UrlMonitorAlertSettingsArgs] = None,
max_response_time: Optional[int] = None,
degraded_response_time: Optional[int] = None,
name: Optional[str] = None,
private_locations: Optional[Sequence[str]] = None,
alert_channel_subscriptions: Optional[Sequence[UrlMonitorAlertChannelSubscriptionArgs]] = None,
retry_strategy: Optional[UrlMonitorRetryStrategyArgs] = None,
run_parallel: Optional[bool] = None,
should_fail: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
use_global_alert_settings: Optional[bool] = None)
func NewUrlMonitor(ctx *Context, name string, args UrlMonitorArgs, opts ...ResourceOption) (*UrlMonitor, error)
public UrlMonitor(string name, UrlMonitorArgs args, CustomResourceOptions? opts = null)
public UrlMonitor(String name, UrlMonitorArgs args)
public UrlMonitor(String name, UrlMonitorArgs args, CustomResourceOptions options)
type: checkly:UrlMonitor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args UrlMonitorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args UrlMonitorArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args UrlMonitorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UrlMonitorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UrlMonitorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var urlMonitorResource = new Checkly.UrlMonitor("urlMonitorResource", new()
{
Frequency = 0,
Request = new Checkly.Inputs.UrlMonitorRequestArgs
{
Url = "string",
Assertions = new[]
{
new Checkly.Inputs.UrlMonitorRequestAssertionArgs
{
Comparison = "string",
Source = "string",
Target = "string",
Property = "string",
},
},
FollowRedirects = false,
IpFamily = "string",
SkipSsl = false,
},
Activated = false,
Locations = new[]
{
"string",
},
Muted = false,
FrequencyOffset = 0,
GroupId = 0,
GroupOrder = 0,
AlertSettings = new Checkly.Inputs.UrlMonitorAlertSettingsArgs
{
EscalationType = "string",
ParallelRunFailureThresholds = new[]
{
new Checkly.Inputs.UrlMonitorAlertSettingsParallelRunFailureThresholdArgs
{
Enabled = false,
Percentage = 0,
},
},
Reminders = new[]
{
new Checkly.Inputs.UrlMonitorAlertSettingsReminderArgs
{
Amount = 0,
Interval = 0,
},
},
RunBasedEscalations = new[]
{
new Checkly.Inputs.UrlMonitorAlertSettingsRunBasedEscalationArgs
{
FailedRunThreshold = 0,
},
},
TimeBasedEscalations = new[]
{
new Checkly.Inputs.UrlMonitorAlertSettingsTimeBasedEscalationArgs
{
MinutesFailingThreshold = 0,
},
},
},
MaxResponseTime = 0,
DegradedResponseTime = 0,
Name = "string",
PrivateLocations = new[]
{
"string",
},
AlertChannelSubscriptions = new[]
{
new Checkly.Inputs.UrlMonitorAlertChannelSubscriptionArgs
{
Activated = false,
ChannelId = 0,
},
},
RetryStrategy = new Checkly.Inputs.UrlMonitorRetryStrategyArgs
{
Type = "string",
BaseBackoffSeconds = 0,
MaxDurationSeconds = 0,
MaxRetries = 0,
SameRegion = false,
},
RunParallel = false,
ShouldFail = false,
Tags = new[]
{
"string",
},
UseGlobalAlertSettings = false,
});
example, err := checkly.NewUrlMonitor(ctx, "urlMonitorResource", &checkly.UrlMonitorArgs{
Frequency: pulumi.Int(0),
Request: &checkly.UrlMonitorRequestArgs{
Url: pulumi.String("string"),
Assertions: checkly.UrlMonitorRequestAssertionArray{
&checkly.UrlMonitorRequestAssertionArgs{
Comparison: pulumi.String("string"),
Source: pulumi.String("string"),
Target: pulumi.String("string"),
Property: pulumi.String("string"),
},
},
FollowRedirects: pulumi.Bool(false),
IpFamily: pulumi.String("string"),
SkipSsl: pulumi.Bool(false),
},
Activated: pulumi.Bool(false),
Locations: pulumi.StringArray{
pulumi.String("string"),
},
Muted: pulumi.Bool(false),
FrequencyOffset: pulumi.Int(0),
GroupId: pulumi.Int(0),
GroupOrder: pulumi.Int(0),
AlertSettings: &checkly.UrlMonitorAlertSettingsArgs{
EscalationType: pulumi.String("string"),
ParallelRunFailureThresholds: checkly.UrlMonitorAlertSettingsParallelRunFailureThresholdArray{
&checkly.UrlMonitorAlertSettingsParallelRunFailureThresholdArgs{
Enabled: pulumi.Bool(false),
Percentage: pulumi.Int(0),
},
},
Reminders: checkly.UrlMonitorAlertSettingsReminderArray{
&checkly.UrlMonitorAlertSettingsReminderArgs{
Amount: pulumi.Int(0),
Interval: pulumi.Int(0),
},
},
RunBasedEscalations: checkly.UrlMonitorAlertSettingsRunBasedEscalationArray{
&checkly.UrlMonitorAlertSettingsRunBasedEscalationArgs{
FailedRunThreshold: pulumi.Int(0),
},
},
TimeBasedEscalations: checkly.UrlMonitorAlertSettingsTimeBasedEscalationArray{
&checkly.UrlMonitorAlertSettingsTimeBasedEscalationArgs{
MinutesFailingThreshold: pulumi.Int(0),
},
},
},
MaxResponseTime: pulumi.Int(0),
DegradedResponseTime: pulumi.Int(0),
Name: pulumi.String("string"),
PrivateLocations: pulumi.StringArray{
pulumi.String("string"),
},
AlertChannelSubscriptions: checkly.UrlMonitorAlertChannelSubscriptionArray{
&checkly.UrlMonitorAlertChannelSubscriptionArgs{
Activated: pulumi.Bool(false),
ChannelId: pulumi.Int(0),
},
},
RetryStrategy: &checkly.UrlMonitorRetryStrategyArgs{
Type: pulumi.String("string"),
BaseBackoffSeconds: pulumi.Int(0),
MaxDurationSeconds: pulumi.Int(0),
MaxRetries: pulumi.Int(0),
SameRegion: pulumi.Bool(false),
},
RunParallel: pulumi.Bool(false),
ShouldFail: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UseGlobalAlertSettings: pulumi.Bool(false),
})
var urlMonitorResource = new UrlMonitor("urlMonitorResource", UrlMonitorArgs.builder()
.frequency(0)
.request(UrlMonitorRequestArgs.builder()
.url("string")
.assertions(UrlMonitorRequestAssertionArgs.builder()
.comparison("string")
.source("string")
.target("string")
.property("string")
.build())
.followRedirects(false)
.ipFamily("string")
.skipSsl(false)
.build())
.activated(false)
.locations("string")
.muted(false)
.frequencyOffset(0)
.groupId(0)
.groupOrder(0)
.alertSettings(UrlMonitorAlertSettingsArgs.builder()
.escalationType("string")
.parallelRunFailureThresholds(UrlMonitorAlertSettingsParallelRunFailureThresholdArgs.builder()
.enabled(false)
.percentage(0)
.build())
.reminders(UrlMonitorAlertSettingsReminderArgs.builder()
.amount(0)
.interval(0)
.build())
.runBasedEscalations(UrlMonitorAlertSettingsRunBasedEscalationArgs.builder()
.failedRunThreshold(0)
.build())
.timeBasedEscalations(UrlMonitorAlertSettingsTimeBasedEscalationArgs.builder()
.minutesFailingThreshold(0)
.build())
.build())
.maxResponseTime(0)
.degradedResponseTime(0)
.name("string")
.privateLocations("string")
.alertChannelSubscriptions(UrlMonitorAlertChannelSubscriptionArgs.builder()
.activated(false)
.channelId(0)
.build())
.retryStrategy(UrlMonitorRetryStrategyArgs.builder()
.type("string")
.baseBackoffSeconds(0)
.maxDurationSeconds(0)
.maxRetries(0)
.sameRegion(false)
.build())
.runParallel(false)
.shouldFail(false)
.tags("string")
.useGlobalAlertSettings(false)
.build());
url_monitor_resource = checkly.UrlMonitor("urlMonitorResource",
frequency=0,
request={
"url": "string",
"assertions": [{
"comparison": "string",
"source": "string",
"target": "string",
"property": "string",
}],
"follow_redirects": False,
"ip_family": "string",
"skip_ssl": False,
},
activated=False,
locations=["string"],
muted=False,
frequency_offset=0,
group_id=0,
group_order=0,
alert_settings={
"escalation_type": "string",
"parallel_run_failure_thresholds": [{
"enabled": False,
"percentage": 0,
}],
"reminders": [{
"amount": 0,
"interval": 0,
}],
"run_based_escalations": [{
"failed_run_threshold": 0,
}],
"time_based_escalations": [{
"minutes_failing_threshold": 0,
}],
},
max_response_time=0,
degraded_response_time=0,
name="string",
private_locations=["string"],
alert_channel_subscriptions=[{
"activated": False,
"channel_id": 0,
}],
retry_strategy={
"type": "string",
"base_backoff_seconds": 0,
"max_duration_seconds": 0,
"max_retries": 0,
"same_region": False,
},
run_parallel=False,
should_fail=False,
tags=["string"],
use_global_alert_settings=False)
const urlMonitorResource = new checkly.UrlMonitor("urlMonitorResource", {
frequency: 0,
request: {
url: "string",
assertions: [{
comparison: "string",
source: "string",
target: "string",
property: "string",
}],
followRedirects: false,
ipFamily: "string",
skipSsl: false,
},
activated: false,
locations: ["string"],
muted: false,
frequencyOffset: 0,
groupId: 0,
groupOrder: 0,
alertSettings: {
escalationType: "string",
parallelRunFailureThresholds: [{
enabled: false,
percentage: 0,
}],
reminders: [{
amount: 0,
interval: 0,
}],
runBasedEscalations: [{
failedRunThreshold: 0,
}],
timeBasedEscalations: [{
minutesFailingThreshold: 0,
}],
},
maxResponseTime: 0,
degradedResponseTime: 0,
name: "string",
privateLocations: ["string"],
alertChannelSubscriptions: [{
activated: false,
channelId: 0,
}],
retryStrategy: {
type: "string",
baseBackoffSeconds: 0,
maxDurationSeconds: 0,
maxRetries: 0,
sameRegion: false,
},
runParallel: false,
shouldFail: false,
tags: ["string"],
useGlobalAlertSettings: false,
});
type: checkly:UrlMonitor
properties:
activated: false
alertChannelSubscriptions:
- activated: false
channelId: 0
alertSettings:
escalationType: string
parallelRunFailureThresholds:
- enabled: false
percentage: 0
reminders:
- amount: 0
interval: 0
runBasedEscalations:
- failedRunThreshold: 0
timeBasedEscalations:
- minutesFailingThreshold: 0
degradedResponseTime: 0
frequency: 0
frequencyOffset: 0
groupId: 0
groupOrder: 0
locations:
- string
maxResponseTime: 0
muted: false
name: string
privateLocations:
- string
request:
assertions:
- comparison: string
property: string
source: string
target: string
followRedirects: false
ipFamily: string
skipSsl: false
url: string
retryStrategy:
baseBackoffSeconds: 0
maxDurationSeconds: 0
maxRetries: 0
sameRegion: false
type: string
runParallel: false
shouldFail: false
tags:
- string
useGlobalAlertSettings: false
UrlMonitor Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The UrlMonitor resource accepts the following input properties:
- Activated bool
- Determines whether the monitor will run periodically or not after being deployed.
- Frequency int
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - Request
Url
Monitor Request - The parameters of the HTTP request.
- Alert
Channel List<UrlSubscriptions Monitor Alert Channel Subscription> - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- Alert
Settings UrlMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- Degraded
Response intTime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - Frequency
Offset int - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - Group
Id int - The ID of the check group that this monitor is part of.
- Group
Order int - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- Locations List<string>
- An array of one or more data center locations where to run the this monitor.
- Max
Response intTime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - Muted bool
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - Name string
- The name of the monitor.
- Private
Locations List<string> - An array of one or more private locations slugs.
- Retry
Strategy UrlMonitor Retry Strategy - A strategy for retrying failed monitor runs.
- Run
Parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - Should
Fail bool - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - List<string>
- A list of tags for organizing and filtering checks and monitors.
- Use
Global boolAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
- Activated bool
- Determines whether the monitor will run periodically or not after being deployed.
- Frequency int
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - Request
Url
Monitor Request Args - The parameters of the HTTP request.
- Alert
Channel []UrlSubscriptions Monitor Alert Channel Subscription Args - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- Alert
Settings UrlMonitor Alert Settings Args - Determines the alert escalation policy for the monitor.
- Degraded
Response intTime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - Frequency
Offset int - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - Group
Id int - The ID of the check group that this monitor is part of.
- Group
Order int - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- Locations []string
- An array of one or more data center locations where to run the this monitor.
- Max
Response intTime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - Muted bool
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - Name string
- The name of the monitor.
- Private
Locations []string - An array of one or more private locations slugs.
- Retry
Strategy UrlMonitor Retry Strategy Args - A strategy for retrying failed monitor runs.
- Run
Parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - Should
Fail bool - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - []string
- A list of tags for organizing and filtering checks and monitors.
- Use
Global boolAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
- activated Boolean
- Determines whether the monitor will run periodically or not after being deployed.
- frequency Integer
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - request
Url
Monitor Request - The parameters of the HTTP request.
- alert
Channel List<UrlSubscriptions Monitor Alert Channel Subscription> - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- alert
Settings UrlMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- degraded
Response IntegerTime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - frequency
Offset Integer - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - group
Id Integer - The ID of the check group that this monitor is part of.
- group
Order Integer - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- locations List<String>
- An array of one or more data center locations where to run the this monitor.
- max
Response IntegerTime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - muted Boolean
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - name String
- The name of the monitor.
- private
Locations List<String> - An array of one or more private locations slugs.
- retry
Strategy UrlMonitor Retry Strategy - A strategy for retrying failed monitor runs.
- run
Parallel Boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - should
Fail Boolean - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - List<String>
- A list of tags for organizing and filtering checks and monitors.
- use
Global BooleanAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
- activated boolean
- Determines whether the monitor will run periodically or not after being deployed.
- frequency number
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - request
Url
Monitor Request - The parameters of the HTTP request.
- alert
Channel UrlSubscriptions Monitor Alert Channel Subscription[] - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- alert
Settings UrlMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- degraded
Response numberTime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - frequency
Offset number - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - group
Id number - The ID of the check group that this monitor is part of.
- group
Order number - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- locations string[]
- An array of one or more data center locations where to run the this monitor.
- max
Response numberTime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - muted boolean
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - name string
- The name of the monitor.
- private
Locations string[] - An array of one or more private locations slugs.
- retry
Strategy UrlMonitor Retry Strategy - A strategy for retrying failed monitor runs.
- run
Parallel boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - should
Fail boolean - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - string[]
- A list of tags for organizing and filtering checks and monitors.
- use
Global booleanAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
- activated bool
- Determines whether the monitor will run periodically or not after being deployed.
- frequency int
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - request
Url
Monitor Request Args - The parameters of the HTTP request.
- alert_
channel_ Sequence[Urlsubscriptions Monitor Alert Channel Subscription Args] - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- alert_
settings UrlMonitor Alert Settings Args - Determines the alert escalation policy for the monitor.
- degraded_
response_ inttime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - frequency_
offset int - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - group_
id int - The ID of the check group that this monitor is part of.
- group_
order int - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- locations Sequence[str]
- An array of one or more data center locations where to run the this monitor.
- max_
response_ inttime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - muted bool
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - name str
- The name of the monitor.
- private_
locations Sequence[str] - An array of one or more private locations slugs.
- retry_
strategy UrlMonitor Retry Strategy Args - A strategy for retrying failed monitor runs.
- run_
parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - should_
fail bool - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - Sequence[str]
- A list of tags for organizing and filtering checks and monitors.
- use_
global_ boolalert_ settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
- activated Boolean
- Determines whether the monitor will run periodically or not after being deployed.
- frequency Number
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - request Property Map
- The parameters of the HTTP request.
- alert
Channel List<Property Map>Subscriptions - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- alert
Settings Property Map - Determines the alert escalation policy for the monitor.
- degraded
Response NumberTime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - frequency
Offset Number - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - group
Id Number - The ID of the check group that this monitor is part of.
- group
Order Number - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- locations List<String>
- An array of one or more data center locations where to run the this monitor.
- max
Response NumberTime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - muted Boolean
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - name String
- The name of the monitor.
- private
Locations List<String> - An array of one or more private locations slugs.
- retry
Strategy Property Map - A strategy for retrying failed monitor runs.
- run
Parallel Boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - should
Fail Boolean - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - List<String>
- A list of tags for organizing and filtering checks and monitors.
- use
Global BooleanAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
Outputs
All input properties are implicitly available as output properties. Additionally, the UrlMonitor resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing UrlMonitor Resource
Get an existing UrlMonitor resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: UrlMonitorState, opts?: CustomResourceOptions): UrlMonitor
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
activated: Optional[bool] = None,
alert_channel_subscriptions: Optional[Sequence[UrlMonitorAlertChannelSubscriptionArgs]] = None,
alert_settings: Optional[UrlMonitorAlertSettingsArgs] = None,
degraded_response_time: Optional[int] = None,
frequency: Optional[int] = None,
frequency_offset: Optional[int] = None,
group_id: Optional[int] = None,
group_order: Optional[int] = None,
locations: Optional[Sequence[str]] = None,
max_response_time: Optional[int] = None,
muted: Optional[bool] = None,
name: Optional[str] = None,
private_locations: Optional[Sequence[str]] = None,
request: Optional[UrlMonitorRequestArgs] = None,
retry_strategy: Optional[UrlMonitorRetryStrategyArgs] = None,
run_parallel: Optional[bool] = None,
should_fail: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
use_global_alert_settings: Optional[bool] = None) -> UrlMonitor
func GetUrlMonitor(ctx *Context, name string, id IDInput, state *UrlMonitorState, opts ...ResourceOption) (*UrlMonitor, error)
public static UrlMonitor Get(string name, Input<string> id, UrlMonitorState? state, CustomResourceOptions? opts = null)
public static UrlMonitor get(String name, Output<String> id, UrlMonitorState state, CustomResourceOptions options)
resources: _: type: checkly:UrlMonitor get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Activated bool
- Determines whether the monitor will run periodically or not after being deployed.
- Alert
Channel List<UrlSubscriptions Monitor Alert Channel Subscription> - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- Alert
Settings UrlMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- Degraded
Response intTime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - Frequency int
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - Frequency
Offset int - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - Group
Id int - The ID of the check group that this monitor is part of.
- Group
Order int - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- Locations List<string>
- An array of one or more data center locations where to run the this monitor.
- Max
Response intTime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - Muted bool
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - Name string
- The name of the monitor.
- Private
Locations List<string> - An array of one or more private locations slugs.
- Request
Url
Monitor Request - The parameters of the HTTP request.
- Retry
Strategy UrlMonitor Retry Strategy - A strategy for retrying failed monitor runs.
- Run
Parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - Should
Fail bool - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - List<string>
- A list of tags for organizing and filtering checks and monitors.
- Use
Global boolAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
- Activated bool
- Determines whether the monitor will run periodically or not after being deployed.
- Alert
Channel []UrlSubscriptions Monitor Alert Channel Subscription Args - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- Alert
Settings UrlMonitor Alert Settings Args - Determines the alert escalation policy for the monitor.
- Degraded
Response intTime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - Frequency int
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - Frequency
Offset int - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - Group
Id int - The ID of the check group that this monitor is part of.
- Group
Order int - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- Locations []string
- An array of one or more data center locations where to run the this monitor.
- Max
Response intTime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - Muted bool
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - Name string
- The name of the monitor.
- Private
Locations []string - An array of one or more private locations slugs.
- Request
Url
Monitor Request Args - The parameters of the HTTP request.
- Retry
Strategy UrlMonitor Retry Strategy Args - A strategy for retrying failed monitor runs.
- Run
Parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - Should
Fail bool - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - []string
- A list of tags for organizing and filtering checks and monitors.
- Use
Global boolAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
- activated Boolean
- Determines whether the monitor will run periodically or not after being deployed.
- alert
Channel List<UrlSubscriptions Monitor Alert Channel Subscription> - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- alert
Settings UrlMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- degraded
Response IntegerTime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - frequency Integer
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - frequency
Offset Integer - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - group
Id Integer - The ID of the check group that this monitor is part of.
- group
Order Integer - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- locations List<String>
- An array of one or more data center locations where to run the this monitor.
- max
Response IntegerTime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - muted Boolean
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - name String
- The name of the monitor.
- private
Locations List<String> - An array of one or more private locations slugs.
- request
Url
Monitor Request - The parameters of the HTTP request.
- retry
Strategy UrlMonitor Retry Strategy - A strategy for retrying failed monitor runs.
- run
Parallel Boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - should
Fail Boolean - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - List<String>
- A list of tags for organizing and filtering checks and monitors.
- use
Global BooleanAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
- activated boolean
- Determines whether the monitor will run periodically or not after being deployed.
- alert
Channel UrlSubscriptions Monitor Alert Channel Subscription[] - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- alert
Settings UrlMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- degraded
Response numberTime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - frequency number
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - frequency
Offset number - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - group
Id number - The ID of the check group that this monitor is part of.
- group
Order number - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- locations string[]
- An array of one or more data center locations where to run the this monitor.
- max
Response numberTime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - muted boolean
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - name string
- The name of the monitor.
- private
Locations string[] - An array of one or more private locations slugs.
- request
Url
Monitor Request - The parameters of the HTTP request.
- retry
Strategy UrlMonitor Retry Strategy - A strategy for retrying failed monitor runs.
- run
Parallel boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - should
Fail boolean - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - string[]
- A list of tags for organizing and filtering checks and monitors.
- use
Global booleanAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
- activated bool
- Determines whether the monitor will run periodically or not after being deployed.
- alert_
channel_ Sequence[Urlsubscriptions Monitor Alert Channel Subscription Args] - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- alert_
settings UrlMonitor Alert Settings Args - Determines the alert escalation policy for the monitor.
- degraded_
response_ inttime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - frequency int
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - frequency_
offset int - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - group_
id int - The ID of the check group that this monitor is part of.
- group_
order int - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- locations Sequence[str]
- An array of one or more data center locations where to run the this monitor.
- max_
response_ inttime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - muted bool
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - name str
- The name of the monitor.
- private_
locations Sequence[str] - An array of one or more private locations slugs.
- request
Url
Monitor Request Args - The parameters of the HTTP request.
- retry_
strategy UrlMonitor Retry Strategy Args - A strategy for retrying failed monitor runs.
- run_
parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - should_
fail bool - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - Sequence[str]
- A list of tags for organizing and filtering checks and monitors.
- use_
global_ boolalert_ settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
- activated Boolean
- Determines whether the monitor will run periodically or not after being deployed.
- alert
Channel List<Property Map>Subscriptions - An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your monitor, we won't be able to alert you.
- alert
Settings Property Map - Determines the alert escalation policy for the monitor.
- degraded
Response NumberTime - The response time in milliseconds where the monitor should be considered degraded. Possible values are between
0
and30000
. (Default3000
). - frequency Number
- How often the monitor should run in minutes. Possible values are
0
,1
,2
,5
,10
,15
,30
,60
,120
,180
,360
,720
, and1440
. - frequency
Offset Number - To create a high frequency monitor, set
frequency
to0
andfrequency_offset
to10
,20
, or30
. - group
Id Number - The ID of the check group that this monitor is part of.
- group
Order Number - The position of the monitor in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
- locations List<String>
- An array of one or more data center locations where to run the this monitor.
- max
Response NumberTime - The response time in milliseconds where the monitor should be considered failing. Possible values are between
0
and30000
. (Default5000
). - muted Boolean
- Determines if any notifications will be sent out when the monitor fails and/or recovers. (Default
false
). - name String
- The name of the monitor.
- private
Locations List<String> - An array of one or more private locations slugs.
- request Property Map
- The parameters of the HTTP request.
- retry
Strategy Property Map - A strategy for retrying failed monitor runs.
- run
Parallel Boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false
). - should
Fail Boolean - Allows to invert the behaviour of when the monitor is considered to fail. (Default
false
). - List<String>
- A list of tags for organizing and filtering checks and monitors.
- use
Global BooleanAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default
true
).
Supporting Types
UrlMonitorAlertChannelSubscription, UrlMonitorAlertChannelSubscriptionArgs
- activated bool
- Whether an alert should be sent to this channel.
- channel_
id int - The ID of the alert channel.
UrlMonitorAlertSettings, UrlMonitorAlertSettingsArgs
- Escalation
Type string - Determines what type of escalation to use. Possible values are
RUN_BASED
andTIME_BASED
. - Parallel
Run List<UrlFailure Thresholds Monitor Alert Settings Parallel Run Failure Threshold> - Configuration for parallel run failure threshold.
- Reminders
List<Url
Monitor Alert Settings Reminder> - Defines how often to send reminder notifications after initial alert.
- Run
Based List<UrlEscalations Monitor Alert Settings Run Based Escalation> - Configuration for run-based escalation.
- Time
Based List<UrlEscalations Monitor Alert Settings Time Based Escalation> - Configuration for time-based escalation.
- Escalation
Type string - Determines what type of escalation to use. Possible values are
RUN_BASED
andTIME_BASED
. - Parallel
Run []UrlFailure Thresholds Monitor Alert Settings Parallel Run Failure Threshold - Configuration for parallel run failure threshold.
- Reminders
[]Url
Monitor Alert Settings Reminder - Defines how often to send reminder notifications after initial alert.
- Run
Based []UrlEscalations Monitor Alert Settings Run Based Escalation - Configuration for run-based escalation.
- Time
Based []UrlEscalations Monitor Alert Settings Time Based Escalation - Configuration for time-based escalation.
- escalation
Type String - Determines what type of escalation to use. Possible values are
RUN_BASED
andTIME_BASED
. - parallel
Run List<UrlFailure Thresholds Monitor Alert Settings Parallel Run Failure Threshold> - Configuration for parallel run failure threshold.
- reminders
List<Url
Monitor Alert Settings Reminder> - Defines how often to send reminder notifications after initial alert.
- run
Based List<UrlEscalations Monitor Alert Settings Run Based Escalation> - Configuration for run-based escalation.
- time
Based List<UrlEscalations Monitor Alert Settings Time Based Escalation> - Configuration for time-based escalation.
- escalation
Type string - Determines what type of escalation to use. Possible values are
RUN_BASED
andTIME_BASED
. - parallel
Run UrlFailure Thresholds Monitor Alert Settings Parallel Run Failure Threshold[] - Configuration for parallel run failure threshold.
- reminders
Url
Monitor Alert Settings Reminder[] - Defines how often to send reminder notifications after initial alert.
- run
Based UrlEscalations Monitor Alert Settings Run Based Escalation[] - Configuration for run-based escalation.
- time
Based UrlEscalations Monitor Alert Settings Time Based Escalation[] - Configuration for time-based escalation.
- escalation_
type str - Determines what type of escalation to use. Possible values are
RUN_BASED
andTIME_BASED
. - parallel_
run_ Sequence[Urlfailure_ thresholds Monitor Alert Settings Parallel Run Failure Threshold] - Configuration for parallel run failure threshold.
- reminders
Sequence[Url
Monitor Alert Settings Reminder] - Defines how often to send reminder notifications after initial alert.
- run_
based_ Sequence[Urlescalations Monitor Alert Settings Run Based Escalation] - Configuration for run-based escalation.
- time_
based_ Sequence[Urlescalations Monitor Alert Settings Time Based Escalation] - Configuration for time-based escalation.
- escalation
Type String - Determines what type of escalation to use. Possible values are
RUN_BASED
andTIME_BASED
. - parallel
Run List<Property Map>Failure Thresholds - Configuration for parallel run failure threshold.
- reminders List<Property Map>
- Defines how often to send reminder notifications after initial alert.
- run
Based List<Property Map>Escalations - Configuration for run-based escalation.
- time
Based List<Property Map>Escalations - Configuration for time-based escalation.
UrlMonitorAlertSettingsParallelRunFailureThreshold, UrlMonitorAlertSettingsParallelRunFailureThresholdArgs
- Enabled bool
- Whether parallel run failure threshold is enabled. Applicable only for monitors scheduled in parallel in multiple locations. (Default
false
). - Percentage int
- Percentage of runs that must fail to trigger alert. Possible values are
10
,20
,30
,40
,50
,60
,70
,80
,90
, and100
. (Default10
).
- Enabled bool
- Whether parallel run failure threshold is enabled. Applicable only for monitors scheduled in parallel in multiple locations. (Default
false
). - Percentage int
- Percentage of runs that must fail to trigger alert. Possible values are
10
,20
,30
,40
,50
,60
,70
,80
,90
, and100
. (Default10
).
- enabled Boolean
- Whether parallel run failure threshold is enabled. Applicable only for monitors scheduled in parallel in multiple locations. (Default
false
). - percentage Integer
- Percentage of runs that must fail to trigger alert. Possible values are
10
,20
,30
,40
,50
,60
,70
,80
,90
, and100
. (Default10
).
- enabled boolean
- Whether parallel run failure threshold is enabled. Applicable only for monitors scheduled in parallel in multiple locations. (Default
false
). - percentage number
- Percentage of runs that must fail to trigger alert. Possible values are
10
,20
,30
,40
,50
,60
,70
,80
,90
, and100
. (Default10
).
- enabled bool
- Whether parallel run failure threshold is enabled. Applicable only for monitors scheduled in parallel in multiple locations. (Default
false
). - percentage int
- Percentage of runs that must fail to trigger alert. Possible values are
10
,20
,30
,40
,50
,60
,70
,80
,90
, and100
. (Default10
).
- enabled Boolean
- Whether parallel run failure threshold is enabled. Applicable only for monitors scheduled in parallel in multiple locations. (Default
false
). - percentage Number
- Percentage of runs that must fail to trigger alert. Possible values are
10
,20
,30
,40
,50
,60
,70
,80
,90
, and100
. (Default10
).
UrlMonitorAlertSettingsReminder, UrlMonitorAlertSettingsReminderArgs
UrlMonitorAlertSettingsRunBasedEscalation, UrlMonitorAlertSettingsRunBasedEscalationArgs
- Failed
Run intThreshold - After how many failed consecutive check runs an alert notification should be sent. Possible values are between
1
and5
. (Default1
).
- Failed
Run intThreshold - After how many failed consecutive check runs an alert notification should be sent. Possible values are between
1
and5
. (Default1
).
- failed
Run IntegerThreshold - After how many failed consecutive check runs an alert notification should be sent. Possible values are between
1
and5
. (Default1
).
- failed
Run numberThreshold - After how many failed consecutive check runs an alert notification should be sent. Possible values are between
1
and5
. (Default1
).
- failed_
run_ intthreshold - After how many failed consecutive check runs an alert notification should be sent. Possible values are between
1
and5
. (Default1
).
- failed
Run NumberThreshold - After how many failed consecutive check runs an alert notification should be sent. Possible values are between
1
and5
. (Default1
).
UrlMonitorAlertSettingsTimeBasedEscalation, UrlMonitorAlertSettingsTimeBasedEscalationArgs
- Minutes
Failing intThreshold - After how many minutes after a monitor starts failing an alert should be sent. Possible values are
5
,10
,15
, and30
. (Default5
).
- Minutes
Failing intThreshold - After how many minutes after a monitor starts failing an alert should be sent. Possible values are
5
,10
,15
, and30
. (Default5
).
- minutes
Failing IntegerThreshold - After how many minutes after a monitor starts failing an alert should be sent. Possible values are
5
,10
,15
, and30
. (Default5
).
- minutes
Failing numberThreshold - After how many minutes after a monitor starts failing an alert should be sent. Possible values are
5
,10
,15
, and30
. (Default5
).
- minutes_
failing_ intthreshold - After how many minutes after a monitor starts failing an alert should be sent. Possible values are
5
,10
,15
, and30
. (Default5
).
- minutes
Failing NumberThreshold - After how many minutes after a monitor starts failing an alert should be sent. Possible values are
5
,10
,15
, and30
. (Default5
).
UrlMonitorRequest, UrlMonitorRequestArgs
- Url string
- The URL to monitor. Must be a valid HTTP or HTTPS URL.
- Assertions
List<Url
Monitor Request Assertion> - Assertions to validate the HTTP response. URL monitors only support status code assertions.
- Follow
Redirects bool - Whether to follow HTTP redirects automatically. (Default
true
). - Ip
Family string - IP family version to use for the connection. The value can be either
IPv4
orIPv6
. (DefaultIPv4
). - Skip
Ssl bool - Whether to skip SSL certificate verification. (Default
false
).
- Url string
- The URL to monitor. Must be a valid HTTP or HTTPS URL.
- Assertions
[]Url
Monitor Request Assertion - Assertions to validate the HTTP response. URL monitors only support status code assertions.
- Follow
Redirects bool - Whether to follow HTTP redirects automatically. (Default
true
). - Ip
Family string - IP family version to use for the connection. The value can be either
IPv4
orIPv6
. (DefaultIPv4
). - Skip
Ssl bool - Whether to skip SSL certificate verification. (Default
false
).
- url String
- The URL to monitor. Must be a valid HTTP or HTTPS URL.
- assertions
List<Url
Monitor Request Assertion> - Assertions to validate the HTTP response. URL monitors only support status code assertions.
- follow
Redirects Boolean - Whether to follow HTTP redirects automatically. (Default
true
). - ip
Family String - IP family version to use for the connection. The value can be either
IPv4
orIPv6
. (DefaultIPv4
). - skip
Ssl Boolean - Whether to skip SSL certificate verification. (Default
false
).
- url string
- The URL to monitor. Must be a valid HTTP or HTTPS URL.
- assertions
Url
Monitor Request Assertion[] - Assertions to validate the HTTP response. URL monitors only support status code assertions.
- follow
Redirects boolean - Whether to follow HTTP redirects automatically. (Default
true
). - ip
Family string - IP family version to use for the connection. The value can be either
IPv4
orIPv6
. (DefaultIPv4
). - skip
Ssl boolean - Whether to skip SSL certificate verification. (Default
false
).
- url str
- The URL to monitor. Must be a valid HTTP or HTTPS URL.
- assertions
Sequence[Url
Monitor Request Assertion] - Assertions to validate the HTTP response. URL monitors only support status code assertions.
- follow_
redirects bool - Whether to follow HTTP redirects automatically. (Default
true
). - ip_
family str - IP family version to use for the connection. The value can be either
IPv4
orIPv6
. (DefaultIPv4
). - skip_
ssl bool - Whether to skip SSL certificate verification. (Default
false
).
- url String
- The URL to monitor. Must be a valid HTTP or HTTPS URL.
- assertions List<Property Map>
- Assertions to validate the HTTP response. URL monitors only support status code assertions.
- follow
Redirects Boolean - Whether to follow HTTP redirects automatically. (Default
true
). - ip
Family String - IP family version to use for the connection. The value can be either
IPv4
orIPv6
. (DefaultIPv4
). - skip
Ssl Boolean - Whether to skip SSL certificate verification. (Default
false
).
UrlMonitorRequestAssertion, UrlMonitorRequestAssertionArgs
- Comparison string
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS
,NOT_EQUALS
,GREATER_THAN
andLESS_THAN
. - Source string
- The source of the asserted value. The only allowed value is
STATUS_CODE
. - Target string
- The target value. Typically
200
when the source isSTATUS_CODE
. - Property string
- Comparison string
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS
,NOT_EQUALS
,GREATER_THAN
andLESS_THAN
. - Source string
- The source of the asserted value. The only allowed value is
STATUS_CODE
. - Target string
- The target value. Typically
200
when the source isSTATUS_CODE
. - Property string
- comparison String
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS
,NOT_EQUALS
,GREATER_THAN
andLESS_THAN
. - source String
- The source of the asserted value. The only allowed value is
STATUS_CODE
. - target String
- The target value. Typically
200
when the source isSTATUS_CODE
. - property String
- comparison string
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS
,NOT_EQUALS
,GREATER_THAN
andLESS_THAN
. - source string
- The source of the asserted value. The only allowed value is
STATUS_CODE
. - target string
- The target value. Typically
200
when the source isSTATUS_CODE
. - property string
- comparison str
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS
,NOT_EQUALS
,GREATER_THAN
andLESS_THAN
. - source str
- The source of the asserted value. The only allowed value is
STATUS_CODE
. - target str
- The target value. Typically
200
when the source isSTATUS_CODE
. - property str
- comparison String
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS
,NOT_EQUALS
,GREATER_THAN
andLESS_THAN
. - source String
- The source of the asserted value. The only allowed value is
STATUS_CODE
. - target String
- The target value. Typically
200
when the source isSTATUS_CODE
. - property String
UrlMonitorRetryStrategy, UrlMonitorRetryStrategyArgs
- Type string
- Determines which type of retry strategy to use. Possible values are
FIXED
,LINEAR
, andEXPONENTIAL
. - Base
Backoff intSeconds - The number of seconds to wait before the first retry attempt. (Default
60
). - Max
Duration intSeconds - The total amount of time to continue retrying the monitor (maximum 600 seconds). (Default
600
). - Max
Retries int - The maximum number of times to retry the monitor. Value must be between
1
and10
. (Default2
). - Same
Region bool - Whether retries should be run in the same region as the initial monitor run. (Default
true
).
- Type string
- Determines which type of retry strategy to use. Possible values are
FIXED
,LINEAR
, andEXPONENTIAL
. - Base
Backoff intSeconds - The number of seconds to wait before the first retry attempt. (Default
60
). - Max
Duration intSeconds - The total amount of time to continue retrying the monitor (maximum 600 seconds). (Default
600
). - Max
Retries int - The maximum number of times to retry the monitor. Value must be between
1
and10
. (Default2
). - Same
Region bool - Whether retries should be run in the same region as the initial monitor run. (Default
true
).
- type String
- Determines which type of retry strategy to use. Possible values are
FIXED
,LINEAR
, andEXPONENTIAL
. - base
Backoff IntegerSeconds - The number of seconds to wait before the first retry attempt. (Default
60
). - max
Duration IntegerSeconds - The total amount of time to continue retrying the monitor (maximum 600 seconds). (Default
600
). - max
Retries Integer - The maximum number of times to retry the monitor. Value must be between
1
and10
. (Default2
). - same
Region Boolean - Whether retries should be run in the same region as the initial monitor run. (Default
true
).
- type string
- Determines which type of retry strategy to use. Possible values are
FIXED
,LINEAR
, andEXPONENTIAL
. - base
Backoff numberSeconds - The number of seconds to wait before the first retry attempt. (Default
60
). - max
Duration numberSeconds - The total amount of time to continue retrying the monitor (maximum 600 seconds). (Default
600
). - max
Retries number - The maximum number of times to retry the monitor. Value must be between
1
and10
. (Default2
). - same
Region boolean - Whether retries should be run in the same region as the initial monitor run. (Default
true
).
- type str
- Determines which type of retry strategy to use. Possible values are
FIXED
,LINEAR
, andEXPONENTIAL
. - base_
backoff_ intseconds - The number of seconds to wait before the first retry attempt. (Default
60
). - max_
duration_ intseconds - The total amount of time to continue retrying the monitor (maximum 600 seconds). (Default
600
). - max_
retries int - The maximum number of times to retry the monitor. Value must be between
1
and10
. (Default2
). - same_
region bool - Whether retries should be run in the same region as the initial monitor run. (Default
true
).
- type String
- Determines which type of retry strategy to use. Possible values are
FIXED
,LINEAR
, andEXPONENTIAL
. - base
Backoff NumberSeconds - The number of seconds to wait before the first retry attempt. (Default
60
). - max
Duration NumberSeconds - The total amount of time to continue retrying the monitor (maximum 600 seconds). (Default
600
). - max
Retries Number - The maximum number of times to retry the monitor. Value must be between
1
and10
. (Default2
). - same
Region Boolean - Whether retries should be run in the same region as the initial monitor run. (Default
true
).
Package Details
- Repository
- checkly checkly/pulumi-checkly
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
checkly
Terraform Provider.