Creates an ICMP Monitor to check host availability using ping.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as checkly from "@checkly/pulumi";
const example_icmp_monitor = new checkly.IcmpMonitor("example-icmp-monitor", {
name: "Example ICMP monitor",
activated: true,
frequency: 10,
useGlobalAlertSettings: true,
locations: ["eu-west-1"],
request: {
hostname: "example.com",
ipFamily: "IPv4",
pingCount: 10,
assertions: [{
source: "LATENCY",
property: "avg",
comparison: "LESS_THAN",
target: "200",
}],
},
});
import pulumi
import pulumi_checkly as checkly
example_icmp_monitor = checkly.IcmpMonitor("example-icmp-monitor",
name="Example ICMP monitor",
activated=True,
frequency=10,
use_global_alert_settings=True,
locations=["eu-west-1"],
request={
"hostname": "example.com",
"ip_family": "IPv4",
"ping_count": 10,
"assertions": [{
"source": "LATENCY",
"property": "avg",
"comparison": "LESS_THAN",
"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.NewIcmpMonitor(ctx, "example-icmp-monitor", &checkly.IcmpMonitorArgs{
Name: pulumi.String("Example ICMP monitor"),
Activated: pulumi.Bool(true),
Frequency: pulumi.Int(10),
UseGlobalAlertSettings: pulumi.Bool(true),
Locations: pulumi.StringArray{
pulumi.String("eu-west-1"),
},
Request: &checkly.IcmpMonitorRequestArgs{
Hostname: pulumi.String("example.com"),
IpFamily: pulumi.String("IPv4"),
PingCount: pulumi.Int(10),
Assertions: checkly.IcmpMonitorRequestAssertionArray{
&checkly.IcmpMonitorRequestAssertionArgs{
Source: pulumi.String("LATENCY"),
Property: pulumi.String("avg"),
Comparison: pulumi.String("LESS_THAN"),
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_icmp_monitor = new Checkly.IcmpMonitor("example-icmp-monitor", new()
{
Name = "Example ICMP monitor",
Activated = true,
Frequency = 10,
UseGlobalAlertSettings = true,
Locations = new[]
{
"eu-west-1",
},
Request = new Checkly.Inputs.IcmpMonitorRequestArgs
{
Hostname = "example.com",
IpFamily = "IPv4",
PingCount = 10,
Assertions = new[]
{
new Checkly.Inputs.IcmpMonitorRequestAssertionArgs
{
Source = "LATENCY",
Property = "avg",
Comparison = "LESS_THAN",
Target = "200",
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkly.IcmpMonitor;
import com.pulumi.checkly.IcmpMonitorArgs;
import com.pulumi.checkly.inputs.IcmpMonitorRequestArgs;
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_icmp_monitor = new IcmpMonitor("example-icmp-monitor", IcmpMonitorArgs.builder()
.name("Example ICMP monitor")
.activated(true)
.frequency(10)
.useGlobalAlertSettings(true)
.locations("eu-west-1")
.request(IcmpMonitorRequestArgs.builder()
.hostname("example.com")
.ipFamily("IPv4")
.pingCount(10)
.assertions(IcmpMonitorRequestAssertionArgs.builder()
.source("LATENCY")
.property("avg")
.comparison("LESS_THAN")
.target("200")
.build())
.build())
.build());
}
}
resources:
example-icmp-monitor:
type: checkly:IcmpMonitor
properties:
name: Example ICMP monitor
activated: true
frequency: 10
useGlobalAlertSettings: true
locations:
- eu-west-1
request:
hostname: example.com
ipFamily: IPv4
pingCount: 10
assertions:
- source: LATENCY
property: avg
comparison: LESS_THAN
target: '200'
Create IcmpMonitor Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IcmpMonitor(name: string, args: IcmpMonitorArgs, opts?: CustomResourceOptions);@overload
def IcmpMonitor(resource_name: str,
args: IcmpMonitorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IcmpMonitor(resource_name: str,
opts: Optional[ResourceOptions] = None,
request: Optional[IcmpMonitorRequestArgs] = None,
frequency: Optional[int] = None,
activated: Optional[bool] = None,
muted: Optional[bool] = None,
max_packet_loss_threshold: Optional[int] = None,
frequency_offset: Optional[int] = None,
group_id: Optional[int] = None,
group_order: Optional[int] = None,
alert_channel_subscriptions: Optional[Sequence[IcmpMonitorAlertChannelSubscriptionArgs]] = None,
locations: Optional[Sequence[str]] = None,
degraded_packet_loss_threshold: Optional[int] = None,
name: Optional[str] = None,
alert_settings: Optional[IcmpMonitorAlertSettingsArgs] = None,
retry_strategy: Optional[IcmpMonitorRetryStrategyArgs] = None,
run_parallel: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
trigger_incident: Optional[IcmpMonitorTriggerIncidentArgs] = None,
use_global_alert_settings: Optional[bool] = None)func NewIcmpMonitor(ctx *Context, name string, args IcmpMonitorArgs, opts ...ResourceOption) (*IcmpMonitor, error)public IcmpMonitor(string name, IcmpMonitorArgs args, CustomResourceOptions? opts = null)
public IcmpMonitor(String name, IcmpMonitorArgs args)
public IcmpMonitor(String name, IcmpMonitorArgs args, CustomResourceOptions options)
type: checkly:IcmpMonitor
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 IcmpMonitorArgs
- 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 IcmpMonitorArgs
- 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 IcmpMonitorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IcmpMonitorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IcmpMonitorArgs
- 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 icmpMonitorResource = new Checkly.IcmpMonitor("icmpMonitorResource", new()
{
Request = new Checkly.Inputs.IcmpMonitorRequestArgs
{
Hostname = "string",
Assertions = new[]
{
new Checkly.Inputs.IcmpMonitorRequestAssertionArgs
{
Comparison = "string",
Source = "string",
Target = "string",
Property = "string",
},
},
IpFamily = "string",
PingCount = 0,
},
Frequency = 0,
Activated = false,
Muted = false,
MaxPacketLossThreshold = 0,
FrequencyOffset = 0,
GroupId = 0,
GroupOrder = 0,
AlertChannelSubscriptions = new[]
{
new Checkly.Inputs.IcmpMonitorAlertChannelSubscriptionArgs
{
Activated = false,
ChannelId = 0,
},
},
Locations = new[]
{
"string",
},
DegradedPacketLossThreshold = 0,
Name = "string",
AlertSettings = new Checkly.Inputs.IcmpMonitorAlertSettingsArgs
{
EscalationType = "string",
ParallelRunFailureThresholds = new[]
{
new Checkly.Inputs.IcmpMonitorAlertSettingsParallelRunFailureThresholdArgs
{
Enabled = false,
Percentage = 0,
},
},
Reminders = new[]
{
new Checkly.Inputs.IcmpMonitorAlertSettingsReminderArgs
{
Amount = 0,
Interval = 0,
},
},
RunBasedEscalations = new[]
{
new Checkly.Inputs.IcmpMonitorAlertSettingsRunBasedEscalationArgs
{
FailedRunThreshold = 0,
},
},
TimeBasedEscalations = new[]
{
new Checkly.Inputs.IcmpMonitorAlertSettingsTimeBasedEscalationArgs
{
MinutesFailingThreshold = 0,
},
},
},
RetryStrategy = new Checkly.Inputs.IcmpMonitorRetryStrategyArgs
{
Type = "string",
BaseBackoffSeconds = 0,
MaxDurationSeconds = 0,
MaxRetries = 0,
OnlyOn = null,
SameRegion = false,
},
RunParallel = false,
Tags = new[]
{
"string",
},
TriggerIncident = new Checkly.Inputs.IcmpMonitorTriggerIncidentArgs
{
Description = "string",
Name = "string",
NotifySubscribers = false,
ServiceId = "string",
Severity = "string",
},
UseGlobalAlertSettings = false,
});
example, err := checkly.NewIcmpMonitor(ctx, "icmpMonitorResource", &checkly.IcmpMonitorArgs{
Request: &checkly.IcmpMonitorRequestArgs{
Hostname: pulumi.String("string"),
Assertions: checkly.IcmpMonitorRequestAssertionArray{
&checkly.IcmpMonitorRequestAssertionArgs{
Comparison: pulumi.String("string"),
Source: pulumi.String("string"),
Target: pulumi.String("string"),
Property: pulumi.String("string"),
},
},
IpFamily: pulumi.String("string"),
PingCount: pulumi.Int(0),
},
Frequency: pulumi.Int(0),
Activated: pulumi.Bool(false),
Muted: pulumi.Bool(false),
MaxPacketLossThreshold: pulumi.Int(0),
FrequencyOffset: pulumi.Int(0),
GroupId: pulumi.Int(0),
GroupOrder: pulumi.Int(0),
AlertChannelSubscriptions: checkly.IcmpMonitorAlertChannelSubscriptionArray{
&checkly.IcmpMonitorAlertChannelSubscriptionArgs{
Activated: pulumi.Bool(false),
ChannelId: pulumi.Int(0),
},
},
Locations: pulumi.StringArray{
pulumi.String("string"),
},
DegradedPacketLossThreshold: pulumi.Int(0),
Name: pulumi.String("string"),
AlertSettings: &checkly.IcmpMonitorAlertSettingsArgs{
EscalationType: pulumi.String("string"),
ParallelRunFailureThresholds: checkly.IcmpMonitorAlertSettingsParallelRunFailureThresholdArray{
&checkly.IcmpMonitorAlertSettingsParallelRunFailureThresholdArgs{
Enabled: pulumi.Bool(false),
Percentage: pulumi.Int(0),
},
},
Reminders: checkly.IcmpMonitorAlertSettingsReminderArray{
&checkly.IcmpMonitorAlertSettingsReminderArgs{
Amount: pulumi.Int(0),
Interval: pulumi.Int(0),
},
},
RunBasedEscalations: checkly.IcmpMonitorAlertSettingsRunBasedEscalationArray{
&checkly.IcmpMonitorAlertSettingsRunBasedEscalationArgs{
FailedRunThreshold: pulumi.Int(0),
},
},
TimeBasedEscalations: checkly.IcmpMonitorAlertSettingsTimeBasedEscalationArray{
&checkly.IcmpMonitorAlertSettingsTimeBasedEscalationArgs{
MinutesFailingThreshold: pulumi.Int(0),
},
},
},
RetryStrategy: &checkly.IcmpMonitorRetryStrategyArgs{
Type: pulumi.String("string"),
BaseBackoffSeconds: pulumi.Int(0),
MaxDurationSeconds: pulumi.Int(0),
MaxRetries: pulumi.Int(0),
OnlyOn: &checkly.IcmpMonitorRetryStrategyOnlyOnArgs{},
SameRegion: pulumi.Bool(false),
},
RunParallel: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TriggerIncident: &checkly.IcmpMonitorTriggerIncidentArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
NotifySubscribers: pulumi.Bool(false),
ServiceId: pulumi.String("string"),
Severity: pulumi.String("string"),
},
UseGlobalAlertSettings: pulumi.Bool(false),
})
var icmpMonitorResource = new IcmpMonitor("icmpMonitorResource", IcmpMonitorArgs.builder()
.request(IcmpMonitorRequestArgs.builder()
.hostname("string")
.assertions(IcmpMonitorRequestAssertionArgs.builder()
.comparison("string")
.source("string")
.target("string")
.property("string")
.build())
.ipFamily("string")
.pingCount(0)
.build())
.frequency(0)
.activated(false)
.muted(false)
.maxPacketLossThreshold(0)
.frequencyOffset(0)
.groupId(0)
.groupOrder(0)
.alertChannelSubscriptions(IcmpMonitorAlertChannelSubscriptionArgs.builder()
.activated(false)
.channelId(0)
.build())
.locations("string")
.degradedPacketLossThreshold(0)
.name("string")
.alertSettings(IcmpMonitorAlertSettingsArgs.builder()
.escalationType("string")
.parallelRunFailureThresholds(IcmpMonitorAlertSettingsParallelRunFailureThresholdArgs.builder()
.enabled(false)
.percentage(0)
.build())
.reminders(IcmpMonitorAlertSettingsReminderArgs.builder()
.amount(0)
.interval(0)
.build())
.runBasedEscalations(IcmpMonitorAlertSettingsRunBasedEscalationArgs.builder()
.failedRunThreshold(0)
.build())
.timeBasedEscalations(IcmpMonitorAlertSettingsTimeBasedEscalationArgs.builder()
.minutesFailingThreshold(0)
.build())
.build())
.retryStrategy(IcmpMonitorRetryStrategyArgs.builder()
.type("string")
.baseBackoffSeconds(0)
.maxDurationSeconds(0)
.maxRetries(0)
.onlyOn(IcmpMonitorRetryStrategyOnlyOnArgs.builder()
.build())
.sameRegion(false)
.build())
.runParallel(false)
.tags("string")
.triggerIncident(IcmpMonitorTriggerIncidentArgs.builder()
.description("string")
.name("string")
.notifySubscribers(false)
.serviceId("string")
.severity("string")
.build())
.useGlobalAlertSettings(false)
.build());
icmp_monitor_resource = checkly.IcmpMonitor("icmpMonitorResource",
request={
"hostname": "string",
"assertions": [{
"comparison": "string",
"source": "string",
"target": "string",
"property": "string",
}],
"ip_family": "string",
"ping_count": 0,
},
frequency=0,
activated=False,
muted=False,
max_packet_loss_threshold=0,
frequency_offset=0,
group_id=0,
group_order=0,
alert_channel_subscriptions=[{
"activated": False,
"channel_id": 0,
}],
locations=["string"],
degraded_packet_loss_threshold=0,
name="string",
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,
}],
},
retry_strategy={
"type": "string",
"base_backoff_seconds": 0,
"max_duration_seconds": 0,
"max_retries": 0,
"only_on": {},
"same_region": False,
},
run_parallel=False,
tags=["string"],
trigger_incident={
"description": "string",
"name": "string",
"notify_subscribers": False,
"service_id": "string",
"severity": "string",
},
use_global_alert_settings=False)
const icmpMonitorResource = new checkly.IcmpMonitor("icmpMonitorResource", {
request: {
hostname: "string",
assertions: [{
comparison: "string",
source: "string",
target: "string",
property: "string",
}],
ipFamily: "string",
pingCount: 0,
},
frequency: 0,
activated: false,
muted: false,
maxPacketLossThreshold: 0,
frequencyOffset: 0,
groupId: 0,
groupOrder: 0,
alertChannelSubscriptions: [{
activated: false,
channelId: 0,
}],
locations: ["string"],
degradedPacketLossThreshold: 0,
name: "string",
alertSettings: {
escalationType: "string",
parallelRunFailureThresholds: [{
enabled: false,
percentage: 0,
}],
reminders: [{
amount: 0,
interval: 0,
}],
runBasedEscalations: [{
failedRunThreshold: 0,
}],
timeBasedEscalations: [{
minutesFailingThreshold: 0,
}],
},
retryStrategy: {
type: "string",
baseBackoffSeconds: 0,
maxDurationSeconds: 0,
maxRetries: 0,
onlyOn: {},
sameRegion: false,
},
runParallel: false,
tags: ["string"],
triggerIncident: {
description: "string",
name: "string",
notifySubscribers: false,
serviceId: "string",
severity: "string",
},
useGlobalAlertSettings: false,
});
type: checkly:IcmpMonitor
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
degradedPacketLossThreshold: 0
frequency: 0
frequencyOffset: 0
groupId: 0
groupOrder: 0
locations:
- string
maxPacketLossThreshold: 0
muted: false
name: string
request:
assertions:
- comparison: string
property: string
source: string
target: string
hostname: string
ipFamily: string
pingCount: 0
retryStrategy:
baseBackoffSeconds: 0
maxDurationSeconds: 0
maxRetries: 0
onlyOn: {}
sameRegion: false
type: string
runParallel: false
tags:
- string
triggerIncident:
description: string
name: string
notifySubscribers: false
serviceId: string
severity: string
useGlobalAlertSettings: false
IcmpMonitor 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 IcmpMonitor resource accepts the following input properties:
- Activated bool
- Determines whether the monitor will run periodically or not after being deployed.
- Frequency int
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - Request
Icmp
Monitor Request - The parameters of the ICMP request.
- Alert
Channel List<IcmpSubscriptions 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 IcmpMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- Degraded
Packet intLoss Threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - Frequency
Offset int - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- Max
Packet intLoss Threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- Retry
Strategy IcmpMonitor Retry Strategy - A strategy for retrying failed check/monitor runs.
- Run
Parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - List<string>
- A list of tags for organizing and filtering checks and monitors.
- Trigger
Incident IcmpMonitor Trigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - Request
Icmp
Monitor Request Args - The parameters of the ICMP request.
- Alert
Channel []IcmpSubscriptions 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 IcmpMonitor Alert Settings Args - Determines the alert escalation policy for the monitor.
- Degraded
Packet intLoss Threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - Frequency
Offset int - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- Max
Packet intLoss Threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- Retry
Strategy IcmpMonitor Retry Strategy Args - A strategy for retrying failed check/monitor runs.
- Run
Parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - []string
- A list of tags for organizing and filtering checks and monitors.
- Trigger
Incident IcmpMonitor Trigger Incident Args - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - request
Icmp
Monitor Request - The parameters of the ICMP request.
- alert
Channel List<IcmpSubscriptions 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 IcmpMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- degraded
Packet IntegerLoss Threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - frequency
Offset Integer - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- max
Packet IntegerLoss Threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- retry
Strategy IcmpMonitor Retry Strategy - A strategy for retrying failed check/monitor runs.
- run
Parallel Boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - List<String>
- A list of tags for organizing and filtering checks and monitors.
- trigger
Incident IcmpMonitor Trigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - request
Icmp
Monitor Request - The parameters of the ICMP request.
- alert
Channel IcmpSubscriptions 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 IcmpMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- degraded
Packet numberLoss Threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - frequency
Offset number - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- max
Packet numberLoss Threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- retry
Strategy IcmpMonitor Retry Strategy - A strategy for retrying failed check/monitor runs.
- run
Parallel boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - string[]
- A list of tags for organizing and filtering checks and monitors.
- trigger
Incident IcmpMonitor Trigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - request
Icmp
Monitor Request Args - The parameters of the ICMP request.
- alert_
channel_ Sequence[Icmpsubscriptions 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 IcmpMonitor Alert Settings Args - Determines the alert escalation policy for the monitor.
- degraded_
packet_ intloss_ threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - frequency_
offset int - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- max_
packet_ intloss_ threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- retry_
strategy IcmpMonitor Retry Strategy Args - A strategy for retrying failed check/monitor runs.
- run_
parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - Sequence[str]
- A list of tags for organizing and filtering checks and monitors.
- trigger_
incident IcmpMonitor Trigger Incident Args - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - request Property Map
- The parameters of the ICMP 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
Packet NumberLoss Threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - frequency
Offset Number - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- max
Packet NumberLoss Threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- retry
Strategy Property Map - A strategy for retrying failed check/monitor runs.
- run
Parallel Boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - List<String>
- A list of tags for organizing and filtering checks and monitors.
- trigger
Incident Property Map - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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 IcmpMonitor 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 IcmpMonitor Resource
Get an existing IcmpMonitor 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?: IcmpMonitorState, opts?: CustomResourceOptions): IcmpMonitor@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
activated: Optional[bool] = None,
alert_channel_subscriptions: Optional[Sequence[IcmpMonitorAlertChannelSubscriptionArgs]] = None,
alert_settings: Optional[IcmpMonitorAlertSettingsArgs] = None,
degraded_packet_loss_threshold: 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_packet_loss_threshold: Optional[int] = None,
muted: Optional[bool] = None,
name: Optional[str] = None,
request: Optional[IcmpMonitorRequestArgs] = None,
retry_strategy: Optional[IcmpMonitorRetryStrategyArgs] = None,
run_parallel: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
trigger_incident: Optional[IcmpMonitorTriggerIncidentArgs] = None,
use_global_alert_settings: Optional[bool] = None) -> IcmpMonitorfunc GetIcmpMonitor(ctx *Context, name string, id IDInput, state *IcmpMonitorState, opts ...ResourceOption) (*IcmpMonitor, error)public static IcmpMonitor Get(string name, Input<string> id, IcmpMonitorState? state, CustomResourceOptions? opts = null)public static IcmpMonitor get(String name, Output<String> id, IcmpMonitorState state, CustomResourceOptions options)resources: _: type: checkly:IcmpMonitor 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<IcmpSubscriptions 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 IcmpMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- Degraded
Packet intLoss Threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - Frequency int
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - Frequency
Offset int - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- Max
Packet intLoss Threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- Request
Icmp
Monitor Request - The parameters of the ICMP request.
- Retry
Strategy IcmpMonitor Retry Strategy - A strategy for retrying failed check/monitor runs.
- Run
Parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - List<string>
- A list of tags for organizing and filtering checks and monitors.
- Trigger
Incident IcmpMonitor Trigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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 []IcmpSubscriptions 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 IcmpMonitor Alert Settings Args - Determines the alert escalation policy for the monitor.
- Degraded
Packet intLoss Threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - Frequency int
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - Frequency
Offset int - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- Max
Packet intLoss Threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- Request
Icmp
Monitor Request Args - The parameters of the ICMP request.
- Retry
Strategy IcmpMonitor Retry Strategy Args - A strategy for retrying failed check/monitor runs.
- Run
Parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - []string
- A list of tags for organizing and filtering checks and monitors.
- Trigger
Incident IcmpMonitor Trigger Incident Args - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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<IcmpSubscriptions 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 IcmpMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- degraded
Packet IntegerLoss Threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - frequency Integer
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - frequency
Offset Integer - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- max
Packet IntegerLoss Threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- request
Icmp
Monitor Request - The parameters of the ICMP request.
- retry
Strategy IcmpMonitor Retry Strategy - A strategy for retrying failed check/monitor runs.
- run
Parallel Boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - List<String>
- A list of tags for organizing and filtering checks and monitors.
- trigger
Incident IcmpMonitor Trigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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 IcmpSubscriptions 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 IcmpMonitor Alert Settings - Determines the alert escalation policy for the monitor.
- degraded
Packet numberLoss Threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - frequency number
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - frequency
Offset number - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- max
Packet numberLoss Threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- request
Icmp
Monitor Request - The parameters of the ICMP request.
- retry
Strategy IcmpMonitor Retry Strategy - A strategy for retrying failed check/monitor runs.
- run
Parallel boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - string[]
- A list of tags for organizing and filtering checks and monitors.
- trigger
Incident IcmpMonitor Trigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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[Icmpsubscriptions 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 IcmpMonitor Alert Settings Args - Determines the alert escalation policy for the monitor.
- degraded_
packet_ intloss_ threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - frequency int
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - frequency_
offset int - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- max_
packet_ intloss_ threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- request
Icmp
Monitor Request Args - The parameters of the ICMP request.
- retry_
strategy IcmpMonitor Retry Strategy Args - A strategy for retrying failed check/monitor runs.
- run_
parallel bool - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - Sequence[str]
- A list of tags for organizing and filtering checks and monitors.
- trigger_
incident IcmpMonitor Trigger Incident Args - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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
Packet NumberLoss Threshold - The packet loss percentage where the monitor should be considered degraded. Possible values are between
0and100. (Default10). - frequency Number
- Controls how often the monitor should run. Defined in minutes. The allowed values are
0(high frequency - usefrequency_offsetto define the actual frequency),1(1 minute),2(2 minutes),5(5 minutes),10(10 minutes),15(15 minutes),30(30 minutes),60(1 hour),120(2 hours),180(3 hours),360(6 hours),720(12 hours) and1440(24 hours). - frequency
Offset Number - When
frequencyis0(high frequency),frequency_offsetis required and it alone controls how often the monitor should run. Defined in seconds. The allowed values are0(disabled - usefrequencyto define the actual frequency),10(10 seconds),20(20 seconds) and30(30 seconds). - 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 this monitor.
- max
Packet NumberLoss Threshold - The packet loss percentage where the monitor should be considered failing. Possible values are between
0and100. (Default20). - 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.
- request Property Map
- The parameters of the ICMP request.
- retry
Strategy Property Map - A strategy for retrying failed check/monitor runs.
- run
Parallel Boolean - Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default
false). - List<String>
- A list of tags for organizing and filtering checks and monitors.
- trigger
Incident Property Map - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- 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
IcmpMonitorAlertChannelSubscription, IcmpMonitorAlertChannelSubscriptionArgs
- activated bool
- Whether an alert should be sent to this channel.
- channel_
id int - The ID of the alert channel.
IcmpMonitorAlertSettings, IcmpMonitorAlertSettingsArgs
- Escalation
Type string - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - Parallel
Run List<IcmpFailure Thresholds Monitor Alert Settings Parallel Run Failure Threshold> - Configuration for parallel run failure threshold.
- Reminders
List<Icmp
Monitor Alert Settings Reminder> - Defines how often to send reminder notifications after initial alert.
- Run
Based List<IcmpEscalations Monitor Alert Settings Run Based Escalation> - Configuration for run-based escalation.
- Time
Based List<IcmpEscalations Monitor Alert Settings Time Based Escalation> - Configuration for time-based escalation.
- Escalation
Type string - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - Parallel
Run []IcmpFailure Thresholds Monitor Alert Settings Parallel Run Failure Threshold - Configuration for parallel run failure threshold.
- Reminders
[]Icmp
Monitor Alert Settings Reminder - Defines how often to send reminder notifications after initial alert.
- Run
Based []IcmpEscalations Monitor Alert Settings Run Based Escalation - Configuration for run-based escalation.
- Time
Based []IcmpEscalations Monitor Alert Settings Time Based Escalation - Configuration for time-based escalation.
- escalation
Type String - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - parallel
Run List<IcmpFailure Thresholds Monitor Alert Settings Parallel Run Failure Threshold> - Configuration for parallel run failure threshold.
- reminders
List<Icmp
Monitor Alert Settings Reminder> - Defines how often to send reminder notifications after initial alert.
- run
Based List<IcmpEscalations Monitor Alert Settings Run Based Escalation> - Configuration for run-based escalation.
- time
Based List<IcmpEscalations Monitor Alert Settings Time Based Escalation> - Configuration for time-based escalation.
- escalation
Type string - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - parallel
Run IcmpFailure Thresholds Monitor Alert Settings Parallel Run Failure Threshold[] - Configuration for parallel run failure threshold.
- reminders
Icmp
Monitor Alert Settings Reminder[] - Defines how often to send reminder notifications after initial alert.
- run
Based IcmpEscalations Monitor Alert Settings Run Based Escalation[] - Configuration for run-based escalation.
- time
Based IcmpEscalations Monitor Alert Settings Time Based Escalation[] - Configuration for time-based escalation.
- escalation_
type str - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - parallel_
run_ Sequence[Icmpfailure_ thresholds Monitor Alert Settings Parallel Run Failure Threshold] - Configuration for parallel run failure threshold.
- reminders
Sequence[Icmp
Monitor Alert Settings Reminder] - Defines how often to send reminder notifications after initial alert.
- run_
based_ Sequence[Icmpescalations Monitor Alert Settings Run Based Escalation] - Configuration for run-based escalation.
- time_
based_ Sequence[Icmpescalations Monitor Alert Settings Time Based Escalation] - Configuration for time-based escalation.
- escalation
Type String - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_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.
IcmpMonitorAlertSettingsParallelRunFailureThreshold, IcmpMonitorAlertSettingsParallelRunFailureThresholdArgs
- Enabled bool
- Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (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. Only applies if the monitor is scheduled for multiple locations in parallel. (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. Only applies if the monitor is scheduled for multiple locations in parallel. (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. Only applies if the monitor is scheduled for multiple locations in parallel. (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. Only applies if the monitor is scheduled for multiple locations in parallel. (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. Only applies if the monitor is scheduled for multiple locations in parallel. (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).
IcmpMonitorAlertSettingsReminder, IcmpMonitorAlertSettingsReminderArgs
IcmpMonitorAlertSettingsRunBasedEscalation, IcmpMonitorAlertSettingsRunBasedEscalationArgs
- Failed
Run intThreshold - Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between
1and5. (Default1).
- Failed
Run intThreshold - Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between
1and5. (Default1).
- failed
Run IntegerThreshold - Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between
1and5. (Default1).
- failed
Run numberThreshold - Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between
1and5. (Default1).
- failed_
run_ intthreshold - Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between
1and5. (Default1).
- failed
Run NumberThreshold - Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between
1and5. (Default1).
IcmpMonitorAlertSettingsTimeBasedEscalation, IcmpMonitorAlertSettingsTimeBasedEscalationArgs
- Minutes
Failing intThreshold - Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
- Minutes
Failing intThreshold - Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
- minutes
Failing IntegerThreshold - Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
- minutes
Failing numberThreshold - Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
- minutes_
failing_ intthreshold - Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
- minutes
Failing NumberThreshold - Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
IcmpMonitorRequest, IcmpMonitorRequestArgs
- Hostname string
- The hostname to ping.
- Assertions
List<Icmp
Monitor Request Assertion> - Assertions to validate the ICMP response.
- Ip
Family string - The IP family to use. Possible values are
IPv4andIPv6. (DefaultIPv4). - Ping
Count int - The number of ping packets to send. (Default
10).
- Hostname string
- The hostname to ping.
- Assertions
[]Icmp
Monitor Request Assertion - Assertions to validate the ICMP response.
- Ip
Family string - The IP family to use. Possible values are
IPv4andIPv6. (DefaultIPv4). - Ping
Count int - The number of ping packets to send. (Default
10).
- hostname String
- The hostname to ping.
- assertions
List<Icmp
Monitor Request Assertion> - Assertions to validate the ICMP response.
- ip
Family String - The IP family to use. Possible values are
IPv4andIPv6. (DefaultIPv4). - ping
Count Integer - The number of ping packets to send. (Default
10).
- hostname string
- The hostname to ping.
- assertions
Icmp
Monitor Request Assertion[] - Assertions to validate the ICMP response.
- ip
Family string - The IP family to use. Possible values are
IPv4andIPv6. (DefaultIPv4). - ping
Count number - The number of ping packets to send. (Default
10).
- hostname str
- The hostname to ping.
- assertions
Sequence[Icmp
Monitor Request Assertion] - Assertions to validate the ICMP response.
- ip_
family str - The IP family to use. Possible values are
IPv4andIPv6. (DefaultIPv4). - ping_
count int - The number of ping packets to send. (Default
10).
- hostname String
- The hostname to ping.
- assertions List<Property Map>
- Assertions to validate the ICMP response.
- ip
Family String - The IP family to use. Possible values are
IPv4andIPv6. (DefaultIPv4). - ping
Count Number - The number of ping packets to send. (Default
10).
IcmpMonitorRequestAssertion, IcmpMonitorRequestAssertionArgs
- Comparison string
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS,NOT_EQUALS,GREATER_THANandLESS_THAN. - Source string
- The source of the asserted value. Possible values are
LATENCYandJSON_RESPONSE. - Target string
- The target value for the assertion.
- Property string
- The property of the source to assert. For
LATENCYsource, possible values areavg,min,maxandstdDev.
- Comparison string
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS,NOT_EQUALS,GREATER_THANandLESS_THAN. - Source string
- The source of the asserted value. Possible values are
LATENCYandJSON_RESPONSE. - Target string
- The target value for the assertion.
- Property string
- The property of the source to assert. For
LATENCYsource, possible values areavg,min,maxandstdDev.
- comparison String
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS,NOT_EQUALS,GREATER_THANandLESS_THAN. - source String
- The source of the asserted value. Possible values are
LATENCYandJSON_RESPONSE. - target String
- The target value for the assertion.
- property String
- The property of the source to assert. For
LATENCYsource, possible values areavg,min,maxandstdDev.
- comparison string
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS,NOT_EQUALS,GREATER_THANandLESS_THAN. - source string
- The source of the asserted value. Possible values are
LATENCYandJSON_RESPONSE. - target string
- The target value for the assertion.
- property string
- The property of the source to assert. For
LATENCYsource, possible values areavg,min,maxandstdDev.
- comparison str
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS,NOT_EQUALS,GREATER_THANandLESS_THAN. - source str
- The source of the asserted value. Possible values are
LATENCYandJSON_RESPONSE. - target str
- The target value for the assertion.
- property str
- The property of the source to assert. For
LATENCYsource, possible values areavg,min,maxandstdDev.
- comparison String
- The type of comparison to be executed between expected and actual value of the assertion. Possible values are
EQUALS,NOT_EQUALS,GREATER_THANandLESS_THAN. - source String
- The source of the asserted value. Possible values are
LATENCYandJSON_RESPONSE. - target String
- The target value for the assertion.
- property String
- The property of the source to assert. For
LATENCYsource, possible values areavg,min,maxandstdDev.
IcmpMonitorRetryStrategy, IcmpMonitorRetryStrategyArgs
- Type string
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - 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 check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - Max
Retries int - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - Only
On IcmpMonitor Retry Strategy Only On - Apply the retry strategy only if the defined conditions match.
- Same
Region bool - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
- Type string
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - 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 check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - Max
Retries int - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - Only
On IcmpMonitor Retry Strategy Only On - Apply the retry strategy only if the defined conditions match.
- Same
Region bool - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
- type String
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - 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 check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - max
Retries Integer - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - only
On IcmpMonitor Retry Strategy Only On - Apply the retry strategy only if the defined conditions match.
- same
Region Boolean - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
- type string
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - 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 check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - max
Retries number - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - only
On IcmpMonitor Retry Strategy Only On - Apply the retry strategy only if the defined conditions match.
- same
Region boolean - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
- type str
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - 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 check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - max_
retries int - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - only_
on IcmpMonitor Retry Strategy Only On - Apply the retry strategy only if the defined conditions match.
- same_
region bool - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
- type String
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - 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 check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - max
Retries Number - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - only
On Property Map - Apply the retry strategy only if the defined conditions match.
- same
Region Boolean - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
IcmpMonitorTriggerIncident, IcmpMonitorTriggerIncidentArgs
- Description string
- A detailed description of the incident.
- Name string
- The name of the incident.
- Notify
Subscribers bool - Whether to notify subscribers when the incident is triggered.
- Service
Id string - The status page service that this incident will be associated with.
- Severity string
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
- Description string
- A detailed description of the incident.
- Name string
- The name of the incident.
- Notify
Subscribers bool - Whether to notify subscribers when the incident is triggered.
- Service
Id string - The status page service that this incident will be associated with.
- Severity string
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
- description String
- A detailed description of the incident.
- name String
- The name of the incident.
- notify
Subscribers Boolean - Whether to notify subscribers when the incident is triggered.
- service
Id String - The status page service that this incident will be associated with.
- severity String
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
- description string
- A detailed description of the incident.
- name string
- The name of the incident.
- notify
Subscribers boolean - Whether to notify subscribers when the incident is triggered.
- service
Id string - The status page service that this incident will be associated with.
- severity string
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
- description str
- A detailed description of the incident.
- name str
- The name of the incident.
- notify_
subscribers bool - Whether to notify subscribers when the incident is triggered.
- service_
id str - The status page service that this incident will be associated with.
- severity str
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
- description String
- A detailed description of the incident.
- name String
- The name of the incident.
- notify
Subscribers Boolean - Whether to notify subscribers when the incident is triggered.
- service
Id String - The status page service that this incident will be associated with.
- severity String
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
Package Details
- Repository
- checkly checkly/pulumi-checkly
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
checklyTerraform Provider.
