Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Checkly
  3. API Docs
  4. HeartbeatCheck
Checkly v2.2.0 published on Wednesday, Apr 9, 2025 by Checkly
checkly/pulumi-checkly

checkly.HeartbeatCheck

Explore with Pulumi AI

Checkly v2.2.0 published on Wednesday, Apr 9, 2025 by Checkly
checkly/pulumi-checkly

Heartbeats allows you to monitor your cron jobs and set up alerting, so you get a notification when things break or slow down.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as checkly from "@checkly/pulumi";

const example_heartbeat = new checkly.HeartbeatCheck("example-heartbeat", {
    name: "Example heartbeat",
    activated: true,
    heartbeat: {
        period: 7,
        periodUnit: "days",
        grace: 1,
        graceUnit: "days",
    },
    useGlobalAlertSettings: true,
});
Copy
import pulumi
import pulumi_checkly as checkly

example_heartbeat = checkly.HeartbeatCheck("example-heartbeat",
    name="Example heartbeat",
    activated=True,
    heartbeat={
        "period": 7,
        "period_unit": "days",
        "grace": 1,
        "grace_unit": "days",
    },
    use_global_alert_settings=True)
Copy
package main

import (
	"github.com/checkly/pulumi-checkly/sdk/v2/go/checkly"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkly.NewHeartbeatCheck(ctx, "example-heartbeat", &checkly.HeartbeatCheckArgs{
			Name:      pulumi.String("Example heartbeat"),
			Activated: pulumi.Bool(true),
			Heartbeat: &checkly.HeartbeatCheckHeartbeatArgs{
				Period:     pulumi.Int(7),
				PeriodUnit: pulumi.String("days"),
				Grace:      pulumi.Int(1),
				GraceUnit:  pulumi.String("days"),
			},
			UseGlobalAlertSettings: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkly = Pulumi.Checkly;

return await Deployment.RunAsync(() => 
{
    var example_heartbeat = new Checkly.HeartbeatCheck("example-heartbeat", new()
    {
        Name = "Example heartbeat",
        Activated = true,
        Heartbeat = new Checkly.Inputs.HeartbeatCheckHeartbeatArgs
        {
            Period = 7,
            PeriodUnit = "days",
            Grace = 1,
            GraceUnit = "days",
        },
        UseGlobalAlertSettings = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkly.HeartbeatCheck;
import com.pulumi.checkly.HeartbeatCheckArgs;
import com.pulumi.checkly.inputs.HeartbeatCheckHeartbeatArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example_heartbeat = new HeartbeatCheck("example-heartbeat", HeartbeatCheckArgs.builder()
            .name("Example heartbeat")
            .activated(true)
            .heartbeat(HeartbeatCheckHeartbeatArgs.builder()
                .period(7)
                .periodUnit("days")
                .grace(1)
                .graceUnit("days")
                .build())
            .useGlobalAlertSettings(true)
            .build());

    }
}
Copy
resources:
  example-heartbeat:
    type: checkly:HeartbeatCheck
    properties:
      name: Example heartbeat
      activated: true
      heartbeat:
        period: 7
        periodUnit: days
        grace: 1
        graceUnit: days
      useGlobalAlertSettings: true
Copy

Create HeartbeatCheck Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new HeartbeatCheck(name: string, args: HeartbeatCheckArgs, opts?: CustomResourceOptions);
@overload
def HeartbeatCheck(resource_name: str,
                   args: HeartbeatCheckArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def HeartbeatCheck(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   activated: Optional[bool] = None,
                   heartbeat: Optional[HeartbeatCheckHeartbeatArgs] = None,
                   alert_channel_subscriptions: Optional[Sequence[HeartbeatCheckAlertChannelSubscriptionArgs]] = None,
                   alert_settings: Optional[HeartbeatCheckAlertSettingsArgs] = None,
                   muted: Optional[bool] = None,
                   name: Optional[str] = None,
                   tags: Optional[Sequence[str]] = None,
                   use_global_alert_settings: Optional[bool] = None)
func NewHeartbeatCheck(ctx *Context, name string, args HeartbeatCheckArgs, opts ...ResourceOption) (*HeartbeatCheck, error)
public HeartbeatCheck(string name, HeartbeatCheckArgs args, CustomResourceOptions? opts = null)
public HeartbeatCheck(String name, HeartbeatCheckArgs args)
public HeartbeatCheck(String name, HeartbeatCheckArgs args, CustomResourceOptions options)

type: checkly:HeartbeatCheck
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HeartbeatCheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HeartbeatCheckArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HeartbeatCheckArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HeartbeatCheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HeartbeatCheckArgs
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 heartbeatCheckResource = new Checkly.HeartbeatCheck("heartbeatCheckResource", new()
{
    Activated = false,
    Heartbeat = new Checkly.Inputs.HeartbeatCheckHeartbeatArgs
    {
        Grace = 0,
        GraceUnit = "string",
        Period = 0,
        PeriodUnit = "string",
        PingToken = "string",
    },
    AlertChannelSubscriptions = new[]
    {
        new Checkly.Inputs.HeartbeatCheckAlertChannelSubscriptionArgs
        {
            Activated = false,
            ChannelId = 0,
        },
    },
    AlertSettings = new Checkly.Inputs.HeartbeatCheckAlertSettingsArgs
    {
        EscalationType = "string",
        ParallelRunFailureThresholds = new[]
        {
            new Checkly.Inputs.HeartbeatCheckAlertSettingsParallelRunFailureThresholdArgs
            {
                Enabled = false,
                Percentage = 0,
            },
        },
        Reminders = new[]
        {
            new Checkly.Inputs.HeartbeatCheckAlertSettingsReminderArgs
            {
                Amount = 0,
                Interval = 0,
            },
        },
        RunBasedEscalations = new[]
        {
            new Checkly.Inputs.HeartbeatCheckAlertSettingsRunBasedEscalationArgs
            {
                FailedRunThreshold = 0,
            },
        },
        TimeBasedEscalations = new[]
        {
            new Checkly.Inputs.HeartbeatCheckAlertSettingsTimeBasedEscalationArgs
            {
                MinutesFailingThreshold = 0,
            },
        },
    },
    Muted = false,
    Name = "string",
    Tags = new[]
    {
        "string",
    },
    UseGlobalAlertSettings = false,
});
Copy
example, err := checkly.NewHeartbeatCheck(ctx, "heartbeatCheckResource", &checkly.HeartbeatCheckArgs{
	Activated: pulumi.Bool(false),
	Heartbeat: &checkly.HeartbeatCheckHeartbeatArgs{
		Grace:      pulumi.Int(0),
		GraceUnit:  pulumi.String("string"),
		Period:     pulumi.Int(0),
		PeriodUnit: pulumi.String("string"),
		PingToken:  pulumi.String("string"),
	},
	AlertChannelSubscriptions: checkly.HeartbeatCheckAlertChannelSubscriptionArray{
		&checkly.HeartbeatCheckAlertChannelSubscriptionArgs{
			Activated: pulumi.Bool(false),
			ChannelId: pulumi.Int(0),
		},
	},
	AlertSettings: &checkly.HeartbeatCheckAlertSettingsArgs{
		EscalationType: pulumi.String("string"),
		ParallelRunFailureThresholds: checkly.HeartbeatCheckAlertSettingsParallelRunFailureThresholdArray{
			&checkly.HeartbeatCheckAlertSettingsParallelRunFailureThresholdArgs{
				Enabled:    pulumi.Bool(false),
				Percentage: pulumi.Int(0),
			},
		},
		Reminders: checkly.HeartbeatCheckAlertSettingsReminderArray{
			&checkly.HeartbeatCheckAlertSettingsReminderArgs{
				Amount:   pulumi.Int(0),
				Interval: pulumi.Int(0),
			},
		},
		RunBasedEscalations: checkly.HeartbeatCheckAlertSettingsRunBasedEscalationArray{
			&checkly.HeartbeatCheckAlertSettingsRunBasedEscalationArgs{
				FailedRunThreshold: pulumi.Int(0),
			},
		},
		TimeBasedEscalations: checkly.HeartbeatCheckAlertSettingsTimeBasedEscalationArray{
			&checkly.HeartbeatCheckAlertSettingsTimeBasedEscalationArgs{
				MinutesFailingThreshold: pulumi.Int(0),
			},
		},
	},
	Muted: pulumi.Bool(false),
	Name:  pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UseGlobalAlertSettings: pulumi.Bool(false),
})
Copy
var heartbeatCheckResource = new HeartbeatCheck("heartbeatCheckResource", HeartbeatCheckArgs.builder()
    .activated(false)
    .heartbeat(HeartbeatCheckHeartbeatArgs.builder()
        .grace(0)
        .graceUnit("string")
        .period(0)
        .periodUnit("string")
        .pingToken("string")
        .build())
    .alertChannelSubscriptions(HeartbeatCheckAlertChannelSubscriptionArgs.builder()
        .activated(false)
        .channelId(0)
        .build())
    .alertSettings(HeartbeatCheckAlertSettingsArgs.builder()
        .escalationType("string")
        .parallelRunFailureThresholds(HeartbeatCheckAlertSettingsParallelRunFailureThresholdArgs.builder()
            .enabled(false)
            .percentage(0)
            .build())
        .reminders(HeartbeatCheckAlertSettingsReminderArgs.builder()
            .amount(0)
            .interval(0)
            .build())
        .runBasedEscalations(HeartbeatCheckAlertSettingsRunBasedEscalationArgs.builder()
            .failedRunThreshold(0)
            .build())
        .timeBasedEscalations(HeartbeatCheckAlertSettingsTimeBasedEscalationArgs.builder()
            .minutesFailingThreshold(0)
            .build())
        .build())
    .muted(false)
    .name("string")
    .tags("string")
    .useGlobalAlertSettings(false)
    .build());
Copy
heartbeat_check_resource = checkly.HeartbeatCheck("heartbeatCheckResource",
    activated=False,
    heartbeat={
        "grace": 0,
        "grace_unit": "string",
        "period": 0,
        "period_unit": "string",
        "ping_token": "string",
    },
    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,
        }],
    },
    muted=False,
    name="string",
    tags=["string"],
    use_global_alert_settings=False)
Copy
const heartbeatCheckResource = new checkly.HeartbeatCheck("heartbeatCheckResource", {
    activated: false,
    heartbeat: {
        grace: 0,
        graceUnit: "string",
        period: 0,
        periodUnit: "string",
        pingToken: "string",
    },
    alertChannelSubscriptions: [{
        activated: false,
        channelId: 0,
    }],
    alertSettings: {
        escalationType: "string",
        parallelRunFailureThresholds: [{
            enabled: false,
            percentage: 0,
        }],
        reminders: [{
            amount: 0,
            interval: 0,
        }],
        runBasedEscalations: [{
            failedRunThreshold: 0,
        }],
        timeBasedEscalations: [{
            minutesFailingThreshold: 0,
        }],
    },
    muted: false,
    name: "string",
    tags: ["string"],
    useGlobalAlertSettings: false,
});
Copy
type: checkly:HeartbeatCheck
properties:
    activated: false
    alertChannelSubscriptions:
        - activated: false
          channelId: 0
    alertSettings:
        escalationType: string
        parallelRunFailureThresholds:
            - enabled: false
              percentage: 0
        reminders:
            - amount: 0
              interval: 0
        runBasedEscalations:
            - failedRunThreshold: 0
        timeBasedEscalations:
            - minutesFailingThreshold: 0
    heartbeat:
        grace: 0
        graceUnit: string
        period: 0
        periodUnit: string
        pingToken: string
    muted: false
    name: string
    tags:
        - string
    useGlobalAlertSettings: false
Copy

HeartbeatCheck 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 HeartbeatCheck resource accepts the following input properties:

Activated This property is required. bool
Determines if the check is running or not. Possible values true, and false.
Heartbeat This property is required. HeartbeatCheckHeartbeat
AlertChannelSubscriptions List<HeartbeatCheckAlertChannelSubscription>
AlertSettings HeartbeatCheckAlertSettings
Muted bool
Determines if any notifications will be sent out when a check fails/degrades/recovers.
Name string
The name of the check.
Tags List<string>
A list of tags for organizing and filtering checks.
UseGlobalAlertSettings bool
When true, the account level alert settings will be used, not the alert setting defined on this check.
Activated This property is required. bool
Determines if the check is running or not. Possible values true, and false.
Heartbeat This property is required. HeartbeatCheckHeartbeatArgs
AlertChannelSubscriptions []HeartbeatCheckAlertChannelSubscriptionArgs
AlertSettings HeartbeatCheckAlertSettingsArgs
Muted bool
Determines if any notifications will be sent out when a check fails/degrades/recovers.
Name string
The name of the check.
Tags []string
A list of tags for organizing and filtering checks.
UseGlobalAlertSettings bool
When true, the account level alert settings will be used, not the alert setting defined on this check.
activated This property is required. Boolean
Determines if the check is running or not. Possible values true, and false.
heartbeat This property is required. HeartbeatCheckHeartbeat
alertChannelSubscriptions List<HeartbeatCheckAlertChannelSubscription>
alertSettings HeartbeatCheckAlertSettings
muted Boolean
Determines if any notifications will be sent out when a check fails/degrades/recovers.
name String
The name of the check.
tags List<String>
A list of tags for organizing and filtering checks.
useGlobalAlertSettings Boolean
When true, the account level alert settings will be used, not the alert setting defined on this check.
activated This property is required. boolean
Determines if the check is running or not. Possible values true, and false.
heartbeat This property is required. HeartbeatCheckHeartbeat
alertChannelSubscriptions HeartbeatCheckAlertChannelSubscription[]
alertSettings HeartbeatCheckAlertSettings
muted boolean
Determines if any notifications will be sent out when a check fails/degrades/recovers.
name string
The name of the check.
tags string[]
A list of tags for organizing and filtering checks.
useGlobalAlertSettings boolean
When true, the account level alert settings will be used, not the alert setting defined on this check.
activated This property is required. bool
Determines if the check is running or not. Possible values true, and false.
heartbeat This property is required. HeartbeatCheckHeartbeatArgs
alert_channel_subscriptions Sequence[HeartbeatCheckAlertChannelSubscriptionArgs]
alert_settings HeartbeatCheckAlertSettingsArgs
muted bool
Determines if any notifications will be sent out when a check fails/degrades/recovers.
name str
The name of the check.
tags Sequence[str]
A list of tags for organizing and filtering checks.
use_global_alert_settings bool
When true, the account level alert settings will be used, not the alert setting defined on this check.
activated This property is required. Boolean
Determines if the check is running or not. Possible values true, and false.
heartbeat This property is required. Property Map
alertChannelSubscriptions List<Property Map>
alertSettings Property Map
muted Boolean
Determines if any notifications will be sent out when a check fails/degrades/recovers.
name String
The name of the check.
tags List<String>
A list of tags for organizing and filtering checks.
useGlobalAlertSettings Boolean
When true, the account level alert settings will be used, not the alert setting defined on this check.

Outputs

All input properties are implicitly available as output properties. Additionally, the HeartbeatCheck 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 HeartbeatCheck Resource

Get an existing HeartbeatCheck 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?: HeartbeatCheckState, opts?: CustomResourceOptions): HeartbeatCheck
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activated: Optional[bool] = None,
        alert_channel_subscriptions: Optional[Sequence[HeartbeatCheckAlertChannelSubscriptionArgs]] = None,
        alert_settings: Optional[HeartbeatCheckAlertSettingsArgs] = None,
        heartbeat: Optional[HeartbeatCheckHeartbeatArgs] = None,
        muted: Optional[bool] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        use_global_alert_settings: Optional[bool] = None) -> HeartbeatCheck
func GetHeartbeatCheck(ctx *Context, name string, id IDInput, state *HeartbeatCheckState, opts ...ResourceOption) (*HeartbeatCheck, error)
public static HeartbeatCheck Get(string name, Input<string> id, HeartbeatCheckState? state, CustomResourceOptions? opts = null)
public static HeartbeatCheck get(String name, Output<String> id, HeartbeatCheckState state, CustomResourceOptions options)
resources:  _:    type: checkly:HeartbeatCheck    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
Activated bool
Determines if the check is running or not. Possible values true, and false.
AlertChannelSubscriptions List<HeartbeatCheckAlertChannelSubscription>
AlertSettings HeartbeatCheckAlertSettings
Heartbeat HeartbeatCheckHeartbeat
Muted bool
Determines if any notifications will be sent out when a check fails/degrades/recovers.
Name string
The name of the check.
Tags List<string>
A list of tags for organizing and filtering checks.
UseGlobalAlertSettings bool
When true, the account level alert settings will be used, not the alert setting defined on this check.
Activated bool
Determines if the check is running or not. Possible values true, and false.
AlertChannelSubscriptions []HeartbeatCheckAlertChannelSubscriptionArgs
AlertSettings HeartbeatCheckAlertSettingsArgs
Heartbeat HeartbeatCheckHeartbeatArgs
Muted bool
Determines if any notifications will be sent out when a check fails/degrades/recovers.
Name string
The name of the check.
Tags []string
A list of tags for organizing and filtering checks.
UseGlobalAlertSettings bool
When true, the account level alert settings will be used, not the alert setting defined on this check.
activated Boolean
Determines if the check is running or not. Possible values true, and false.
alertChannelSubscriptions List<HeartbeatCheckAlertChannelSubscription>
alertSettings HeartbeatCheckAlertSettings
heartbeat HeartbeatCheckHeartbeat
muted Boolean
Determines if any notifications will be sent out when a check fails/degrades/recovers.
name String
The name of the check.
tags List<String>
A list of tags for organizing and filtering checks.
useGlobalAlertSettings Boolean
When true, the account level alert settings will be used, not the alert setting defined on this check.
activated boolean
Determines if the check is running or not. Possible values true, and false.
alertChannelSubscriptions HeartbeatCheckAlertChannelSubscription[]
alertSettings HeartbeatCheckAlertSettings
heartbeat HeartbeatCheckHeartbeat
muted boolean
Determines if any notifications will be sent out when a check fails/degrades/recovers.
name string
The name of the check.
tags string[]
A list of tags for organizing and filtering checks.
useGlobalAlertSettings boolean
When true, the account level alert settings will be used, not the alert setting defined on this check.
activated bool
Determines if the check is running or not. Possible values true, and false.
alert_channel_subscriptions Sequence[HeartbeatCheckAlertChannelSubscriptionArgs]
alert_settings HeartbeatCheckAlertSettingsArgs
heartbeat HeartbeatCheckHeartbeatArgs
muted bool
Determines if any notifications will be sent out when a check fails/degrades/recovers.
name str
The name of the check.
tags Sequence[str]
A list of tags for organizing and filtering checks.
use_global_alert_settings bool
When true, the account level alert settings will be used, not the alert setting defined on this check.
activated Boolean
Determines if the check is running or not. Possible values true, and false.
alertChannelSubscriptions List<Property Map>
alertSettings Property Map
heartbeat Property Map
muted Boolean
Determines if any notifications will be sent out when a check fails/degrades/recovers.
name String
The name of the check.
tags List<String>
A list of tags for organizing and filtering checks.
useGlobalAlertSettings Boolean
When true, the account level alert settings will be used, not the alert setting defined on this check.

Supporting Types

HeartbeatCheckAlertChannelSubscription
, HeartbeatCheckAlertChannelSubscriptionArgs

Activated This property is required. bool
ChannelId This property is required. int
Activated This property is required. bool
ChannelId This property is required. int
activated This property is required. Boolean
channelId This property is required. Integer
activated This property is required. boolean
channelId This property is required. number
activated This property is required. bool
channel_id This property is required. int
activated This property is required. Boolean
channelId This property is required. Number

HeartbeatCheckAlertSettings
, HeartbeatCheckAlertSettingsArgs

escalationType String
Determines what type of escalation to use. Possible values are RUN_BASED or TIME_BASED.
parallelRunFailureThresholds List<Property Map>
reminders List<Property Map>
runBasedEscalations List<Property Map>
sslCertificates List<Property Map>

Deprecated: This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

timeBasedEscalations List<Property Map>

HeartbeatCheckAlertSettingsParallelRunFailureThreshold
, HeartbeatCheckAlertSettingsParallelRunFailureThresholdArgs

Enabled bool
Applicable only for checks scheduled in parallel in multiple locations.
Percentage int
Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).
Enabled bool
Applicable only for checks scheduled in parallel in multiple locations.
Percentage int
Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).
enabled Boolean
Applicable only for checks scheduled in parallel in multiple locations.
percentage Integer
Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).
enabled boolean
Applicable only for checks scheduled in parallel in multiple locations.
percentage number
Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).
enabled bool
Applicable only for checks scheduled in parallel in multiple locations.
percentage int
Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).
enabled Boolean
Applicable only for checks scheduled in parallel in multiple locations.
percentage Number
Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).

