published on Thursday, Mar 19, 2026 by Checkly
published on Thursday, Mar 19, 2026 by Checkly
Check groups organize related checks together and allow optional shared configuration.
Unlike checkly.CheckGroup (v1), which always imposed implicit defaults for various settings, checkly.CheckGroupV2 does not override any check settings by default. A group can be as minimal as just a name. Use the optional enforce_* blocks only when you explicitly want the group to override individual check settings.
The new checkly.CheckGroupV2 resource should always be preferred over the old checkly.CheckGroup resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as checkly from "@checkly/pulumi";
// Minimal example: just a folder to organize checks.
const just_a_folder = new checkly.CheckGroupV2("just-a-folder", {name: "Just a Folder"});
// Full example: a group with enforced settings that override individual checks.
const production_api = new checkly.CheckGroupV2("production-api", {
name: "Production API",
activated: true,
muted: false,
concurrency: 5,
tags: [
"production",
"api",
],
enforceLocations: {
enabled: true,
locations: [
"us-east-1",
"eu-west-1",
"ap-southeast-1",
],
privateLocations: ["my-datacenter"],
},
enforceRetryStrategy: {
enabled: true,
retryStrategy: {
type: "LINEAR",
baseBackoffSeconds: 30,
maxRetries: 3,
maxDurationSeconds: 300,
sameRegion: true,
},
},
enforceSchedulingStrategy: {
enabled: true,
runParallel: true,
},
enforceAlertSettings: {
enabled: true,
alertSettings: {
escalationType: "RUN_BASED",
runBasedEscalations: [{
failedRunThreshold: 2,
}],
reminders: [{
amount: 3,
interval: 10,
}],
parallelRunFailureThresholds: [{
enabled: true,
percentage: 50,
}],
},
alertChannelSubscriptions: [{
channelId: 1234,
activated: true,
}],
},
environmentVariables: [
{
key: "BASE_URL",
value: "https://api.example.com",
locked: false,
},
{
key: "API_TOKEN",
value: "super-secret-token",
locked: true,
secret: true,
},
],
defaultRuntime: {
runtimeId: "2024.02",
},
apiCheckDefaults: {
url: "https://api.example.com/",
headers: {
"X-Api-Key": "{{API_TOKEN}}",
"Content-Type": "application/json",
},
queryParameters: {
version: "v2",
},
assertions: [
{
source: "STATUS_CODE",
comparison: "LESS_THAN",
target: "400",
},
{
source: "RESPONSE_TIME",
comparison: "LESS_THAN",
target: "3000",
},
],
basicAuth: {
username: "admin",
password: "pass",
},
},
setupScript: {
inlineScript: `// Runs before every API check in this group
console.log("Setting up...")
`,
},
teardownScript: {
inlineScript: `// Runs after every API check in this group
console.log("Tearing down...")
`,
},
});
// Example: enforce only retry strategy with network-error-only retries.
const retry_on_network_errors = new checkly.CheckGroupV2("retry-on-network-errors", {
name: "Retry on Network Errors Only",
enforceRetryStrategy: {
enabled: true,
retryStrategy: {
type: "EXPONENTIAL",
baseBackoffSeconds: 10,
maxRetries: 5,
maxDurationSeconds: 600,
sameRegion: false,
onlyOn: {
networkError: true,
},
},
},
});
// Example: enforce time-based alert escalation.
const time_based_alerts = new checkly.CheckGroupV2("time-based-alerts", {
name: "Time-Based Alert Escalation",
enforceAlertSettings: {
enabled: true,
alertSettings: {
escalationType: "TIME_BASED",
timeBasedEscalations: [{
minutesFailingThreshold: 10,
}],
reminders: [{
amount: 5,
interval: 15,
}],
},
},
});
// Example: use global alert settings instead of custom ones.
const use_global_alerts = new checkly.CheckGroupV2("use-global-alerts", {
name: "Use Global Alert Settings",
enforceAlertSettings: {
enabled: true,
useGlobalAlertSettings: true,
},
});
// Example: enforce alert channel subscriptions with custom alert settings.
const email = new checkly.AlertChannel("email", {email: {
address: "alerts@example.com",
}});
const slack = new checkly.AlertChannel("slack", {slack: {
channel: "#alerts",
url: "https://hooks.slack.com/services/TXXXXX/XXXXX/XXXXXXXXXX",
}});
const with_alert_channels = new checkly.CheckGroupV2("with-alert-channels", {
name: "Group with Alert Channels",
enforceAlertSettings: {
enabled: true,
alertSettings: {
escalationType: "RUN_BASED",
runBasedEscalations: [{
failedRunThreshold: 1,
}],
reminders: [{
amount: 0,
interval: 5,
}],
},
alertChannelSubscriptions: [
{
channelId: email.id,
activated: true,
},
{
channelId: slack.id,
activated: true,
},
],
},
});
// Example: enforce no retries.
const no_retries = new checkly.CheckGroupV2("no-retries", {
name: "No Retries Group",
enforceRetryStrategy: {
enabled: true,
retryStrategy: {
type: "NO_RETRIES",
},
},
});
// Example: enforce a single retry.
const single_retry = new checkly.CheckGroupV2("single-retry", {
name: "Single Retry Group",
enforceRetryStrategy: {
enabled: true,
retryStrategy: {
type: "SINGLE_RETRY",
baseBackoffSeconds: 10,
sameRegion: true,
},
},
});
import pulumi
import pulumi_checkly as checkly
# Minimal example: just a folder to organize checks.
just_a_folder = checkly.CheckGroupV2("just-a-folder", name="Just a Folder")
# Full example: a group with enforced settings that override individual checks.
production_api = checkly.CheckGroupV2("production-api",
name="Production API",
activated=True,
muted=False,
concurrency=5,
tags=[
"production",
"api",
],
enforce_locations={
"enabled": True,
"locations": [
"us-east-1",
"eu-west-1",
"ap-southeast-1",
],
"private_locations": ["my-datacenter"],
},
enforce_retry_strategy={
"enabled": True,
"retry_strategy": {
"type": "LINEAR",
"base_backoff_seconds": 30,
"max_retries": 3,
"max_duration_seconds": 300,
"same_region": True,
},
},
enforce_scheduling_strategy={
"enabled": True,
"run_parallel": True,
},
enforce_alert_settings={
"enabled": True,
"alert_settings": {
"escalation_type": "RUN_BASED",
"run_based_escalations": [{
"failed_run_threshold": 2,
}],
"reminders": [{
"amount": 3,
"interval": 10,
}],
"parallel_run_failure_thresholds": [{
"enabled": True,
"percentage": 50,
}],
},
"alert_channel_subscriptions": [{
"channel_id": 1234,
"activated": True,
}],
},
environment_variables=[
{
"key": "BASE_URL",
"value": "https://api.example.com",
"locked": False,
},
{
"key": "API_TOKEN",
"value": "super-secret-token",
"locked": True,
"secret": True,
},
],
default_runtime={
"runtime_id": "2024.02",
},
api_check_defaults={
"url": "https://api.example.com/",
"headers": {
"X-Api-Key": "{{API_TOKEN}}",
"Content-Type": "application/json",
},
"query_parameters": {
"version": "v2",
},
"assertions": [
{
"source": "STATUS_CODE",
"comparison": "LESS_THAN",
"target": "400",
},
{
"source": "RESPONSE_TIME",
"comparison": "LESS_THAN",
"target": "3000",
},
],
"basic_auth": {
"username": "admin",
"password": "pass",
},
},
setup_script={
"inline_script": """// Runs before every API check in this group
console.log("Setting up...")
""",
},
teardown_script={
"inline_script": """// Runs after every API check in this group
console.log("Tearing down...")
""",
})
# Example: enforce only retry strategy with network-error-only retries.
retry_on_network_errors = checkly.CheckGroupV2("retry-on-network-errors",
name="Retry on Network Errors Only",
enforce_retry_strategy={
"enabled": True,
"retry_strategy": {
"type": "EXPONENTIAL",
"base_backoff_seconds": 10,
"max_retries": 5,
"max_duration_seconds": 600,
"same_region": False,
"only_on": {
"network_error": True,
},
},
})
# Example: enforce time-based alert escalation.
time_based_alerts = checkly.CheckGroupV2("time-based-alerts",
name="Time-Based Alert Escalation",
enforce_alert_settings={
"enabled": True,
"alert_settings": {
"escalation_type": "TIME_BASED",
"time_based_escalations": [{
"minutes_failing_threshold": 10,
}],
"reminders": [{
"amount": 5,
"interval": 15,
}],
},
})
# Example: use global alert settings instead of custom ones.
use_global_alerts = checkly.CheckGroupV2("use-global-alerts",
name="Use Global Alert Settings",
enforce_alert_settings={
"enabled": True,
"use_global_alert_settings": True,
})
# Example: enforce alert channel subscriptions with custom alert settings.
email = checkly.AlertChannel("email", email={
"address": "alerts@example.com",
})
slack = checkly.AlertChannel("slack", slack={
"channel": "#alerts",
"url": "https://hooks.slack.com/services/TXXXXX/XXXXX/XXXXXXXXXX",
})
with_alert_channels = checkly.CheckGroupV2("with-alert-channels",
name="Group with Alert Channels",
enforce_alert_settings={
"enabled": True,
"alert_settings": {
"escalation_type": "RUN_BASED",
"run_based_escalations": [{
"failed_run_threshold": 1,
}],
"reminders": [{
"amount": 0,
"interval": 5,
}],
},
"alert_channel_subscriptions": [
{
"channel_id": email.id,
"activated": True,
},
{
"channel_id": slack.id,
"activated": True,
},
],
})
# Example: enforce no retries.
no_retries = checkly.CheckGroupV2("no-retries",
name="No Retries Group",
enforce_retry_strategy={
"enabled": True,
"retry_strategy": {
"type": "NO_RETRIES",
},
})
# Example: enforce a single retry.
single_retry = checkly.CheckGroupV2("single-retry",
name="Single Retry Group",
enforce_retry_strategy={
"enabled": True,
"retry_strategy": {
"type": "SINGLE_RETRY",
"base_backoff_seconds": 10,
"same_region": True,
},
})
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 {
// Minimal example: just a folder to organize checks.
_, err := checkly.NewCheckGroupV2(ctx, "just-a-folder", &checkly.CheckGroupV2Args{
Name: pulumi.String("Just a Folder"),
})
if err != nil {
return err
}
// Full example: a group with enforced settings that override individual checks.
_, err = checkly.NewCheckGroupV2(ctx, "production-api", &checkly.CheckGroupV2Args{
Name: pulumi.String("Production API"),
Activated: pulumi.Bool(true),
Muted: pulumi.Bool(false),
Concurrency: pulumi.Int(5),
Tags: pulumi.StringArray{
pulumi.String("production"),
pulumi.String("api"),
},
EnforceLocations: &checkly.CheckGroupV2EnforceLocationsArgs{
Enabled: pulumi.Bool(true),
Locations: pulumi.StringArray{
pulumi.String("us-east-1"),
pulumi.String("eu-west-1"),
pulumi.String("ap-southeast-1"),
},
PrivateLocations: pulumi.StringArray{
pulumi.String("my-datacenter"),
},
},
EnforceRetryStrategy: &checkly.CheckGroupV2EnforceRetryStrategyArgs{
Enabled: pulumi.Bool(true),
RetryStrategy: &checkly.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs{
Type: pulumi.String("LINEAR"),
BaseBackoffSeconds: pulumi.Int(30),
MaxRetries: pulumi.Int(3),
MaxDurationSeconds: pulumi.Int(300),
SameRegion: pulumi.Bool(true),
},
},
EnforceSchedulingStrategy: &checkly.CheckGroupV2EnforceSchedulingStrategyArgs{
Enabled: pulumi.Bool(true),
RunParallel: pulumi.Bool(true),
},
EnforceAlertSettings: &checkly.CheckGroupV2EnforceAlertSettingsArgs{
Enabled: pulumi.Bool(true),
AlertSettings: &checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsArgs{
EscalationType: pulumi.String("RUN_BASED"),
RunBasedEscalations: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArgs{
FailedRunThreshold: pulumi.Int(2),
},
},
Reminders: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs{
Amount: pulumi.Int(3),
Interval: pulumi.Int(10),
},
},
ParallelRunFailureThresholds: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsParallelRunFailureThresholdArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsParallelRunFailureThresholdArgs{
Enabled: pulumi.Bool(true),
Percentage: pulumi.Int(50),
},
},
},
AlertChannelSubscriptions: checkly.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs{
ChannelId: pulumi.Int(1234),
Activated: pulumi.Bool(true),
},
},
},
EnvironmentVariables: checkly.CheckGroupV2EnvironmentVariableArray{
&checkly.CheckGroupV2EnvironmentVariableArgs{
Key: pulumi.String("BASE_URL"),
Value: pulumi.String("https://api.example.com"),
Locked: pulumi.Bool(false),
},
&checkly.CheckGroupV2EnvironmentVariableArgs{
Key: pulumi.String("API_TOKEN"),
Value: pulumi.String("super-secret-token"),
Locked: pulumi.Bool(true),
Secret: pulumi.Bool(true),
},
},
DefaultRuntime: &checkly.CheckGroupV2DefaultRuntimeArgs{
RuntimeId: pulumi.String("2024.02"),
},
ApiCheckDefaults: &checkly.CheckGroupV2ApiCheckDefaultsArgs{
Url: pulumi.String("https://api.example.com/"),
Headers: pulumi.StringMap{
"X-Api-Key": pulumi.String("{{API_TOKEN}}"),
"Content-Type": pulumi.String("application/json"),
},
QueryParameters: pulumi.StringMap{
"version": pulumi.String("v2"),
},
Assertions: checkly.CheckGroupV2ApiCheckDefaultsAssertionArray{
&checkly.CheckGroupV2ApiCheckDefaultsAssertionArgs{
Source: pulumi.String("STATUS_CODE"),
Comparison: pulumi.String("LESS_THAN"),
Target: pulumi.String("400"),
},
&checkly.CheckGroupV2ApiCheckDefaultsAssertionArgs{
Source: pulumi.String("RESPONSE_TIME"),
Comparison: pulumi.String("LESS_THAN"),
Target: pulumi.String("3000"),
},
},
BasicAuth: &checkly.CheckGroupV2ApiCheckDefaultsBasicAuthArgs{
Username: pulumi.String("admin"),
Password: pulumi.String("pass"),
},
},
SetupScript: &checkly.CheckGroupV2SetupScriptArgs{
InlineScript: pulumi.String("// Runs before every API check in this group\nconsole.log(\"Setting up...\")\n"),
},
TeardownScript: &checkly.CheckGroupV2TeardownScriptArgs{
InlineScript: pulumi.String("// Runs after every API check in this group\nconsole.log(\"Tearing down...\")\n"),
},
})
if err != nil {
return err
}
// Example: enforce only retry strategy with network-error-only retries.
_, err = checkly.NewCheckGroupV2(ctx, "retry-on-network-errors", &checkly.CheckGroupV2Args{
Name: pulumi.String("Retry on Network Errors Only"),
EnforceRetryStrategy: &checkly.CheckGroupV2EnforceRetryStrategyArgs{
Enabled: pulumi.Bool(true),
RetryStrategy: &checkly.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs{
Type: pulumi.String("EXPONENTIAL"),
BaseBackoffSeconds: pulumi.Int(10),
MaxRetries: pulumi.Int(5),
MaxDurationSeconds: pulumi.Int(600),
SameRegion: pulumi.Bool(false),
OnlyOn: &checkly.CheckGroupV2EnforceRetryStrategyRetryStrategyOnlyOnArgs{
NetworkError: pulumi.Bool(true),
},
},
},
})
if err != nil {
return err
}
// Example: enforce time-based alert escalation.
_, err = checkly.NewCheckGroupV2(ctx, "time-based-alerts", &checkly.CheckGroupV2Args{
Name: pulumi.String("Time-Based Alert Escalation"),
EnforceAlertSettings: &checkly.CheckGroupV2EnforceAlertSettingsArgs{
Enabled: pulumi.Bool(true),
AlertSettings: &checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsArgs{
EscalationType: pulumi.String("TIME_BASED"),
TimeBasedEscalations: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsTimeBasedEscalationArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsTimeBasedEscalationArgs{
MinutesFailingThreshold: pulumi.Int(10),
},
},
Reminders: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs{
Amount: pulumi.Int(5),
Interval: pulumi.Int(15),
},
},
},
},
})
if err != nil {
return err
}
// Example: use global alert settings instead of custom ones.
_, err = checkly.NewCheckGroupV2(ctx, "use-global-alerts", &checkly.CheckGroupV2Args{
Name: pulumi.String("Use Global Alert Settings"),
EnforceAlertSettings: &checkly.CheckGroupV2EnforceAlertSettingsArgs{
Enabled: pulumi.Bool(true),
UseGlobalAlertSettings: pulumi.Bool(true),
},
})
if err != nil {
return err
}
// Example: enforce alert channel subscriptions with custom alert settings.
email, err := checkly.NewAlertChannel(ctx, "email", &checkly.AlertChannelArgs{
Email: &checkly.AlertChannelEmailArgs{
Address: pulumi.String("alerts@example.com"),
},
})
if err != nil {
return err
}
slack, err := checkly.NewAlertChannel(ctx, "slack", &checkly.AlertChannelArgs{
Slack: &checkly.AlertChannelSlackArgs{
Channel: pulumi.String("#alerts"),
Url: pulumi.String("https://hooks.slack.com/services/TXXXXX/XXXXX/XXXXXXXXXX"),
},
})
if err != nil {
return err
}
_, err = checkly.NewCheckGroupV2(ctx, "with-alert-channels", &checkly.CheckGroupV2Args{
Name: pulumi.String("Group with Alert Channels"),
EnforceAlertSettings: &checkly.CheckGroupV2EnforceAlertSettingsArgs{
Enabled: pulumi.Bool(true),
AlertSettings: &checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsArgs{
EscalationType: pulumi.String("RUN_BASED"),
RunBasedEscalations: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArgs{
FailedRunThreshold: pulumi.Int(1),
},
},
Reminders: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs{
Amount: pulumi.Int(0),
Interval: pulumi.Int(5),
},
},
},
AlertChannelSubscriptions: checkly.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs{
ChannelId: email.ID(),
Activated: pulumi.Bool(true),
},
&checkly.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs{
ChannelId: slack.ID(),
Activated: pulumi.Bool(true),
},
},
},
})
if err != nil {
return err
}
// Example: enforce no retries.
_, err = checkly.NewCheckGroupV2(ctx, "no-retries", &checkly.CheckGroupV2Args{
Name: pulumi.String("No Retries Group"),
EnforceRetryStrategy: &checkly.CheckGroupV2EnforceRetryStrategyArgs{
Enabled: pulumi.Bool(true),
RetryStrategy: &checkly.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs{
Type: pulumi.String("NO_RETRIES"),
},
},
})
if err != nil {
return err
}
// Example: enforce a single retry.
_, err = checkly.NewCheckGroupV2(ctx, "single-retry", &checkly.CheckGroupV2Args{
Name: pulumi.String("Single Retry Group"),
EnforceRetryStrategy: &checkly.CheckGroupV2EnforceRetryStrategyArgs{
Enabled: pulumi.Bool(true),
RetryStrategy: &checkly.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs{
Type: pulumi.String("SINGLE_RETRY"),
BaseBackoffSeconds: pulumi.Int(10),
SameRegion: pulumi.Bool(true),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkly = Pulumi.Checkly;
return await Deployment.RunAsync(() =>
{
// Minimal example: just a folder to organize checks.
var just_a_folder = new Checkly.CheckGroupV2("just-a-folder", new()
{
Name = "Just a Folder",
});
// Full example: a group with enforced settings that override individual checks.
var production_api = new Checkly.CheckGroupV2("production-api", new()
{
Name = "Production API",
Activated = true,
Muted = false,
Concurrency = 5,
Tags = new[]
{
"production",
"api",
},
EnforceLocations = new Checkly.Inputs.CheckGroupV2EnforceLocationsArgs
{
Enabled = true,
Locations = new[]
{
"us-east-1",
"eu-west-1",
"ap-southeast-1",
},
PrivateLocations = new[]
{
"my-datacenter",
},
},
EnforceRetryStrategy = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyArgs
{
Enabled = true,
RetryStrategy = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs
{
Type = "LINEAR",
BaseBackoffSeconds = 30,
MaxRetries = 3,
MaxDurationSeconds = 300,
SameRegion = true,
},
},
EnforceSchedulingStrategy = new Checkly.Inputs.CheckGroupV2EnforceSchedulingStrategyArgs
{
Enabled = true,
RunParallel = true,
},
EnforceAlertSettings = new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsArgs
{
Enabled = true,
AlertSettings = new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsArgs
{
EscalationType = "RUN_BASED",
RunBasedEscalations = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArgs
{
FailedRunThreshold = 2,
},
},
Reminders = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs
{
Amount = 3,
Interval = 10,
},
},
ParallelRunFailureThresholds = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsParallelRunFailureThresholdArgs
{
Enabled = true,
Percentage = 50,
},
},
},
AlertChannelSubscriptions = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs
{
ChannelId = 1234,
Activated = true,
},
},
},
EnvironmentVariables = new[]
{
new Checkly.Inputs.CheckGroupV2EnvironmentVariableArgs
{
Key = "BASE_URL",
Value = "https://api.example.com",
Locked = false,
},
new Checkly.Inputs.CheckGroupV2EnvironmentVariableArgs
{
Key = "API_TOKEN",
Value = "super-secret-token",
Locked = true,
Secret = true,
},
},
DefaultRuntime = new Checkly.Inputs.CheckGroupV2DefaultRuntimeArgs
{
RuntimeId = "2024.02",
},
ApiCheckDefaults = new Checkly.Inputs.CheckGroupV2ApiCheckDefaultsArgs
{
Url = "https://api.example.com/",
Headers =
{
{ "X-Api-Key", "{{API_TOKEN}}" },
{ "Content-Type", "application/json" },
},
QueryParameters =
{
{ "version", "v2" },
},
Assertions = new[]
{
new Checkly.Inputs.CheckGroupV2ApiCheckDefaultsAssertionArgs
{
Source = "STATUS_CODE",
Comparison = "LESS_THAN",
Target = "400",
},
new Checkly.Inputs.CheckGroupV2ApiCheckDefaultsAssertionArgs
{
Source = "RESPONSE_TIME",
Comparison = "LESS_THAN",
Target = "3000",
},
},
BasicAuth = new Checkly.Inputs.CheckGroupV2ApiCheckDefaultsBasicAuthArgs
{
Username = "admin",
Password = "pass",
},
},
SetupScript = new Checkly.Inputs.CheckGroupV2SetupScriptArgs
{
InlineScript = @"// Runs before every API check in this group
console.log(""Setting up..."")
",
},
TeardownScript = new Checkly.Inputs.CheckGroupV2TeardownScriptArgs
{
InlineScript = @"// Runs after every API check in this group
console.log(""Tearing down..."")
",
},
});
// Example: enforce only retry strategy with network-error-only retries.
var retry_on_network_errors = new Checkly.CheckGroupV2("retry-on-network-errors", new()
{
Name = "Retry on Network Errors Only",
EnforceRetryStrategy = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyArgs
{
Enabled = true,
RetryStrategy = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs
{
Type = "EXPONENTIAL",
BaseBackoffSeconds = 10,
MaxRetries = 5,
MaxDurationSeconds = 600,
SameRegion = false,
OnlyOn = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyRetryStrategyOnlyOnArgs
{
NetworkError = true,
},
},
},
});
// Example: enforce time-based alert escalation.
var time_based_alerts = new Checkly.CheckGroupV2("time-based-alerts", new()
{
Name = "Time-Based Alert Escalation",
EnforceAlertSettings = new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsArgs
{
Enabled = true,
AlertSettings = new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsArgs
{
EscalationType = "TIME_BASED",
TimeBasedEscalations = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsTimeBasedEscalationArgs
{
MinutesFailingThreshold = 10,
},
},
Reminders = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs
{
Amount = 5,
Interval = 15,
},
},
},
},
});
// Example: use global alert settings instead of custom ones.
var use_global_alerts = new Checkly.CheckGroupV2("use-global-alerts", new()
{
Name = "Use Global Alert Settings",
EnforceAlertSettings = new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsArgs
{
Enabled = true,
UseGlobalAlertSettings = true,
},
});
// Example: enforce alert channel subscriptions with custom alert settings.
var email = new Checkly.AlertChannel("email", new()
{
Email = new Checkly.Inputs.AlertChannelEmailArgs
{
Address = "alerts@example.com",
},
});
var slack = new Checkly.AlertChannel("slack", new()
{
Slack = new Checkly.Inputs.AlertChannelSlackArgs
{
Channel = "#alerts",
Url = "https://hooks.slack.com/services/TXXXXX/XXXXX/XXXXXXXXXX",
},
});
var with_alert_channels = new Checkly.CheckGroupV2("with-alert-channels", new()
{
Name = "Group with Alert Channels",
EnforceAlertSettings = new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsArgs
{
Enabled = true,
AlertSettings = new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsArgs
{
EscalationType = "RUN_BASED",
RunBasedEscalations = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArgs
{
FailedRunThreshold = 1,
},
},
Reminders = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs
{
Amount = 0,
Interval = 5,
},
},
},
AlertChannelSubscriptions = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs
{
ChannelId = email.Id,
Activated = true,
},
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs
{
ChannelId = slack.Id,
Activated = true,
},
},
},
});
// Example: enforce no retries.
var no_retries = new Checkly.CheckGroupV2("no-retries", new()
{
Name = "No Retries Group",
EnforceRetryStrategy = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyArgs
{
Enabled = true,
RetryStrategy = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs
{
Type = "NO_RETRIES",
},
},
});
// Example: enforce a single retry.
var single_retry = new Checkly.CheckGroupV2("single-retry", new()
{
Name = "Single Retry Group",
EnforceRetryStrategy = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyArgs
{
Enabled = true,
RetryStrategy = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs
{
Type = "SINGLE_RETRY",
BaseBackoffSeconds = 10,
SameRegion = true,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkly.CheckGroupV2;
import com.pulumi.checkly.CheckGroupV2Args;
import com.pulumi.checkly.inputs.CheckGroupV2EnforceLocationsArgs;
import com.pulumi.checkly.inputs.CheckGroupV2EnforceRetryStrategyArgs;
import com.pulumi.checkly.inputs.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs;
import com.pulumi.checkly.inputs.CheckGroupV2EnforceSchedulingStrategyArgs;
import com.pulumi.checkly.inputs.CheckGroupV2EnforceAlertSettingsArgs;
import com.pulumi.checkly.inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsArgs;
import com.pulumi.checkly.inputs.CheckGroupV2EnvironmentVariableArgs;
import com.pulumi.checkly.inputs.CheckGroupV2DefaultRuntimeArgs;
import com.pulumi.checkly.inputs.CheckGroupV2ApiCheckDefaultsArgs;
import com.pulumi.checkly.inputs.CheckGroupV2ApiCheckDefaultsBasicAuthArgs;
import com.pulumi.checkly.inputs.CheckGroupV2SetupScriptArgs;
import com.pulumi.checkly.inputs.CheckGroupV2TeardownScriptArgs;
import com.pulumi.checkly.inputs.CheckGroupV2EnforceRetryStrategyRetryStrategyOnlyOnArgs;
import com.pulumi.checkly.AlertChannel;
import com.pulumi.checkly.AlertChannelArgs;
import com.pulumi.checkly.inputs.AlertChannelEmailArgs;
import com.pulumi.checkly.inputs.AlertChannelSlackArgs;
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) {
// Minimal example: just a folder to organize checks.
var just_a_folder = new CheckGroupV2("just-a-folder", CheckGroupV2Args.builder()
.name("Just a Folder")
.build());
// Full example: a group with enforced settings that override individual checks.
var production_api = new CheckGroupV2("production-api", CheckGroupV2Args.builder()
.name("Production API")
.activated(true)
.muted(false)
.concurrency(5)
.tags(
"production",
"api")
.enforceLocations(CheckGroupV2EnforceLocationsArgs.builder()
.enabled(true)
.locations(
"us-east-1",
"eu-west-1",
"ap-southeast-1")
.privateLocations("my-datacenter")
.build())
.enforceRetryStrategy(CheckGroupV2EnforceRetryStrategyArgs.builder()
.enabled(true)
.retryStrategy(CheckGroupV2EnforceRetryStrategyRetryStrategyArgs.builder()
.type("LINEAR")
.baseBackoffSeconds(30)
.maxRetries(3)
.maxDurationSeconds(300)
.sameRegion(true)
.build())
.build())
.enforceSchedulingStrategy(CheckGroupV2EnforceSchedulingStrategyArgs.builder()
.enabled(true)
.runParallel(true)
.build())
.enforceAlertSettings(CheckGroupV2EnforceAlertSettingsArgs.builder()
.enabled(true)
.alertSettings(CheckGroupV2EnforceAlertSettingsAlertSettingsArgs.builder()
.escalationType("RUN_BASED")
.runBasedEscalations(CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArgs.builder()
.failedRunThreshold(2)
.build())
.reminders(CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs.builder()
.amount(3)
.interval(10)
.build())
.parallelRunFailureThresholds(CheckGroupV2EnforceAlertSettingsAlertSettingsParallelRunFailureThresholdArgs.builder()
.enabled(true)
.percentage(50)
.build())
.build())
.alertChannelSubscriptions(CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs.builder()
.channelId(1234)
.activated(true)
.build())
.build())
.environmentVariables(
CheckGroupV2EnvironmentVariableArgs.builder()
.key("BASE_URL")
.value("https://api.example.com")
.locked(false)
.build(),
CheckGroupV2EnvironmentVariableArgs.builder()
.key("API_TOKEN")
.value("super-secret-token")
.locked(true)
.secret(true)
.build())
.defaultRuntime(CheckGroupV2DefaultRuntimeArgs.builder()
.runtimeId("2024.02")
.build())
.apiCheckDefaults(CheckGroupV2ApiCheckDefaultsArgs.builder()
.url("https://api.example.com/")
.headers(Map.ofEntries(
Map.entry("X-Api-Key", "{{API_TOKEN}}"),
Map.entry("Content-Type", "application/json")
))
.queryParameters(Map.of("version", "v2"))
.assertions(
CheckGroupV2ApiCheckDefaultsAssertionArgs.builder()
.source("STATUS_CODE")
.comparison("LESS_THAN")
.target("400")
.build(),
CheckGroupV2ApiCheckDefaultsAssertionArgs.builder()
.source("RESPONSE_TIME")
.comparison("LESS_THAN")
.target("3000")
.build())
.basicAuth(CheckGroupV2ApiCheckDefaultsBasicAuthArgs.builder()
.username("admin")
.password("pass")
.build())
.build())
.setupScript(CheckGroupV2SetupScriptArgs.builder()
.inlineScript("""
// Runs before every API check in this group
console.log("Setting up...")
""")
.build())
.teardownScript(CheckGroupV2TeardownScriptArgs.builder()
.inlineScript("""
// Runs after every API check in this group
console.log("Tearing down...")
""")
.build())
.build());
// Example: enforce only retry strategy with network-error-only retries.
var retry_on_network_errors = new CheckGroupV2("retry-on-network-errors", CheckGroupV2Args.builder()
.name("Retry on Network Errors Only")
.enforceRetryStrategy(CheckGroupV2EnforceRetryStrategyArgs.builder()
.enabled(true)
.retryStrategy(CheckGroupV2EnforceRetryStrategyRetryStrategyArgs.builder()
.type("EXPONENTIAL")
.baseBackoffSeconds(10)
.maxRetries(5)
.maxDurationSeconds(600)
.sameRegion(false)
.onlyOn(CheckGroupV2EnforceRetryStrategyRetryStrategyOnlyOnArgs.builder()
.networkError(true)
.build())
.build())
.build())
.build());
// Example: enforce time-based alert escalation.
var time_based_alerts = new CheckGroupV2("time-based-alerts", CheckGroupV2Args.builder()
.name("Time-Based Alert Escalation")
.enforceAlertSettings(CheckGroupV2EnforceAlertSettingsArgs.builder()
.enabled(true)
.alertSettings(CheckGroupV2EnforceAlertSettingsAlertSettingsArgs.builder()
.escalationType("TIME_BASED")
.timeBasedEscalations(CheckGroupV2EnforceAlertSettingsAlertSettingsTimeBasedEscalationArgs.builder()
.minutesFailingThreshold(10)
.build())
.reminders(CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs.builder()
.amount(5)
.interval(15)
.build())
.build())
.build())
.build());
// Example: use global alert settings instead of custom ones.
var use_global_alerts = new CheckGroupV2("use-global-alerts", CheckGroupV2Args.builder()
.name("Use Global Alert Settings")
.enforceAlertSettings(CheckGroupV2EnforceAlertSettingsArgs.builder()
.enabled(true)
.useGlobalAlertSettings(true)
.build())
.build());
// Example: enforce alert channel subscriptions with custom alert settings.
var email = new AlertChannel("email", AlertChannelArgs.builder()
.email(AlertChannelEmailArgs.builder()
.address("alerts@example.com")
.build())
.build());
var slack = new AlertChannel("slack", AlertChannelArgs.builder()
.slack(AlertChannelSlackArgs.builder()
.channel("#alerts")
.url("https://hooks.slack.com/services/TXXXXX/XXXXX/XXXXXXXXXX")
.build())
.build());
var with_alert_channels = new CheckGroupV2("with-alert-channels", CheckGroupV2Args.builder()
.name("Group with Alert Channels")
.enforceAlertSettings(CheckGroupV2EnforceAlertSettingsArgs.builder()
.enabled(true)
.alertSettings(CheckGroupV2EnforceAlertSettingsAlertSettingsArgs.builder()
.escalationType("RUN_BASED")
.runBasedEscalations(CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArgs.builder()
.failedRunThreshold(1)
.build())
.reminders(CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs.builder()
.amount(0)
.interval(5)
.build())
.build())
.alertChannelSubscriptions(
CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs.builder()
.channelId(email.id())
.activated(true)
.build(),
CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs.builder()
.channelId(slack.id())
.activated(true)
.build())
.build())
.build());
// Example: enforce no retries.
var no_retries = new CheckGroupV2("no-retries", CheckGroupV2Args.builder()
.name("No Retries Group")
.enforceRetryStrategy(CheckGroupV2EnforceRetryStrategyArgs.builder()
.enabled(true)
.retryStrategy(CheckGroupV2EnforceRetryStrategyRetryStrategyArgs.builder()
.type("NO_RETRIES")
.build())
.build())
.build());
// Example: enforce a single retry.
var single_retry = new CheckGroupV2("single-retry", CheckGroupV2Args.builder()
.name("Single Retry Group")
.enforceRetryStrategy(CheckGroupV2EnforceRetryStrategyArgs.builder()
.enabled(true)
.retryStrategy(CheckGroupV2EnforceRetryStrategyRetryStrategyArgs.builder()
.type("SINGLE_RETRY")
.baseBackoffSeconds(10)
.sameRegion(true)
.build())
.build())
.build());
}
}
resources:
# Minimal example: just a folder to organize checks.
just-a-folder:
type: checkly:CheckGroupV2
properties:
name: Just a Folder
# Full example: a group with enforced settings that override individual checks.
production-api:
type: checkly:CheckGroupV2
properties:
name: Production API
activated: true
muted: false
concurrency: 5
tags:
- production
- api
enforceLocations:
enabled: true
locations:
- us-east-1
- eu-west-1
- ap-southeast-1
privateLocations:
- my-datacenter
enforceRetryStrategy:
enabled: true
retryStrategy:
type: LINEAR
baseBackoffSeconds: 30
maxRetries: 3
maxDurationSeconds: 300
sameRegion: true
enforceSchedulingStrategy:
enabled: true
runParallel: true
enforceAlertSettings:
enabled: true
alertSettings:
escalationType: RUN_BASED
runBasedEscalations:
- failedRunThreshold: 2
reminders:
- amount: 3
interval: 10
parallelRunFailureThresholds:
- enabled: true
percentage: 50
alertChannelSubscriptions:
- channelId: 1234
activated: true
environmentVariables:
- key: BASE_URL
value: https://api.example.com
locked: false
- key: API_TOKEN
value: super-secret-token
locked: true
secret: true
defaultRuntime:
runtimeId: '2024.02'
apiCheckDefaults:
url: https://api.example.com/
headers:
X-Api-Key: '{{API_TOKEN}}'
Content-Type: application/json
queryParameters:
version: v2
assertions:
- source: STATUS_CODE
comparison: LESS_THAN
target: '400'
- source: RESPONSE_TIME
comparison: LESS_THAN
target: '3000'
basicAuth:
username: admin
password: pass
setupScript:
inlineScript: |
// Runs before every API check in this group
console.log("Setting up...")
teardownScript:
inlineScript: |
// Runs after every API check in this group
console.log("Tearing down...")
# Example: enforce only retry strategy with network-error-only retries.
retry-on-network-errors:
type: checkly:CheckGroupV2
properties:
name: Retry on Network Errors Only
enforceRetryStrategy:
enabled: true
retryStrategy:
type: EXPONENTIAL
baseBackoffSeconds: 10
maxRetries: 5
maxDurationSeconds: 600
sameRegion: false
onlyOn:
networkError: true
# Example: enforce time-based alert escalation.
time-based-alerts:
type: checkly:CheckGroupV2
properties:
name: Time-Based Alert Escalation
enforceAlertSettings:
enabled: true
alertSettings:
escalationType: TIME_BASED
timeBasedEscalations:
- minutesFailingThreshold: 10
reminders:
- amount: 5
interval: 15
# Example: use global alert settings instead of custom ones.
use-global-alerts:
type: checkly:CheckGroupV2
properties:
name: Use Global Alert Settings
enforceAlertSettings:
enabled: true
useGlobalAlertSettings: true
# Example: enforce alert channel subscriptions with custom alert settings.
email:
type: checkly:AlertChannel
properties:
email:
address: alerts@example.com
slack:
type: checkly:AlertChannel
properties:
slack:
channel: '#alerts'
url: https://hooks.slack.com/services/TXXXXX/XXXXX/XXXXXXXXXX
with-alert-channels:
type: checkly:CheckGroupV2
properties:
name: Group with Alert Channels
enforceAlertSettings:
enabled: true
alertSettings:
escalationType: RUN_BASED
runBasedEscalations:
- failedRunThreshold: 1
reminders:
- amount: 0
interval: 5
alertChannelSubscriptions:
- channelId: ${email.id}
activated: true
- channelId: ${slack.id}
activated: true
# Example: enforce no retries.
no-retries:
type: checkly:CheckGroupV2
properties:
name: No Retries Group
enforceRetryStrategy:
enabled: true
retryStrategy:
type: NO_RETRIES
# Example: enforce a single retry.
single-retry:
type: checkly:CheckGroupV2
properties:
name: Single Retry Group
enforceRetryStrategy:
enabled: true
retryStrategy:
type: SINGLE_RETRY
baseBackoffSeconds: 10
sameRegion: true
Create CheckGroupV2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CheckGroupV2(name: string, args?: CheckGroupV2Args, opts?: CustomResourceOptions);@overload
def CheckGroupV2(resource_name: str,
args: Optional[CheckGroupV2Args] = None,
opts: Optional[ResourceOptions] = None)
@overload
def CheckGroupV2(resource_name: str,
opts: Optional[ResourceOptions] = None,
activated: Optional[bool] = None,
api_check_defaults: Optional[CheckGroupV2ApiCheckDefaultsArgs] = None,
concurrency: Optional[int] = None,
default_runtime: Optional[CheckGroupV2DefaultRuntimeArgs] = None,
enforce_alert_settings: Optional[CheckGroupV2EnforceAlertSettingsArgs] = None,
enforce_locations: Optional[CheckGroupV2EnforceLocationsArgs] = None,
enforce_retry_strategy: Optional[CheckGroupV2EnforceRetryStrategyArgs] = None,
enforce_scheduling_strategy: Optional[CheckGroupV2EnforceSchedulingStrategyArgs] = None,
environment_variables: Optional[Sequence[CheckGroupV2EnvironmentVariableArgs]] = None,
muted: Optional[bool] = None,
name: Optional[str] = None,
setup_script: Optional[CheckGroupV2SetupScriptArgs] = None,
tags: Optional[Sequence[str]] = None,
teardown_script: Optional[CheckGroupV2TeardownScriptArgs] = None)func NewCheckGroupV2(ctx *Context, name string, args *CheckGroupV2Args, opts ...ResourceOption) (*CheckGroupV2, error)public CheckGroupV2(string name, CheckGroupV2Args? args = null, CustomResourceOptions? opts = null)
public CheckGroupV2(String name, CheckGroupV2Args args)
public CheckGroupV2(String name, CheckGroupV2Args args, CustomResourceOptions options)
type: checkly:CheckGroupV2
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 CheckGroupV2Args
- 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 CheckGroupV2Args
- 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 CheckGroupV2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CheckGroupV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CheckGroupV2Args
- 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 checkGroupV2Resource = new Checkly.CheckGroupV2("checkGroupV2Resource", new()
{
Activated = false,
ApiCheckDefaults = new Checkly.Inputs.CheckGroupV2ApiCheckDefaultsArgs
{
Assertions = new[]
{
new Checkly.Inputs.CheckGroupV2ApiCheckDefaultsAssertionArgs
{
Comparison = "string",
Source = "string",
Target = "string",
Property = "string",
},
},
BasicAuth = new Checkly.Inputs.CheckGroupV2ApiCheckDefaultsBasicAuthArgs
{
Password = "string",
Username = "string",
},
Headers =
{
{ "string", "string" },
},
QueryParameters =
{
{ "string", "string" },
},
Url = "string",
},
Concurrency = 0,
DefaultRuntime = new Checkly.Inputs.CheckGroupV2DefaultRuntimeArgs
{
RuntimeId = "string",
},
EnforceAlertSettings = new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsArgs
{
Enabled = false,
AlertChannelSubscriptions = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs
{
Activated = false,
ChannelId = 0,
},
},
AlertSettings = new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsArgs
{
EscalationType = "string",
ParallelRunFailureThresholds = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsParallelRunFailureThresholdArgs
{
Enabled = false,
Percentage = 0,
},
},
Reminders = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs
{
Amount = 0,
Interval = 0,
},
},
RunBasedEscalations = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArgs
{
FailedRunThreshold = 0,
},
},
TimeBasedEscalations = new[]
{
new Checkly.Inputs.CheckGroupV2EnforceAlertSettingsAlertSettingsTimeBasedEscalationArgs
{
MinutesFailingThreshold = 0,
},
},
},
UseGlobalAlertSettings = false,
},
EnforceLocations = new Checkly.Inputs.CheckGroupV2EnforceLocationsArgs
{
Enabled = false,
Locations = new[]
{
"string",
},
PrivateLocations = new[]
{
"string",
},
},
EnforceRetryStrategy = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyArgs
{
Enabled = false,
RetryStrategy = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs
{
Type = "string",
BaseBackoffSeconds = 0,
MaxDurationSeconds = 0,
MaxRetries = 0,
OnlyOn = new Checkly.Inputs.CheckGroupV2EnforceRetryStrategyRetryStrategyOnlyOnArgs
{
NetworkError = false,
},
SameRegion = false,
},
},
EnforceSchedulingStrategy = new Checkly.Inputs.CheckGroupV2EnforceSchedulingStrategyArgs
{
Enabled = false,
RunParallel = false,
},
EnvironmentVariables = new[]
{
new Checkly.Inputs.CheckGroupV2EnvironmentVariableArgs
{
Key = "string",
Value = "string",
Locked = false,
Secret = false,
},
},
Muted = false,
Name = "string",
SetupScript = new Checkly.Inputs.CheckGroupV2SetupScriptArgs
{
InlineScript = "string",
SnippetId = 0,
},
Tags = new[]
{
"string",
},
TeardownScript = new Checkly.Inputs.CheckGroupV2TeardownScriptArgs
{
InlineScript = "string",
SnippetId = 0,
},
});
example, err := checkly.NewCheckGroupV2(ctx, "checkGroupV2Resource", &checkly.CheckGroupV2Args{
Activated: pulumi.Bool(false),
ApiCheckDefaults: &checkly.CheckGroupV2ApiCheckDefaultsArgs{
Assertions: checkly.CheckGroupV2ApiCheckDefaultsAssertionArray{
&checkly.CheckGroupV2ApiCheckDefaultsAssertionArgs{
Comparison: pulumi.String("string"),
Source: pulumi.String("string"),
Target: pulumi.String("string"),
Property: pulumi.String("string"),
},
},
BasicAuth: &checkly.CheckGroupV2ApiCheckDefaultsBasicAuthArgs{
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
QueryParameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Url: pulumi.String("string"),
},
Concurrency: pulumi.Int(0),
DefaultRuntime: &checkly.CheckGroupV2DefaultRuntimeArgs{
RuntimeId: pulumi.String("string"),
},
EnforceAlertSettings: &checkly.CheckGroupV2EnforceAlertSettingsArgs{
Enabled: pulumi.Bool(false),
AlertChannelSubscriptions: checkly.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs{
Activated: pulumi.Bool(false),
ChannelId: pulumi.Int(0),
},
},
AlertSettings: &checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsArgs{
EscalationType: pulumi.String("string"),
ParallelRunFailureThresholds: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsParallelRunFailureThresholdArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsParallelRunFailureThresholdArgs{
Enabled: pulumi.Bool(false),
Percentage: pulumi.Int(0),
},
},
Reminders: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs{
Amount: pulumi.Int(0),
Interval: pulumi.Int(0),
},
},
RunBasedEscalations: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArgs{
FailedRunThreshold: pulumi.Int(0),
},
},
TimeBasedEscalations: checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsTimeBasedEscalationArray{
&checkly.CheckGroupV2EnforceAlertSettingsAlertSettingsTimeBasedEscalationArgs{
MinutesFailingThreshold: pulumi.Int(0),
},
},
},
UseGlobalAlertSettings: pulumi.Bool(false),
},
EnforceLocations: &checkly.CheckGroupV2EnforceLocationsArgs{
Enabled: pulumi.Bool(false),
Locations: pulumi.StringArray{
pulumi.String("string"),
},
PrivateLocations: pulumi.StringArray{
pulumi.String("string"),
},
},
EnforceRetryStrategy: &checkly.CheckGroupV2EnforceRetryStrategyArgs{
Enabled: pulumi.Bool(false),
RetryStrategy: &checkly.CheckGroupV2EnforceRetryStrategyRetryStrategyArgs{
Type: pulumi.String("string"),
BaseBackoffSeconds: pulumi.Int(0),
MaxDurationSeconds: pulumi.Int(0),
MaxRetries: pulumi.Int(0),
OnlyOn: &checkly.CheckGroupV2EnforceRetryStrategyRetryStrategyOnlyOnArgs{
NetworkError: pulumi.Bool(false),
},
SameRegion: pulumi.Bool(false),
},
},
EnforceSchedulingStrategy: &checkly.CheckGroupV2EnforceSchedulingStrategyArgs{
Enabled: pulumi.Bool(false),
RunParallel: pulumi.Bool(false),
},
EnvironmentVariables: checkly.CheckGroupV2EnvironmentVariableArray{
&checkly.CheckGroupV2EnvironmentVariableArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
Locked: pulumi.Bool(false),
Secret: pulumi.Bool(false),
},
},
Muted: pulumi.Bool(false),
Name: pulumi.String("string"),
SetupScript: &checkly.CheckGroupV2SetupScriptArgs{
InlineScript: pulumi.String("string"),
SnippetId: pulumi.Int(0),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TeardownScript: &checkly.CheckGroupV2TeardownScriptArgs{
InlineScript: pulumi.String("string"),
SnippetId: pulumi.Int(0),
},
})
var checkGroupV2Resource = new CheckGroupV2("checkGroupV2Resource", CheckGroupV2Args.builder()
.activated(false)
.apiCheckDefaults(CheckGroupV2ApiCheckDefaultsArgs.builder()
.assertions(CheckGroupV2ApiCheckDefaultsAssertionArgs.builder()
.comparison("string")
.source("string")
.target("string")
.property("string")
.build())
.basicAuth(CheckGroupV2ApiCheckDefaultsBasicAuthArgs.builder()
.password("string")
.username("string")
.build())
.headers(Map.of("string", "string"))
.queryParameters(Map.of("string", "string"))
.url("string")
.build())
.concurrency(0)
.defaultRuntime(CheckGroupV2DefaultRuntimeArgs.builder()
.runtimeId("string")
.build())
.enforceAlertSettings(CheckGroupV2EnforceAlertSettingsArgs.builder()
.enabled(false)
.alertChannelSubscriptions(CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs.builder()
.activated(false)
.channelId(0)
.build())
.alertSettings(CheckGroupV2EnforceAlertSettingsAlertSettingsArgs.builder()
.escalationType("string")
.parallelRunFailureThresholds(CheckGroupV2EnforceAlertSettingsAlertSettingsParallelRunFailureThresholdArgs.builder()
.enabled(false)
.percentage(0)
.build())
.reminders(CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs.builder()
.amount(0)
.interval(0)
.build())
.runBasedEscalations(CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArgs.builder()
.failedRunThreshold(0)
.build())
.timeBasedEscalations(CheckGroupV2EnforceAlertSettingsAlertSettingsTimeBasedEscalationArgs.builder()
.minutesFailingThreshold(0)
.build())
.build())
.useGlobalAlertSettings(false)
.build())
.enforceLocations(CheckGroupV2EnforceLocationsArgs.builder()
.enabled(false)
.locations("string")
.privateLocations("string")
.build())
.enforceRetryStrategy(CheckGroupV2EnforceRetryStrategyArgs.builder()
.enabled(false)
.retryStrategy(CheckGroupV2EnforceRetryStrategyRetryStrategyArgs.builder()
.type("string")
.baseBackoffSeconds(0)
.maxDurationSeconds(0)
.maxRetries(0)
.onlyOn(CheckGroupV2EnforceRetryStrategyRetryStrategyOnlyOnArgs.builder()
.networkError(false)
.build())
.sameRegion(false)
.build())
.build())
.enforceSchedulingStrategy(CheckGroupV2EnforceSchedulingStrategyArgs.builder()
.enabled(false)
.runParallel(false)
.build())
.environmentVariables(CheckGroupV2EnvironmentVariableArgs.builder()
.key("string")
.value("string")
.locked(false)
.secret(false)
.build())
.muted(false)
.name("string")
.setupScript(CheckGroupV2SetupScriptArgs.builder()
.inlineScript("string")
.snippetId(0)
.build())
.tags("string")
.teardownScript(CheckGroupV2TeardownScriptArgs.builder()
.inlineScript("string")
.snippetId(0)
.build())
.build());
check_group_v2_resource = checkly.CheckGroupV2("checkGroupV2Resource",
activated=False,
api_check_defaults={
"assertions": [{
"comparison": "string",
"source": "string",
"target": "string",
"property": "string",
}],
"basic_auth": {
"password": "string",
"username": "string",
},
"headers": {
"string": "string",
},
"query_parameters": {
"string": "string",
},
"url": "string",
},
concurrency=0,
default_runtime={
"runtime_id": "string",
},
enforce_alert_settings={
"enabled": False,
"alert_channel_subscriptions": [{
"activated": False,
"channel_id": 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,
}],
},
"use_global_alert_settings": False,
},
enforce_locations={
"enabled": False,
"locations": ["string"],
"private_locations": ["string"],
},
enforce_retry_strategy={
"enabled": False,
"retry_strategy": {
"type": "string",
"base_backoff_seconds": 0,
"max_duration_seconds": 0,
"max_retries": 0,
"only_on": {
"network_error": False,
},
"same_region": False,
},
},
enforce_scheduling_strategy={
"enabled": False,
"run_parallel": False,
},
environment_variables=[{
"key": "string",
"value": "string",
"locked": False,
"secret": False,
}],
muted=False,
name="string",
setup_script={
"inline_script": "string",
"snippet_id": 0,
},
tags=["string"],
teardown_script={
"inline_script": "string",
"snippet_id": 0,
})
const checkGroupV2Resource = new checkly.CheckGroupV2("checkGroupV2Resource", {
activated: false,
apiCheckDefaults: {
assertions: [{
comparison: "string",
source: "string",
target: "string",
property: "string",
}],
basicAuth: {
password: "string",
username: "string",
},
headers: {
string: "string",
},
queryParameters: {
string: "string",
},
url: "string",
},
concurrency: 0,
defaultRuntime: {
runtimeId: "string",
},
enforceAlertSettings: {
enabled: 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,
}],
},
useGlobalAlertSettings: false,
},
enforceLocations: {
enabled: false,
locations: ["string"],
privateLocations: ["string"],
},
enforceRetryStrategy: {
enabled: false,
retryStrategy: {
type: "string",
baseBackoffSeconds: 0,
maxDurationSeconds: 0,
maxRetries: 0,
onlyOn: {
networkError: false,
},
sameRegion: false,
},
},
enforceSchedulingStrategy: {
enabled: false,
runParallel: false,
},
environmentVariables: [{
key: "string",
value: "string",
locked: false,
secret: false,
}],
muted: false,
name: "string",
setupScript: {
inlineScript: "string",
snippetId: 0,
},
tags: ["string"],
teardownScript: {
inlineScript: "string",
snippetId: 0,
},
});
type: checkly:CheckGroupV2
properties:
activated: false
apiCheckDefaults:
assertions:
- comparison: string
property: string
source: string
target: string
basicAuth:
password: string
username: string
headers:
string: string
queryParameters:
string: string
url: string
concurrency: 0
defaultRuntime:
runtimeId: string
enforceAlertSettings:
alertChannelSubscriptions:
- activated: false
channelId: 0
alertSettings:
escalationType: string
parallelRunFailureThresholds:
- enabled: false
percentage: 0
reminders:
- amount: 0
interval: 0
runBasedEscalations:
- failedRunThreshold: 0
timeBasedEscalations:
- minutesFailingThreshold: 0
enabled: false
useGlobalAlertSettings: false
enforceLocations:
enabled: false
locations:
- string
privateLocations:
- string
enforceRetryStrategy:
enabled: false
retryStrategy:
baseBackoffSeconds: 0
maxDurationSeconds: 0
maxRetries: 0
onlyOn:
networkError: false
sameRegion: false
type: string
enforceSchedulingStrategy:
enabled: false
runParallel: false
environmentVariables:
- key: string
locked: false
secret: false
value: string
muted: false
name: string
setupScript:
inlineScript: string
snippetId: 0
tags:
- string
teardownScript:
inlineScript: string
snippetId: 0
CheckGroupV2 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 CheckGroupV2 resource accepts the following input properties:
- Activated bool
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - Api
Check CheckDefaults Group V2Api Check Defaults - Concurrency int
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - Default
Runtime CheckGroup V2Default Runtime - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- Enforce
Alert CheckSettings Group V2Enforce Alert Settings - Enforces alert settings for the whole group. Overrides check configuration.
- Enforce
Locations CheckGroup V2Enforce Locations - Enforces public and private locations for the whole group. Overrides check configuration.
- Enforce
Retry CheckStrategy Group V2Enforce Retry Strategy - Enforces a retry strategy for the whole group. Overrides check configuration.
- Enforce
Scheduling CheckStrategy Group V2Enforce Scheduling Strategy - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- Environment
Variables List<CheckGroup V2Environment Variable> - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- Muted bool
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - Name string
- The name of the check group.
- Setup
Script CheckGroup V2Setup Script - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- List<string>
- Additional tags to append to all checks in the group.
- Teardown
Script CheckGroup V2Teardown Script - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
- Activated bool
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - Api
Check CheckDefaults Group V2Api Check Defaults Args - Concurrency int
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - Default
Runtime CheckGroup V2Default Runtime Args - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- Enforce
Alert CheckSettings Group V2Enforce Alert Settings Args - Enforces alert settings for the whole group. Overrides check configuration.
- Enforce
Locations CheckGroup V2Enforce Locations Args - Enforces public and private locations for the whole group. Overrides check configuration.
- Enforce
Retry CheckStrategy Group V2Enforce Retry Strategy Args - Enforces a retry strategy for the whole group. Overrides check configuration.
- Enforce
Scheduling CheckStrategy Group V2Enforce Scheduling Strategy Args - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- Environment
Variables []CheckGroup V2Environment Variable Args - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- Muted bool
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - Name string
- The name of the check group.
- Setup
Script CheckGroup V2Setup Script Args - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- []string
- Additional tags to append to all checks in the group.
- Teardown
Script CheckGroup V2Teardown Script Args - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
- activated Boolean
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - api
Check CheckDefaults Group V2Api Check Defaults - concurrency Integer
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - default
Runtime CheckGroup V2Default Runtime - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- enforce
Alert CheckSettings Group V2Enforce Alert Settings - Enforces alert settings for the whole group. Overrides check configuration.
- enforce
Locations CheckGroup V2Enforce Locations - Enforces public and private locations for the whole group. Overrides check configuration.
- enforce
Retry CheckStrategy Group V2Enforce Retry Strategy - Enforces a retry strategy for the whole group. Overrides check configuration.
- enforce
Scheduling CheckStrategy Group V2Enforce Scheduling Strategy - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- environment
Variables List<CheckGroup V2Environment Variable> - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- muted Boolean
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - name String
- The name of the check group.
- setup
Script CheckGroup V2Setup Script - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- List<String>
- Additional tags to append to all checks in the group.
- teardown
Script CheckGroup V2Teardown Script - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
- activated boolean
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - api
Check CheckDefaults Group V2Api Check Defaults - concurrency number
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - default
Runtime CheckGroup V2Default Runtime - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- enforce
Alert CheckSettings Group V2Enforce Alert Settings - Enforces alert settings for the whole group. Overrides check configuration.
- enforce
Locations CheckGroup V2Enforce Locations - Enforces public and private locations for the whole group. Overrides check configuration.
- enforce
Retry CheckStrategy Group V2Enforce Retry Strategy - Enforces a retry strategy for the whole group. Overrides check configuration.
- enforce
Scheduling CheckStrategy Group V2Enforce Scheduling Strategy - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- environment
Variables CheckGroup V2Environment Variable[] - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- muted boolean
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - name string
- The name of the check group.
- setup
Script CheckGroup V2Setup Script - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- string[]
- Additional tags to append to all checks in the group.
- teardown
Script CheckGroup V2Teardown Script - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
- activated bool
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - api_
check_ Checkdefaults Group V2Api Check Defaults Args - concurrency int
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - default_
runtime CheckGroup V2Default Runtime Args - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- enforce_
alert_ Checksettings Group V2Enforce Alert Settings Args - Enforces alert settings for the whole group. Overrides check configuration.
- enforce_
locations CheckGroup V2Enforce Locations Args - Enforces public and private locations for the whole group. Overrides check configuration.
- enforce_
retry_ Checkstrategy Group V2Enforce Retry Strategy Args - Enforces a retry strategy for the whole group. Overrides check configuration.
- enforce_
scheduling_ Checkstrategy Group V2Enforce Scheduling Strategy Args - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- environment_
variables Sequence[CheckGroup V2Environment Variable Args] - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- muted bool
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - name str
- The name of the check group.
- setup_
script CheckGroup V2Setup Script Args - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- Sequence[str]
- Additional tags to append to all checks in the group.
- teardown_
script CheckGroup V2Teardown Script Args - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
- activated Boolean
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - api
Check Property MapDefaults - concurrency Number
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - default
Runtime Property Map - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- enforce
Alert Property MapSettings - Enforces alert settings for the whole group. Overrides check configuration.
- enforce
Locations Property Map - Enforces public and private locations for the whole group. Overrides check configuration.
- enforce
Retry Property MapStrategy - Enforces a retry strategy for the whole group. Overrides check configuration.
- enforce
Scheduling Property MapStrategy - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- environment
Variables List<Property Map> - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- muted Boolean
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - name String
- The name of the check group.
- setup
Script Property Map - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- List<String>
- Additional tags to append to all checks in the group.
- teardown
Script Property Map - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
Outputs
All input properties are implicitly available as output properties. Additionally, the CheckGroupV2 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 CheckGroupV2 Resource
Get an existing CheckGroupV2 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?: CheckGroupV2State, opts?: CustomResourceOptions): CheckGroupV2@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
activated: Optional[bool] = None,
api_check_defaults: Optional[CheckGroupV2ApiCheckDefaultsArgs] = None,
concurrency: Optional[int] = None,
default_runtime: Optional[CheckGroupV2DefaultRuntimeArgs] = None,
enforce_alert_settings: Optional[CheckGroupV2EnforceAlertSettingsArgs] = None,
enforce_locations: Optional[CheckGroupV2EnforceLocationsArgs] = None,
enforce_retry_strategy: Optional[CheckGroupV2EnforceRetryStrategyArgs] = None,
enforce_scheduling_strategy: Optional[CheckGroupV2EnforceSchedulingStrategyArgs] = None,
environment_variables: Optional[Sequence[CheckGroupV2EnvironmentVariableArgs]] = None,
muted: Optional[bool] = None,
name: Optional[str] = None,
setup_script: Optional[CheckGroupV2SetupScriptArgs] = None,
tags: Optional[Sequence[str]] = None,
teardown_script: Optional[CheckGroupV2TeardownScriptArgs] = None) -> CheckGroupV2func GetCheckGroupV2(ctx *Context, name string, id IDInput, state *CheckGroupV2State, opts ...ResourceOption) (*CheckGroupV2, error)public static CheckGroupV2 Get(string name, Input<string> id, CheckGroupV2State? state, CustomResourceOptions? opts = null)public static CheckGroupV2 get(String name, Output<String> id, CheckGroupV2State state, CustomResourceOptions options)resources: _: type: checkly:CheckGroupV2 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 activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - Api
Check CheckDefaults Group V2Api Check Defaults - Concurrency int
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - Default
Runtime CheckGroup V2Default Runtime - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- Enforce
Alert CheckSettings Group V2Enforce Alert Settings - Enforces alert settings for the whole group. Overrides check configuration.
- Enforce
Locations CheckGroup V2Enforce Locations - Enforces public and private locations for the whole group. Overrides check configuration.
- Enforce
Retry CheckStrategy Group V2Enforce Retry Strategy - Enforces a retry strategy for the whole group. Overrides check configuration.
- Enforce
Scheduling CheckStrategy Group V2Enforce Scheduling Strategy - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- Environment
Variables List<CheckGroup V2Environment Variable> - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- Muted bool
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - Name string
- The name of the check group.
- Setup
Script CheckGroup V2Setup Script - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- List<string>
- Additional tags to append to all checks in the group.
- Teardown
Script CheckGroup V2Teardown Script - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
- Activated bool
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - Api
Check CheckDefaults Group V2Api Check Defaults Args - Concurrency int
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - Default
Runtime CheckGroup V2Default Runtime Args - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- Enforce
Alert CheckSettings Group V2Enforce Alert Settings Args - Enforces alert settings for the whole group. Overrides check configuration.
- Enforce
Locations CheckGroup V2Enforce Locations Args - Enforces public and private locations for the whole group. Overrides check configuration.
- Enforce
Retry CheckStrategy Group V2Enforce Retry Strategy Args - Enforces a retry strategy for the whole group. Overrides check configuration.
- Enforce
Scheduling CheckStrategy Group V2Enforce Scheduling Strategy Args - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- Environment
Variables []CheckGroup V2Environment Variable Args - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- Muted bool
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - Name string
- The name of the check group.
- Setup
Script CheckGroup V2Setup Script Args - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- []string
- Additional tags to append to all checks in the group.
- Teardown
Script CheckGroup V2Teardown Script Args - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
- activated Boolean
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - api
Check CheckDefaults Group V2Api Check Defaults - concurrency Integer
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - default
Runtime CheckGroup V2Default Runtime - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- enforce
Alert CheckSettings Group V2Enforce Alert Settings - Enforces alert settings for the whole group. Overrides check configuration.
- enforce
Locations CheckGroup V2Enforce Locations - Enforces public and private locations for the whole group. Overrides check configuration.
- enforce
Retry CheckStrategy Group V2Enforce Retry Strategy - Enforces a retry strategy for the whole group. Overrides check configuration.
- enforce
Scheduling CheckStrategy Group V2Enforce Scheduling Strategy - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- environment
Variables List<CheckGroup V2Environment Variable> - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- muted Boolean
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - name String
- The name of the check group.
- setup
Script CheckGroup V2Setup Script - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- List<String>
- Additional tags to append to all checks in the group.
- teardown
Script CheckGroup V2Teardown Script - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
- activated boolean
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - api
Check CheckDefaults Group V2Api Check Defaults - concurrency number
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - default
Runtime CheckGroup V2Default Runtime - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- enforce
Alert CheckSettings Group V2Enforce Alert Settings - Enforces alert settings for the whole group. Overrides check configuration.
- enforce
Locations CheckGroup V2Enforce Locations - Enforces public and private locations for the whole group. Overrides check configuration.
- enforce
Retry CheckStrategy Group V2Enforce Retry Strategy - Enforces a retry strategy for the whole group. Overrides check configuration.
- enforce
Scheduling CheckStrategy Group V2Enforce Scheduling Strategy - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- environment
Variables CheckGroup V2Environment Variable[] - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- muted boolean
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - name string
- The name of the check group.
- setup
Script CheckGroup V2Setup Script - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- string[]
- Additional tags to append to all checks in the group.
- teardown
Script CheckGroup V2Teardown Script - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
- activated bool
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - api_
check_ Checkdefaults Group V2Api Check Defaults Args - concurrency int
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - default_
runtime CheckGroup V2Default Runtime Args - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- enforce_
alert_ Checksettings Group V2Enforce Alert Settings Args - Enforces alert settings for the whole group. Overrides check configuration.
- enforce_
locations CheckGroup V2Enforce Locations Args - Enforces public and private locations for the whole group. Overrides check configuration.
- enforce_
retry_ Checkstrategy Group V2Enforce Retry Strategy Args - Enforces a retry strategy for the whole group. Overrides check configuration.
- enforce_
scheduling_ Checkstrategy Group V2Enforce Scheduling Strategy Args - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- environment_
variables Sequence[CheckGroup V2Environment Variable Args] - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- muted bool
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - name str
- The name of the check group.
- setup_
script CheckGroup V2Setup Script Args - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- Sequence[str]
- Additional tags to append to all checks in the group.
- teardown_
script CheckGroup V2Teardown Script Args - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
- activated Boolean
- Determines whether activated checks in the group should run or not. Deactivating the group will prevent all checks in the group from running, regardless of their activated state. (Default
true). - api
Check Property MapDefaults - concurrency Number
- Determines the number of checks to run concurrently when triggering the check group via CI/CD or the API. (Default
1). - default
Runtime Property Map - Sets a default runtime for the group. Used as a fallback when a check belonging to the group has no runtime set. Takes precedence over the account default runtime.
- enforce
Alert Property MapSettings - Enforces alert settings for the whole group. Overrides check configuration.
- enforce
Locations Property Map - Enforces public and private locations for the whole group. Overrides check configuration.
- enforce
Retry Property MapStrategy - Enforces a retry strategy for the whole group. Overrides check configuration.
- enforce
Scheduling Property MapStrategy - Enforces a scheduling strategy for the whole group. Overrides check configuration.
- environment
Variables List<Property Map> - Insert environment variables into the runtime environment of checks in the group. Only relevant for check types that support environment variables. Use global environment variables whenever possible.
- muted Boolean
- Determines if any notifications will be sent out when a check in this group fails and/or recovers. Muting the group will deactivate all notifications for all checks in the group, regardless of their muted state. (Default
false). - name String
- The name of the check group.
- setup
Script Property Map - A script to run in the setup phase of an API check. Runs in addition to the check's own setup script.
- List<String>
- Additional tags to append to all checks in the group.
- teardown
Script Property Map - A script to run in the teardown phase of an API check. Runs in addition to the check's own teardown script.
Supporting Types
CheckGroupV2ApiCheckDefaults, CheckGroupV2ApiCheckDefaultsArgs
- Assertions
List<Check
Group V2Api Check Defaults Assertion> - Basic
Auth CheckGroup V2Api Check Defaults Basic Auth - Headers Dictionary<string, string>
- Query
Parameters Dictionary<string, string> - Url string
- The base url for this group which you can reference with the
GROUP_BASE_URLvariable in all group checks.
- Assertions
[]Check
Group V2Api Check Defaults Assertion - Basic
Auth CheckGroup V2Api Check Defaults Basic Auth - Headers map[string]string
- Query
Parameters map[string]string - Url string
- The base url for this group which you can reference with the
GROUP_BASE_URLvariable in all group checks.
- assertions
List<Check
Group V2Api Check Defaults Assertion> - basic
Auth CheckGroup V2Api Check Defaults Basic Auth - headers Map<String,String>
- query
Parameters Map<String,String> - url String
- The base url for this group which you can reference with the
GROUP_BASE_URLvariable in all group checks.
- assertions
Check
Group V2Api Check Defaults Assertion[] - basic
Auth CheckGroup V2Api Check Defaults Basic Auth - headers {[key: string]: string}
- query
Parameters {[key: string]: string} - url string
- The base url for this group which you can reference with the
GROUP_BASE_URLvariable in all group checks.
- assertions
Sequence[Check
Group V2Api Check Defaults Assertion] - basic_
auth CheckGroup V2Api Check Defaults Basic Auth - headers Mapping[str, str]
- query_
parameters Mapping[str, str] - url str
- The base url for this group which you can reference with the
GROUP_BASE_URLvariable in all group checks.
- assertions List<Property Map>
- basic
Auth Property Map - headers Map<String>
- query
Parameters Map<String> - url String
- The base url for this group which you can reference with the
GROUP_BASE_URLvariable in all group checks.
CheckGroupV2ApiCheckDefaultsAssertion, CheckGroupV2ApiCheckDefaultsAssertionArgs
- Comparison string
- The type of comparison to be executed between expected and actual value of the assertion. Possible values
EQUALS,NOT_EQUALS,HAS_KEY,NOT_HAS_KEY,HAS_VALUE,NOT_HAS_VALUE,IS_EMPTY,NOT_EMPTY,GREATER_THAN,LESS_THAN,CONTAINS,NOT_CONTAINS,IS_NULL, andNOT_NULL. - Source string
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_TIME. - Target string
- Property string
- Comparison string
- The type of comparison to be executed between expected and actual value of the assertion. Possible values
EQUALS,NOT_EQUALS,HAS_KEY,NOT_HAS_KEY,HAS_VALUE,NOT_HAS_VALUE,IS_EMPTY,NOT_EMPTY,GREATER_THAN,LESS_THAN,CONTAINS,NOT_CONTAINS,IS_NULL, andNOT_NULL. - Source string
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_TIME. - Target string
- Property string
- comparison String
- The type of comparison to be executed between expected and actual value of the assertion. Possible values
EQUALS,NOT_EQUALS,HAS_KEY,NOT_HAS_KEY,HAS_VALUE,NOT_HAS_VALUE,IS_EMPTY,NOT_EMPTY,GREATER_THAN,LESS_THAN,CONTAINS,NOT_CONTAINS,IS_NULL, andNOT_NULL. - source String
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_TIME. - target String
- property String
- comparison string
- The type of comparison to be executed between expected and actual value of the assertion. Possible values
EQUALS,NOT_EQUALS,HAS_KEY,NOT_HAS_KEY,HAS_VALUE,NOT_HAS_VALUE,IS_EMPTY,NOT_EMPTY,GREATER_THAN,LESS_THAN,CONTAINS,NOT_CONTAINS,IS_NULL, andNOT_NULL. - source string
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_TIME. - target string
- property string
- comparison str
- The type of comparison to be executed between expected and actual value of the assertion. Possible values
EQUALS,NOT_EQUALS,HAS_KEY,NOT_HAS_KEY,HAS_VALUE,NOT_HAS_VALUE,IS_EMPTY,NOT_EMPTY,GREATER_THAN,LESS_THAN,CONTAINS,NOT_CONTAINS,IS_NULL, andNOT_NULL. - source str
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_TIME. - target str
- property str
- comparison String
- The type of comparison to be executed between expected and actual value of the assertion. Possible values
EQUALS,NOT_EQUALS,HAS_KEY,NOT_HAS_KEY,HAS_VALUE,NOT_HAS_VALUE,IS_EMPTY,NOT_EMPTY,GREATER_THAN,LESS_THAN,CONTAINS,NOT_CONTAINS,IS_NULL, andNOT_NULL. - source String
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_TIME. - target String
- property String
CheckGroupV2ApiCheckDefaultsBasicAuth, CheckGroupV2ApiCheckDefaultsBasicAuthArgs
CheckGroupV2DefaultRuntime, CheckGroupV2DefaultRuntimeArgs
- Runtime
Id string - The runtime ID.
- Runtime
Id string - The runtime ID.
- runtime
Id String - The runtime ID.
- runtime
Id string - The runtime ID.
- runtime_
id str - The runtime ID.
- runtime
Id String - The runtime ID.
CheckGroupV2EnforceAlertSettings, CheckGroupV2EnforceAlertSettingsArgs
- Enabled bool
- Determines whether the enforced alert settings should be active.
- Alert
Channel List<CheckSubscriptions Group V2Enforce Alert Settings Alert Channel Subscription> - An array of channel IDs and whether they're activated or not. If you don't set at least one alert channel subscription for your check, we won't be able to alert you even if it starts failing.
- Alert
Settings CheckGroup V2Enforce Alert Settings Alert Settings - Determines the alert escalation policy for the check.
- Use
Global boolAlert Settings - Whether to use account level alert settings instead of the group's alert settings.Default (
false).
- Enabled bool
- Determines whether the enforced alert settings should be active.
- Alert
Channel []CheckSubscriptions Group V2Enforce Alert Settings Alert Channel Subscription - An array of channel IDs and whether they're activated or not. If you don't set at least one alert channel subscription for your check, we won't be able to alert you even if it starts failing.
- Alert
Settings CheckGroup V2Enforce Alert Settings Alert Settings - Determines the alert escalation policy for the check.
- Use
Global boolAlert Settings - Whether to use account level alert settings instead of the group's alert settings.Default (
false).
- enabled Boolean
- Determines whether the enforced alert settings should be active.
- alert
Channel List<CheckSubscriptions Group V2Enforce Alert Settings Alert Channel Subscription> - An array of channel IDs and whether they're activated or not. If you don't set at least one alert channel subscription for your check, we won't be able to alert you even if it starts failing.
- alert
Settings CheckGroup V2Enforce Alert Settings Alert Settings - Determines the alert escalation policy for the check.
- use
Global BooleanAlert Settings - Whether to use account level alert settings instead of the group's alert settings.Default (
false).
- enabled boolean
- Determines whether the enforced alert settings should be active.
- alert
Channel CheckSubscriptions Group V2Enforce Alert Settings Alert Channel Subscription[] - An array of channel IDs and whether they're activated or not. If you don't set at least one alert channel subscription for your check, we won't be able to alert you even if it starts failing.
- alert
Settings CheckGroup V2Enforce Alert Settings Alert Settings - Determines the alert escalation policy for the check.
- use
Global booleanAlert Settings - Whether to use account level alert settings instead of the group's alert settings.Default (
false).
- enabled bool
- Determines whether the enforced alert settings should be active.
- alert_
channel_ Sequence[Checksubscriptions Group V2Enforce Alert Settings Alert Channel Subscription] - An array of channel IDs and whether they're activated or not. If you don't set at least one alert channel subscription for your check, we won't be able to alert you even if it starts failing.
- alert_
settings CheckGroup V2Enforce Alert Settings Alert Settings - Determines the alert escalation policy for the check.
- use_
global_ boolalert_ settings - Whether to use account level alert settings instead of the group's alert settings.Default (
false).
- enabled Boolean
- Determines whether the enforced alert settings should be active.
- 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 channel subscription for your check, we won't be able to alert you even if it starts failing.
- alert
Settings Property Map - Determines the alert escalation policy for the check.
- use
Global BooleanAlert Settings - Whether to use account level alert settings instead of the group's alert settings.Default (
false).
CheckGroupV2EnforceAlertSettingsAlertChannelSubscription, CheckGroupV2EnforceAlertSettingsAlertChannelSubscriptionArgs
- activated bool
- Whether an alert should be sent to this channel.
- channel_
id int - The ID of the alert channel.
CheckGroupV2EnforceAlertSettingsAlertSettings, CheckGroupV2EnforceAlertSettingsAlertSettingsArgs
- Escalation
Type string - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - Parallel
Run List<CheckFailure Thresholds Group V2Enforce Alert Settings Alert Settings Parallel Run Failure Threshold> - Configuration for parallel run failure threshold.
- Reminders
List<Check
Group V2Enforce Alert Settings Alert Settings Reminder> - Defines how often to send reminder notifications after initial alert.
- Run
Based List<CheckEscalations Group V2Enforce Alert Settings Alert Settings Run Based Escalation> - Configuration for run-based escalation.
- Ssl
Certificates List<CheckGroup V2Enforce Alert Settings Alert Settings Ssl Certificate> - Time
Based List<CheckEscalations Group V2Enforce Alert Settings 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 []CheckFailure Thresholds Group V2Enforce Alert Settings Alert Settings Parallel Run Failure Threshold - Configuration for parallel run failure threshold.
- Reminders
[]Check
Group V2Enforce Alert Settings Alert Settings Reminder - Defines how often to send reminder notifications after initial alert.
- Run
Based []CheckEscalations Group V2Enforce Alert Settings Alert Settings Run Based Escalation - Configuration for run-based escalation.
- Ssl
Certificates []CheckGroup V2Enforce Alert Settings Alert Settings Ssl Certificate - Time
Based []CheckEscalations Group V2Enforce Alert Settings 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<CheckFailure Thresholds Group V2Enforce Alert Settings Alert Settings Parallel Run Failure Threshold> - Configuration for parallel run failure threshold.
- reminders
List<Check
Group V2Enforce Alert Settings Alert Settings Reminder> - Defines how often to send reminder notifications after initial alert.
- run
Based List<CheckEscalations Group V2Enforce Alert Settings Alert Settings Run Based Escalation> - Configuration for run-based escalation.
- ssl
Certificates List<CheckGroup V2Enforce Alert Settings Alert Settings Ssl Certificate> - time
Based List<CheckEscalations Group V2Enforce Alert Settings 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 CheckFailure Thresholds Group V2Enforce Alert Settings Alert Settings Parallel Run Failure Threshold[] - Configuration for parallel run failure threshold.
- reminders
Check
Group V2Enforce Alert Settings Alert Settings Reminder[] - Defines how often to send reminder notifications after initial alert.
- run
Based CheckEscalations Group V2Enforce Alert Settings Alert Settings Run Based Escalation[] - Configuration for run-based escalation.
- ssl
Certificates CheckGroup V2Enforce Alert Settings Alert Settings Ssl Certificate[] - time
Based CheckEscalations Group V2Enforce Alert Settings 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[Checkfailure_ thresholds Group V2Enforce Alert Settings Alert Settings Parallel Run Failure Threshold] - Configuration for parallel run failure threshold.
- reminders
Sequence[Check
Group V2Enforce Alert Settings Alert Settings Reminder] - Defines how often to send reminder notifications after initial alert.
- run_
based_ Sequence[Checkescalations Group V2Enforce Alert Settings Alert Settings Run Based Escalation] - Configuration for run-based escalation.
- ssl_
certificates Sequence[CheckGroup V2Enforce Alert Settings Alert Settings Ssl Certificate] - time_
based_ Sequence[Checkescalations Group V2Enforce Alert Settings 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.
- ssl
Certificates List<Property Map> - time
Based List<Property Map>Escalations - Configuration for time-based escalation.
CheckGroupV2EnforceAlertSettingsAlertSettingsParallelRunFailureThreshold, CheckGroupV2EnforceAlertSettingsAlertSettingsParallelRunFailureThresholdArgs
- Enabled bool
- Whether parallel run failure threshold is enabled. Only applies if the check 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 check 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 check 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 check 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 check 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 check 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).
CheckGroupV2EnforceAlertSettingsAlertSettingsReminder, CheckGroupV2EnforceAlertSettingsAlertSettingsReminderArgs
CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalation, CheckGroupV2EnforceAlertSettingsAlertSettingsRunBasedEscalationArgs
- Failed
Run intThreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
- Failed
Run intThreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
- failed
Run IntegerThreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
- failed
Run numberThreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
- failed_
run_ intthreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
- failed
Run NumberThreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
CheckGroupV2EnforceAlertSettingsAlertSettingsSslCertificate, CheckGroupV2EnforceAlertSettingsAlertSettingsSslCertificateArgs
- Alert
Threshold int - No longer available.
- Enabled bool
- No longer available.
- Alert
Threshold int - No longer available.
- Enabled bool
- No longer available.
- alert
Threshold Integer - No longer available.
- enabled Boolean
- No longer available.
- alert
Threshold number - No longer available.
- enabled boolean
- No longer available.
- alert_
threshold int - No longer available.
- enabled bool
- No longer available.
- alert
Threshold Number - No longer available.
- enabled Boolean
- No longer available.
CheckGroupV2EnforceAlertSettingsAlertSettingsTimeBasedEscalation, CheckGroupV2EnforceAlertSettingsAlertSettingsTimeBasedEscalationArgs
- Minutes
Failing intThreshold - Send an alert notification after the check 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 check 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 check 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 check 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 check 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 check has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
CheckGroupV2EnforceLocations, CheckGroupV2EnforceLocationsArgs
- Enabled bool
- Determines whether the enforced locations should be active.
- Locations List<string>
- An array of one or more data center locations where to run the checks.
- Private
Locations List<string> - An array of one or more private locations slugs.
- Enabled bool
- Determines whether the enforced locations should be active.
- Locations []string
- An array of one or more data center locations where to run the checks.
- Private
Locations []string - An array of one or more private locations slugs.
- enabled Boolean
- Determines whether the enforced locations should be active.
- locations List<String>
- An array of one or more data center locations where to run the checks.
- private
Locations List<String> - An array of one or more private locations slugs.
- enabled boolean
- Determines whether the enforced locations should be active.
- locations string[]
- An array of one or more data center locations where to run the checks.
- private
Locations string[] - An array of one or more private locations slugs.
- enabled bool
- Determines whether the enforced locations should be active.
- locations Sequence[str]
- An array of one or more data center locations where to run the checks.
- private_
locations Sequence[str] - An array of one or more private locations slugs.
- enabled Boolean
- Determines whether the enforced locations should be active.
- locations List<String>
- An array of one or more data center locations where to run the checks.
- private
Locations List<String> - An array of one or more private locations slugs.
CheckGroupV2EnforceRetryStrategy, CheckGroupV2EnforceRetryStrategyArgs
- Enabled bool
- Determines whether the enforced retry strategy should be active.
- Retry
Strategy CheckGroup V2Enforce Retry Strategy Retry Strategy - A strategy for retrying failed check/monitor runs.
- Enabled bool
- Determines whether the enforced retry strategy should be active.
- Retry
Strategy CheckGroup V2Enforce Retry Strategy Retry Strategy - A strategy for retrying failed check/monitor runs.
- enabled Boolean
- Determines whether the enforced retry strategy should be active.
- retry
Strategy CheckGroup V2Enforce Retry Strategy Retry Strategy - A strategy for retrying failed check/monitor runs.
- enabled boolean
- Determines whether the enforced retry strategy should be active.
- retry
Strategy CheckGroup V2Enforce Retry Strategy Retry Strategy - A strategy for retrying failed check/monitor runs.
- enabled bool
- Determines whether the enforced retry strategy should be active.
- retry_
strategy CheckGroup V2Enforce Retry Strategy Retry Strategy - A strategy for retrying failed check/monitor runs.
- enabled Boolean
- Determines whether the enforced retry strategy should be active.
- retry
Strategy Property Map - A strategy for retrying failed check/monitor runs.
CheckGroupV2EnforceRetryStrategyRetryStrategy, CheckGroupV2EnforceRetryStrategyRetryStrategyArgs
- 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 CheckGroup V2Enforce Retry Strategy 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 CheckGroup V2Enforce Retry Strategy 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 CheckGroup V2Enforce Retry Strategy 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 CheckGroup V2Enforce Retry Strategy 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 CheckGroup V2Enforce Retry Strategy 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).
CheckGroupV2EnforceRetryStrategyRetryStrategyOnlyOn, CheckGroupV2EnforceRetryStrategyRetryStrategyOnlyOnArgs
- Network
Error bool - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
- Network
Error bool - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
- network
Error Boolean - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
- network
Error boolean - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
- network_
error bool - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
- network
Error Boolean - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
CheckGroupV2EnforceSchedulingStrategy, CheckGroupV2EnforceSchedulingStrategyArgs
- Enabled bool
- Determines whether the enforced scheduling strategy should be active.
- Run
Parallel bool - Determines if the checks in the group should run in all selected locations in parallel or round-robin.
- Enabled bool
- Determines whether the enforced scheduling strategy should be active.
- Run
Parallel bool - Determines if the checks in the group should run in all selected locations in parallel or round-robin.
- enabled Boolean
- Determines whether the enforced scheduling strategy should be active.
- run
Parallel Boolean - Determines if the checks in the group should run in all selected locations in parallel or round-robin.
- enabled boolean
- Determines whether the enforced scheduling strategy should be active.
- run
Parallel boolean - Determines if the checks in the group should run in all selected locations in parallel or round-robin.
- enabled bool
- Determines whether the enforced scheduling strategy should be active.
- run_
parallel bool - Determines if the checks in the group should run in all selected locations in parallel or round-robin.
- enabled Boolean
- Determines whether the enforced scheduling strategy should be active.
- run
Parallel Boolean - Determines if the checks in the group should run in all selected locations in parallel or round-robin.
CheckGroupV2EnvironmentVariable, CheckGroupV2EnvironmentVariableArgs
CheckGroupV2SetupScript, CheckGroupV2SetupScriptArgs
- Inline
Script string - A valid piece of Node.js code.
- Snippet
Id int - The ID of a code snippet. Code snippets are not available for new plans.
- Inline
Script string - A valid piece of Node.js code.
- Snippet
Id int - The ID of a code snippet. Code snippets are not available for new plans.
- inline
Script String - A valid piece of Node.js code.
- snippet
Id Integer - The ID of a code snippet. Code snippets are not available for new plans.
- inline
Script string - A valid piece of Node.js code.
- snippet
Id number - The ID of a code snippet. Code snippets are not available for new plans.
- inline_
script str - A valid piece of Node.js code.
- snippet_
id int - The ID of a code snippet. Code snippets are not available for new plans.
- inline
Script String - A valid piece of Node.js code.
- snippet
Id Number - The ID of a code snippet. Code snippets are not available for new plans.
CheckGroupV2TeardownScript, CheckGroupV2TeardownScriptArgs
- Inline
Script string - A valid piece of Node.js code.
- Snippet
Id int - The ID of a code snippet. Code snippets are not available for new plans.
- Inline
Script string - A valid piece of Node.js code.
- Snippet
Id int - The ID of a code snippet. Code snippets are not available for new plans.
- inline
Script String - A valid piece of Node.js code.
- snippet
Id Integer - The ID of a code snippet. Code snippets are not available for new plans.
- inline
Script string - A valid piece of Node.js code.
- snippet
Id number - The ID of a code snippet. Code snippets are not available for new plans.
- inline_
script str - A valid piece of Node.js code.
- snippet_
id int - The ID of a code snippet. Code snippets are not available for new plans.
- inline
Script String - A valid piece of Node.js code.
- snippet
Id Number - The ID of a code snippet. Code snippets are not available for new plans.
Package Details
- Repository
- checkly checkly/pulumi-checkly
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
checklyTerraform Provider.
published on Thursday, Mar 19, 2026 by Checkly