HeartbeatCheckAlertSettingsReminder
, HeartbeatCheckAlertSettingsReminderArgs

Amount int
How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
Interval int
Possible values are 5, 10, 15, and 30. (Default 5).
Amount int
How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
Interval int
Possible values are 5, 10, 15, and 30. (Default 5).
amount Integer
How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
interval Integer
Possible values are 5, 10, 15, and 30. (Default 5).
amount number
How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
interval number
Possible values are 5, 10, 15, and 30. (Default 5).
amount int
How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
interval int
Possible values are 5, 10, 15, and 30. (Default 5).
amount Number
How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
interval Number
Possible values are 5, 10, 15, and 30. (Default 5).

HeartbeatCheckAlertSettingsRunBasedEscalation
, HeartbeatCheckAlertSettingsRunBasedEscalationArgs

FailedRunThreshold int
After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).
FailedRunThreshold int
After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).
failedRunThreshold Integer
After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).
failedRunThreshold number
After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).
failed_run_threshold int
After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).
failedRunThreshold Number
After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).

HeartbeatCheckAlertSettingsSslCertificate
, HeartbeatCheckAlertSettingsSslCertificateArgs

AlertThreshold int
How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
Enabled bool
Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).
AlertThreshold int
How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
Enabled bool
Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).
alertThreshold Integer
How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
enabled Boolean
Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).
alertThreshold number
How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
enabled boolean
Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).
alert_threshold int
How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
enabled bool
Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).
alertThreshold Number
How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
enabled Boolean
Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).

HeartbeatCheckAlertSettingsTimeBasedEscalation
, HeartbeatCheckAlertSettingsTimeBasedEscalationArgs

MinutesFailingThreshold int
After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).
MinutesFailingThreshold int
After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).
minutesFailingThreshold Integer
After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).
minutesFailingThreshold number
After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).
minutes_failing_threshold int
After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).
minutesFailingThreshold Number
After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).

HeartbeatCheckHeartbeat
, HeartbeatCheckHeartbeatArgs

Grace This property is required. int
How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
GraceUnit This property is required. string
Possible values seconds, minutes, hours and days.
Period This property is required. int
How often you expect a ping to the ping URL.
PeriodUnit This property is required. string
Possible values seconds, minutes, hours and days.
PingToken string
Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].
Grace This property is required. int
How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
GraceUnit This property is required. string
Possible values seconds, minutes, hours and days.
Period This property is required. int
How often you expect a ping to the ping URL.
PeriodUnit This property is required. string
Possible values seconds, minutes, hours and days.
PingToken string
Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].
grace This property is required. Integer
How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
graceUnit This property is required. String
Possible values seconds, minutes, hours and days.
period This property is required. Integer
How often you expect a ping to the ping URL.
periodUnit This property is required. String
Possible values seconds, minutes, hours and days.
pingToken String
Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].
grace This property is required. number
How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
graceUnit This property is required. string
Possible values seconds, minutes, hours and days.
period This property is required. number
How often you expect a ping to the ping URL.
periodUnit This property is required. string
Possible values seconds, minutes, hours and days.
pingToken string
Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].
grace This property is required. int
How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
grace_unit This property is required. str
Possible values seconds, minutes, hours and days.
period This property is required. int
How often you expect a ping to the ping URL.
period_unit This property is required. str
Possible values seconds, minutes, hours and days.
ping_token str
Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].
grace This property is required. Number
How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
graceUnit This property is required. String
Possible values seconds, minutes, hours and days.
period This property is required. Number
How often you expect a ping to the ping URL.
periodUnit This property is required. String
Possible values seconds, minutes, hours and days.
pingToken String
Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].

Package Details

Repository
checkly checkly/pulumi-checkly
License
Apache-2.0
Notes
This Pulumi package is based on the checkly Terraform Provider.
Checkly v2.2.0 published on Wednesday, Apr 9, 2025 by Checkly
checkly/pulumi-checkly