1. Packages
  2. Checkly
  3. API Docs
  4. CheckGroup
Checkly v2.7.0 published on Tuesday, Nov 4, 2025 by Checkly
checkly/pulumi-checkly

checkly.CheckGroup

Start a Neo task
Explain and create a checkly.CheckGroup resource
checkly logo
Checkly v2.7.0 published on Tuesday, Nov 4, 2025 by Checkly
checkly/pulumi-checkly

    Check groups allow you to group together a set of related checks, which can also share default settings for various attributes.

    Create CheckGroup Resource

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

    Constructor syntax

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

@overload
def CheckGroup(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               concurrency: Optional[int] = None,
               activated: Optional[bool] = None,
               locations: Optional[Sequence[str]] = None,
               muted: Optional[bool] = None,
               alert_settings: Optional[CheckGroupAlertSettingsArgs] = None,
               double_check: Optional[bool] = None,
               environment_variable: Optional[Sequence[CheckGroupEnvironmentVariableArgs]] = None,
               environment_variables: Optional[Mapping[str, str]] = None,
               local_setup_script: Optional[str] = None,
               local_teardown_script: Optional[str] = None,
               alert_channel_subscriptions: Optional[Sequence[CheckGroupAlertChannelSubscriptionArgs]] = None,
               api_check_defaults: Optional[CheckGroupApiCheckDefaultsArgs] = None,
               name: Optional[str] = None,
               private_locations: Optional[Sequence[str]] = None,
               retry_strategy: Optional[CheckGroupRetryStrategyArgs] = None,
               run_parallel: Optional[bool] = None,
               runtime_id: Optional[str] = None,
               setup_snippet_id: Optional[int] = None,
               tags: Optional[Sequence[str]] = None,
               teardown_snippet_id: Optional[int] = None,
               use_global_alert_settings: Optional[bool] = None)
    func NewCheckGroup(ctx *Context, name string, args CheckGroupArgs, opts ...ResourceOption) (*CheckGroup, error)
    public CheckGroup(string name, CheckGroupArgs args, CustomResourceOptions? opts = null)
    public CheckGroup(String name, CheckGroupArgs args)
public CheckGroup(String name, CheckGroupArgs args, CustomResourceOptions options)

    type: checkly:CheckGroup
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 CheckGroupArgs
    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 CheckGroupArgs
    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 CheckGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CheckGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CheckGroupArgs
    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 checkGroupResource = new Checkly.CheckGroup("checkGroupResource", new()
{
    Concurrency = 0,
    Activated = false,
    Locations = new[]
    {
        "string",
    },
    Muted = false,
    AlertSettings = new Checkly.Inputs.CheckGroupAlertSettingsArgs
    {
        EscalationType = "string",
        ParallelRunFailureThresholds = new[]
        {
            new Checkly.Inputs.CheckGroupAlertSettingsParallelRunFailureThresholdArgs
            {
                Enabled = false,
                Percentage = 0,
            },
        },
        Reminders = new[]
        {
            new Checkly.Inputs.CheckGroupAlertSettingsReminderArgs
            {
                Amount = 0,
                Interval = 0,
            },
        },
        RunBasedEscalations = new[]
        {
            new Checkly.Inputs.CheckGroupAlertSettingsRunBasedEscalationArgs
            {
                FailedRunThreshold = 0,
            },
        },
        TimeBasedEscalations = new[]
        {
            new Checkly.Inputs.CheckGroupAlertSettingsTimeBasedEscalationArgs
            {
                MinutesFailingThreshold = 0,
            },
        },
    },
    EnvironmentVariable = new[]
    {
        new Checkly.Inputs.CheckGroupEnvironmentVariableArgs
        {
            Key = "string",
            Value = "string",
            Locked = false,
            Secret = false,
        },
    },
    LocalSetupScript = "string",
    LocalTeardownScript = "string",
    AlertChannelSubscriptions = new[]
    {
        new Checkly.Inputs.CheckGroupAlertChannelSubscriptionArgs
        {
            Activated = false,
            ChannelId = 0,
        },
    },
    ApiCheckDefaults = new Checkly.Inputs.CheckGroupApiCheckDefaultsArgs
    {
        Assertions = new[]
        {
            new Checkly.Inputs.CheckGroupApiCheckDefaultsAssertionArgs
            {
                Comparison = "string",
                Source = "string",
                Target = "string",
                Property = "string",
            },
        },
        BasicAuth = new Checkly.Inputs.CheckGroupApiCheckDefaultsBasicAuthArgs
        {
            Password = "string",
            Username = "string",
        },
        Headers = 
        {
            { "string", "string" },
        },
        QueryParameters = 
        {
            { "string", "string" },
        },
        Url = "string",
    },
    Name = "string",
    PrivateLocations = new[]
    {
        "string",
    },
    RetryStrategy = new Checkly.Inputs.CheckGroupRetryStrategyArgs
    {
        Type = "string",
        BaseBackoffSeconds = 0,
        MaxDurationSeconds = 0,
        MaxRetries = 0,
        OnlyOn = new Checkly.Inputs.CheckGroupRetryStrategyOnlyOnArgs
        {
            NetworkError = false,
        },
        SameRegion = false,
    },
    RunParallel = false,
    RuntimeId = "string",
    SetupSnippetId = 0,
    Tags = new[]
    {
        "string",
    },
    TeardownSnippetId = 0,
    UseGlobalAlertSettings = false,
});

    example, err := checkly.NewCheckGroup(ctx, "checkGroupResource", &checkly.CheckGroupArgs{
	Concurrency: pulumi.Int(0),
	Activated:   pulumi.Bool(false),
	Locations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Muted: pulumi.Bool(false),
	AlertSettings: &checkly.CheckGroupAlertSettingsArgs{
		EscalationType: pulumi.String("string"),
		ParallelRunFailureThresholds: checkly.CheckGroupAlertSettingsParallelRunFailureThresholdArray{
			&checkly.CheckGroupAlertSettingsParallelRunFailureThresholdArgs{
				Enabled:    pulumi.Bool(false),
				Percentage: pulumi.Int(0),
			},
		},
		Reminders: checkly.CheckGroupAlertSettingsReminderArray{
			&checkly.CheckGroupAlertSettingsReminderArgs{
				Amount:   pulumi.Int(0),
				Interval: pulumi.Int(0),
			},
		},
		RunBasedEscalations: checkly.CheckGroupAlertSettingsRunBasedEscalationArray{
			&checkly.CheckGroupAlertSettingsRunBasedEscalationArgs{
				FailedRunThreshold: pulumi.Int(0),
			},
		},
		TimeBasedEscalations: checkly.CheckGroupAlertSettingsTimeBasedEscalationArray{
			&checkly.CheckGroupAlertSettingsTimeBasedEscalationArgs{
				MinutesFailingThreshold: pulumi.Int(0),
			},
		},
	},
	EnvironmentVariable: checkly.CheckGroupEnvironmentVariableArray{
		&checkly.CheckGroupEnvironmentVariableArgs{
			Key:    pulumi.String("string"),
			Value:  pulumi.String("string"),
			Locked: pulumi.Bool(false),
			Secret: pulumi.Bool(false),
		},
	},
	LocalSetupScript:    pulumi.String("string"),
	LocalTeardownScript: pulumi.String("string"),
	AlertChannelSubscriptions: checkly.CheckGroupAlertChannelSubscriptionArray{
		&checkly.CheckGroupAlertChannelSubscriptionArgs{
			Activated: pulumi.Bool(false),
			ChannelId: pulumi.Int(0),
		},
	},
	ApiCheckDefaults: &checkly.CheckGroupApiCheckDefaultsArgs{
		Assertions: checkly.CheckGroupApiCheckDefaultsAssertionArray{
			&checkly.CheckGroupApiCheckDefaultsAssertionArgs{
				Comparison: pulumi.String("string"),
				Source:     pulumi.String("string"),
				Target:     pulumi.String("string"),
				Property:   pulumi.String("string"),
			},
		},
		BasicAuth: &checkly.CheckGroupApiCheckDefaultsBasicAuthArgs{
			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"),
	},
	Name: pulumi.String("string"),
	PrivateLocations: pulumi.StringArray{
		pulumi.String("string"),
	},
	RetryStrategy: &checkly.CheckGroupRetryStrategyArgs{
		Type:               pulumi.String("string"),
		BaseBackoffSeconds: pulumi.Int(0),
		MaxDurationSeconds: pulumi.Int(0),
		MaxRetries:         pulumi.Int(0),
		OnlyOn: &checkly.CheckGroupRetryStrategyOnlyOnArgs{
			NetworkError: pulumi.Bool(false),
		},
		SameRegion: pulumi.Bool(false),
	},
	RunParallel:    pulumi.Bool(false),
	RuntimeId:      pulumi.String("string"),
	SetupSnippetId: pulumi.Int(0),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TeardownSnippetId:      pulumi.Int(0),
	UseGlobalAlertSettings: pulumi.Bool(false),
})

    var checkGroupResource = new CheckGroup("checkGroupResource", CheckGroupArgs.builder()
    .concurrency(0)
    .activated(false)
    .locations("string")
    .muted(false)
    .alertSettings(CheckGroupAlertSettingsArgs.builder()
        .escalationType("string")
        .parallelRunFailureThresholds(CheckGroupAlertSettingsParallelRunFailureThresholdArgs.builder()
            .enabled(false)
            .percentage(0)
            .build())
        .reminders(CheckGroupAlertSettingsReminderArgs.builder()
            .amount(0)
            .interval(0)
            .build())
        .runBasedEscalations(CheckGroupAlertSettingsRunBasedEscalationArgs.builder()
            .failedRunThreshold(0)
            .build())
        .timeBasedEscalations(CheckGroupAlertSettingsTimeBasedEscalationArgs.builder()
            .minutesFailingThreshold(0)
            .build())
        .build())
    .environmentVariable(CheckGroupEnvironmentVariableArgs.builder()
        .key("string")
        .value("string")
        .locked(false)
        .secret(false)
        .build())
    .localSetupScript("string")
    .localTeardownScript("string")
    .alertChannelSubscriptions(CheckGroupAlertChannelSubscriptionArgs.builder()
        .activated(false)
        .channelId(0)
        .build())
    .apiCheckDefaults(CheckGroupApiCheckDefaultsArgs.builder()
        .assertions(CheckGroupApiCheckDefaultsAssertionArgs.builder()
            .comparison("string")
            .source("string")
            .target("string")
            .property("string")
            .build())
        .basicAuth(CheckGroupApiCheckDefaultsBasicAuthArgs.builder()
            .password("string")
            .username("string")
            .build())
        .headers(Map.of("string", "string"))
        .queryParameters(Map.of("string", "string"))
        .url("string")
        .build())
    .name("string")
    .privateLocations("string")
    .retryStrategy(CheckGroupRetryStrategyArgs.builder()
        .type("string")
        .baseBackoffSeconds(0)
        .maxDurationSeconds(0)
        .maxRetries(0)
        .onlyOn(CheckGroupRetryStrategyOnlyOnArgs.builder()
            .networkError(false)
            .build())
        .sameRegion(false)
        .build())
    .runParallel(false)
    .runtimeId("string")
    .setupSnippetId(0)
    .tags("string")
    .teardownSnippetId(0)
    .useGlobalAlertSettings(false)
    .build());

    check_group_resource = checkly.CheckGroup("checkGroupResource",
    concurrency=0,
    activated=False,
    locations=["string"],
    muted=False,
    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,
        }],
    },
    environment_variable=[{
        "key": "string",
        "value": "string",
        "locked": False,
        "secret": False,
    }],
    local_setup_script="string",
    local_teardown_script="string",
    alert_channel_subscriptions=[{
        "activated": False,
        "channel_id": 0,
    }],
    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",
    },
    name="string",
    private_locations=["string"],
    retry_strategy={
        "type": "string",
        "base_backoff_seconds": 0,
        "max_duration_seconds": 0,
        "max_retries": 0,
        "only_on": {
            "network_error": False,
        },
        "same_region": False,
    },
    run_parallel=False,
    runtime_id="string",
    setup_snippet_id=0,
    tags=["string"],
    teardown_snippet_id=0,
    use_global_alert_settings=False)

    const checkGroupResource = new checkly.CheckGroup("checkGroupResource", {
    concurrency: 0,
    activated: false,
    locations: ["string"],
    muted: false,
    alertSettings: {
        escalationType: "string",
        parallelRunFailureThresholds: [{
            enabled: false,
            percentage: 0,
        }],
        reminders: [{
            amount: 0,
            interval: 0,
        }],
        runBasedEscalations: [{
            failedRunThreshold: 0,
        }],
        timeBasedEscalations: [{
            minutesFailingThreshold: 0,
        }],
    },
    environmentVariable: [{
        key: "string",
        value: "string",
        locked: false,
        secret: false,
    }],
    localSetupScript: "string",
    localTeardownScript: "string",
    alertChannelSubscriptions: [{
        activated: false,
        channelId: 0,
    }],
    apiCheckDefaults: {
        assertions: [{
            comparison: "string",
            source: "string",
            target: "string",
            property: "string",
        }],
        basicAuth: {
            password: "string",
            username: "string",
        },
        headers: {
            string: "string",
        },
        queryParameters: {
            string: "string",
        },
        url: "string",
    },
    name: "string",
    privateLocations: ["string"],
    retryStrategy: {
        type: "string",
        baseBackoffSeconds: 0,
        maxDurationSeconds: 0,
        maxRetries: 0,
        onlyOn: {
            networkError: false,
        },
        sameRegion: false,
    },
    runParallel: false,
    runtimeId: "string",
    setupSnippetId: 0,
    tags: ["string"],
    teardownSnippetId: 0,
    useGlobalAlertSettings: false,
});

    type: checkly:CheckGroup
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
    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
    environmentVariable:
        - key: string
          locked: false
          secret: false
          value: string
    localSetupScript: string
    localTeardownScript: string
    locations:
        - string
    muted: false
    name: string
    privateLocations:
        - string
    retryStrategy:
        baseBackoffSeconds: 0
        maxDurationSeconds: 0
        maxRetries: 0
        onlyOn:
            networkError: false
        sameRegion: false
        type: string
    runParallel: false
    runtimeId: string
    setupSnippetId: 0
    tags:
        - string
    teardownSnippetId: 0
    useGlobalAlertSettings: false

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

    Activated bool
    Determines if the checks in the group are running or not.
    Concurrency int
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    AlertChannelSubscriptions List<CheckGroupAlertChannelSubscription>
    AlertSettings CheckGroupAlertSettings
    Determines the alert escalation policy for the check.
    ApiCheckDefaults CheckGroupApiCheckDefaults
    DoubleCheck bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    EnvironmentVariable List<CheckGroupEnvironmentVariable>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    EnvironmentVariables Dictionary<string, string>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    LocalSetupScript string
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    LocalTeardownScript string
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    Locations List<string>
    An array of one or more data center locations where to run the checks.
    Muted bool
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    Name string
    The name of the check group.
    PrivateLocations List<string>
    An array of one or more private locations slugs.
    RetryStrategy CheckGroupRetryStrategy
    A strategy for retrying failed check/monitor runs.
    RunParallel bool
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    RuntimeId string
    The id of the runtime to use for this group.
    SetupSnippetId int
    An ID reference to a snippet to use in the setup phase of an API check.
    Tags List<string>
    Tags for organizing and filtering checks.
    TeardownSnippetId int
    An ID reference to a snippet to use in the teardown phase of an API check.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check group.
    Activated bool
    Determines if the checks in the group are running or not.
    Concurrency int
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    AlertChannelSubscriptions []CheckGroupAlertChannelSubscriptionArgs
    AlertSettings CheckGroupAlertSettingsArgs
    Determines the alert escalation policy for the check.
    ApiCheckDefaults CheckGroupApiCheckDefaultsArgs
    DoubleCheck bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    EnvironmentVariable []CheckGroupEnvironmentVariableArgs
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    EnvironmentVariables map[string]string
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    LocalSetupScript string
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    LocalTeardownScript string
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    Locations []string
    An array of one or more data center locations where to run the checks.
    Muted bool
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    Name string
    The name of the check group.
    PrivateLocations []string
    An array of one or more private locations slugs.
    RetryStrategy CheckGroupRetryStrategyArgs
    A strategy for retrying failed check/monitor runs.
    RunParallel bool
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    RuntimeId string
    The id of the runtime to use for this group.
    SetupSnippetId int
    An ID reference to a snippet to use in the setup phase of an API check.
    Tags []string
    Tags for organizing and filtering checks.
    TeardownSnippetId int
    An ID reference to a snippet to use in the teardown phase of an API check.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check group.
    activated Boolean
    Determines if the checks in the group are running or not.
    concurrency Integer
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    alertChannelSubscriptions List<CheckGroupAlertChannelSubscription>
    alertSettings CheckGroupAlertSettings
    Determines the alert escalation policy for the check.
    apiCheckDefaults CheckGroupApiCheckDefaults
    doubleCheck Boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable List<CheckGroupEnvironmentVariable>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables Map<String,String>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    localSetupScript String
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    localTeardownScript String
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    locations List<String>
    An array of one or more data center locations where to run the checks.
    muted Boolean
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    name String
    The name of the check group.
    privateLocations List<String>
    An array of one or more private locations slugs.
    retryStrategy CheckGroupRetryStrategy
    A strategy for retrying failed check/monitor runs.
    runParallel Boolean
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    runtimeId String
    The id of the runtime to use for this group.
    setupSnippetId Integer
    An ID reference to a snippet to use in the setup phase of an API check.
    tags List<String>
    Tags for organizing and filtering checks.
    teardownSnippetId Integer
    An ID reference to a snippet to use in the teardown phase of an API check.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check group.
    activated boolean
    Determines if the checks in the group are running or not.
    concurrency number
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    alertChannelSubscriptions CheckGroupAlertChannelSubscription[]
    alertSettings CheckGroupAlertSettings
    Determines the alert escalation policy for the check.
    apiCheckDefaults CheckGroupApiCheckDefaults
    doubleCheck boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable CheckGroupEnvironmentVariable[]
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables {[key: string]: string}
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    localSetupScript string
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    localTeardownScript string
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    locations string[]
    An array of one or more data center locations where to run the checks.
    muted boolean
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    name string
    The name of the check group.
    privateLocations string[]
    An array of one or more private locations slugs.
    retryStrategy CheckGroupRetryStrategy
    A strategy for retrying failed check/monitor runs.
    runParallel boolean
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    runtimeId string
    The id of the runtime to use for this group.
    setupSnippetId number
    An ID reference to a snippet to use in the setup phase of an API check.
    tags string[]
    Tags for organizing and filtering checks.
    teardownSnippetId number
    An ID reference to a snippet to use in the teardown phase of an API check.
    useGlobalAlertSettings boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check group.
    activated bool
    Determines if the checks in the group are running or not.
    concurrency int
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    alert_channel_subscriptions Sequence[CheckGroupAlertChannelSubscriptionArgs]
    alert_settings CheckGroupAlertSettingsArgs
    Determines the alert escalation policy for the check.
    api_check_defaults CheckGroupApiCheckDefaultsArgs
    double_check bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environment_variable Sequence[CheckGroupEnvironmentVariableArgs]
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environment_variables Mapping[str, str]
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    local_setup_script str
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    local_teardown_script str
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    locations Sequence[str]
    An array of one or more data center locations where to run the checks.
    muted bool
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    name str
    The name of the check group.
    private_locations Sequence[str]
    An array of one or more private locations slugs.
    retry_strategy CheckGroupRetryStrategyArgs
    A strategy for retrying failed check/monitor runs.
    run_parallel bool
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    runtime_id str
    The id of the runtime to use for this group.
    setup_snippet_id int
    An ID reference to a snippet to use in the setup phase of an API check.
    tags Sequence[str]
    Tags for organizing and filtering checks.
    teardown_snippet_id int
    An ID reference to a snippet to use in the teardown phase of an API check.
    use_global_alert_settings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check group.
    activated Boolean
    Determines if the checks in the group are running or not.
    concurrency Number
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    alertChannelSubscriptions List<Property Map>
    alertSettings Property Map
    Determines the alert escalation policy for the check.
    apiCheckDefaults Property Map
    doubleCheck Boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable List<Property Map>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables Map<String>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    localSetupScript String
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    localTeardownScript String
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    locations List<String>
    An array of one or more data center locations where to run the checks.
    muted Boolean
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    name String
    The name of the check group.
    privateLocations List<String>
    An array of one or more private locations slugs.
    retryStrategy Property Map
    A strategy for retrying failed check/monitor runs.
    runParallel Boolean
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    runtimeId String
    The id of the runtime to use for this group.
    setupSnippetId Number
    An ID reference to a snippet to use in the setup phase of an API check.
    tags List<String>
    Tags for organizing and filtering checks.
    teardownSnippetId Number
    An ID reference to a snippet to use in the teardown phase of an API check.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check group.

    Outputs

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

    Get an existing CheckGroup 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?: CheckGroupState, opts?: CustomResourceOptions): CheckGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activated: Optional[bool] = None,
        alert_channel_subscriptions: Optional[Sequence[CheckGroupAlertChannelSubscriptionArgs]] = None,
        alert_settings: Optional[CheckGroupAlertSettingsArgs] = None,
        api_check_defaults: Optional[CheckGroupApiCheckDefaultsArgs] = None,
        concurrency: Optional[int] = None,
        double_check: Optional[bool] = None,
        environment_variable: Optional[Sequence[CheckGroupEnvironmentVariableArgs]] = None,
        environment_variables: Optional[Mapping[str, str]] = None,
        local_setup_script: Optional[str] = None,
        local_teardown_script: Optional[str] = None,
        locations: Optional[Sequence[str]] = None,
        muted: Optional[bool] = None,
        name: Optional[str] = None,
        private_locations: Optional[Sequence[str]] = None,
        retry_strategy: Optional[CheckGroupRetryStrategyArgs] = None,
        run_parallel: Optional[bool] = None,
        runtime_id: Optional[str] = None,
        setup_snippet_id: Optional[int] = None,
        tags: Optional[Sequence[str]] = None,
        teardown_snippet_id: Optional[int] = None,
        use_global_alert_settings: Optional[bool] = None) -> CheckGroup
    func GetCheckGroup(ctx *Context, name string, id IDInput, state *CheckGroupState, opts ...ResourceOption) (*CheckGroup, error)
    public static CheckGroup Get(string name, Input<string> id, CheckGroupState? state, CustomResourceOptions? opts = null)
    public static CheckGroup get(String name, Output<String> id, CheckGroupState state, CustomResourceOptions options)
    resources:  _:    type: checkly:CheckGroup    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.
    The following state arguments are supported:
    Activated bool
    Determines if the checks in the group are running or not.
    AlertChannelSubscriptions List<CheckGroupAlertChannelSubscription>
    AlertSettings CheckGroupAlertSettings
    Determines the alert escalation policy for the check.
    ApiCheckDefaults CheckGroupApiCheckDefaults
    Concurrency int
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    DoubleCheck bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    EnvironmentVariable List<CheckGroupEnvironmentVariable>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    EnvironmentVariables Dictionary<string, string>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    LocalSetupScript string
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    LocalTeardownScript string
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    Locations List<string>
    An array of one or more data center locations where to run the checks.
    Muted bool
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    Name string
    The name of the check group.
    PrivateLocations List<string>
    An array of one or more private locations slugs.
    RetryStrategy CheckGroupRetryStrategy
    A strategy for retrying failed check/monitor runs.
    RunParallel bool
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    RuntimeId string
    The id of the runtime to use for this group.
    SetupSnippetId int
    An ID reference to a snippet to use in the setup phase of an API check.
    Tags List<string>
    Tags for organizing and filtering checks.
    TeardownSnippetId int
    An ID reference to a snippet to use in the teardown phase of an API check.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check group.
    Activated bool
    Determines if the checks in the group are running or not.
    AlertChannelSubscriptions []CheckGroupAlertChannelSubscriptionArgs
    AlertSettings CheckGroupAlertSettingsArgs
    Determines the alert escalation policy for the check.
    ApiCheckDefaults CheckGroupApiCheckDefaultsArgs
    Concurrency int
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    DoubleCheck bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    EnvironmentVariable []CheckGroupEnvironmentVariableArgs
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    EnvironmentVariables map[string]string
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    LocalSetupScript string
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    LocalTeardownScript string
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    Locations []string
    An array of one or more data center locations where to run the checks.
    Muted bool
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    Name string
    The name of the check group.
    PrivateLocations []string
    An array of one or more private locations slugs.
    RetryStrategy CheckGroupRetryStrategyArgs
    A strategy for retrying failed check/monitor runs.
    RunParallel bool
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    RuntimeId string
    The id of the runtime to use for this group.
    SetupSnippetId int
    An ID reference to a snippet to use in the setup phase of an API check.
    Tags []string
    Tags for organizing and filtering checks.
    TeardownSnippetId int
    An ID reference to a snippet to use in the teardown phase of an API check.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check group.
    activated Boolean
    Determines if the checks in the group are running or not.
    alertChannelSubscriptions List<CheckGroupAlertChannelSubscription>
    alertSettings CheckGroupAlertSettings
    Determines the alert escalation policy for the check.
    apiCheckDefaults CheckGroupApiCheckDefaults
    concurrency Integer
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    doubleCheck Boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable List<CheckGroupEnvironmentVariable>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables Map<String,String>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    localSetupScript String
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    localTeardownScript String
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    locations List<String>
    An array of one or more data center locations where to run the checks.
    muted Boolean
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    name String
    The name of the check group.
    privateLocations List<String>
    An array of one or more private locations slugs.
    retryStrategy CheckGroupRetryStrategy
    A strategy for retrying failed check/monitor runs.
    runParallel Boolean
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    runtimeId String
    The id of the runtime to use for this group.
    setupSnippetId Integer
    An ID reference to a snippet to use in the setup phase of an API check.
    tags List<String>
    Tags for organizing and filtering checks.
    teardownSnippetId Integer
    An ID reference to a snippet to use in the teardown phase of an API check.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check group.
    activated boolean
    Determines if the checks in the group are running or not.
    alertChannelSubscriptions CheckGroupAlertChannelSubscription[]
    alertSettings CheckGroupAlertSettings
    Determines the alert escalation policy for the check.
    apiCheckDefaults CheckGroupApiCheckDefaults
    concurrency number
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    doubleCheck boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable CheckGroupEnvironmentVariable[]
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables {[key: string]: string}
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    localSetupScript string
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    localTeardownScript string
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    locations string[]
    An array of one or more data center locations where to run the checks.
    muted boolean
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    name string
    The name of the check group.
    privateLocations string[]
    An array of one or more private locations slugs.
    retryStrategy CheckGroupRetryStrategy
    A strategy for retrying failed check/monitor runs.
    runParallel boolean
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    runtimeId string
    The id of the runtime to use for this group.
    setupSnippetId number
    An ID reference to a snippet to use in the setup phase of an API check.
    tags string[]
    Tags for organizing and filtering checks.
    teardownSnippetId number
    An ID reference to a snippet to use in the teardown phase of an API check.
    useGlobalAlertSettings boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check group.
    activated bool
    Determines if the checks in the group are running or not.
    alert_channel_subscriptions Sequence[CheckGroupAlertChannelSubscriptionArgs]
    alert_settings CheckGroupAlertSettingsArgs
    Determines the alert escalation policy for the check.
    api_check_defaults CheckGroupApiCheckDefaultsArgs
    concurrency int
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    double_check bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environment_variable Sequence[CheckGroupEnvironmentVariableArgs]
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environment_variables Mapping[str, str]
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    local_setup_script str
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    local_teardown_script str
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    locations Sequence[str]
    An array of one or more data center locations where to run the checks.
    muted bool
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    name str
    The name of the check group.
    private_locations Sequence[str]
    An array of one or more private locations slugs.
    retry_strategy CheckGroupRetryStrategyArgs
    A strategy for retrying failed check/monitor runs.
    run_parallel bool
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    runtime_id str
    The id of the runtime to use for this group.
    setup_snippet_id int
    An ID reference to a snippet to use in the setup phase of an API check.
    tags Sequence[str]
    Tags for organizing and filtering checks.
    teardown_snippet_id int
    An ID reference to a snippet to use in the teardown phase of an API check.
    use_global_alert_settings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check group.
    activated Boolean
    Determines if the checks in the group are running or not.
    alertChannelSubscriptions List<Property Map>
    alertSettings Property Map
    Determines the alert escalation policy for the check.
    apiCheckDefaults Property Map
    concurrency Number
    Determines how many checks are run concurrently when triggering a check group from CI/CD or through the API.
    doubleCheck Boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Default false).

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable List<Property Map>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables Map<String>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    localSetupScript String
    A valid piece of Node.js code to run in the setup phase of an API check in this group.
    localTeardownScript String
    A valid piece of Node.js code to run in the teardown phase of an API check in this group.
    locations List<String>
    An array of one or more data center locations where to run the checks.
    muted Boolean
    Determines if any notifications will be sent out when a check in this group fails and/or recovers.
    name String
    The name of the check group.
    privateLocations List<String>
    An array of one or more private locations slugs.
    retryStrategy Property Map
    A strategy for retrying failed check/monitor runs.
    runParallel Boolean
    Determines if the checks in the group should run in all selected locations in parallel or round-robin.
    runtimeId String
    The id of the runtime to use for this group.
    setupSnippetId Number
    An ID reference to a snippet to use in the setup phase of an API check.
    tags List<String>
    Tags for organizing and filtering checks.
    teardownSnippetId Number
    An ID reference to a snippet to use in the teardown phase of an API check.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check group.

    Supporting Types

    CheckGroupAlertChannelSubscription, CheckGroupAlertChannelSubscriptionArgs

    activated Boolean
    channelId Integer
    activated boolean
    channelId number
    activated Boolean
    channelId Number

    CheckGroupAlertSettings, CheckGroupAlertSettingsArgs

    EscalationType string
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    ParallelRunFailureThresholds List<CheckGroupAlertSettingsParallelRunFailureThreshold>
    Configuration for parallel run failure threshold.
    Reminders List<CheckGroupAlertSettingsReminder>
    Defines how often to send reminder notifications after initial alert.
    RunBasedEscalations List<CheckGroupAlertSettingsRunBasedEscalation>
    Configuration for run-based escalation.
    SslCertificates List<CheckGroupAlertSettingsSslCertificate>

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    TimeBasedEscalations List<CheckGroupAlertSettingsTimeBasedEscalation>
    Configuration for time-based escalation.
    EscalationType string
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    ParallelRunFailureThresholds []CheckGroupAlertSettingsParallelRunFailureThreshold
    Configuration for parallel run failure threshold.
    Reminders []CheckGroupAlertSettingsReminder
    Defines how often to send reminder notifications after initial alert.
    RunBasedEscalations []CheckGroupAlertSettingsRunBasedEscalation
    Configuration for run-based escalation.
    SslCertificates []CheckGroupAlertSettingsSslCertificate

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    TimeBasedEscalations []CheckGroupAlertSettingsTimeBasedEscalation
    Configuration for time-based escalation.
    escalationType String
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    parallelRunFailureThresholds List<CheckGroupAlertSettingsParallelRunFailureThreshold>
    Configuration for parallel run failure threshold.
    reminders List<CheckGroupAlertSettingsReminder>
    Defines how often to send reminder notifications after initial alert.
    runBasedEscalations List<CheckGroupAlertSettingsRunBasedEscalation>
    Configuration for run-based escalation.
    sslCertificates List<CheckGroupAlertSettingsSslCertificate>

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    timeBasedEscalations List<CheckGroupAlertSettingsTimeBasedEscalation>
    Configuration for time-based escalation.
    escalationType string
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    parallelRunFailureThresholds CheckGroupAlertSettingsParallelRunFailureThreshold[]
    Configuration for parallel run failure threshold.
    reminders CheckGroupAlertSettingsReminder[]
    Defines how often to send reminder notifications after initial alert.
    runBasedEscalations CheckGroupAlertSettingsRunBasedEscalation[]
    Configuration for run-based escalation.
    sslCertificates CheckGroupAlertSettingsSslCertificate[]

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    timeBasedEscalations CheckGroupAlertSettingsTimeBasedEscalation[]
    Configuration for time-based escalation.
    escalation_type str
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    parallel_run_failure_thresholds Sequence[CheckGroupAlertSettingsParallelRunFailureThreshold]
    Configuration for parallel run failure threshold.
    reminders Sequence[CheckGroupAlertSettingsReminder]
    Defines how often to send reminder notifications after initial alert.
    run_based_escalations Sequence[CheckGroupAlertSettingsRunBasedEscalation]
    Configuration for run-based escalation.
    ssl_certificates Sequence[CheckGroupAlertSettingsSslCertificate]

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    time_based_escalations Sequence[CheckGroupAlertSettingsTimeBasedEscalation]
    Configuration for time-based escalation.
    escalationType String
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    parallelRunFailureThresholds List<Property Map>
    Configuration for parallel run failure threshold.
    reminders List<Property Map>
    Defines how often to send reminder notifications after initial alert.
    runBasedEscalations List<Property Map>
    Configuration for run-based escalation.
    sslCertificates List<Property Map>

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    timeBasedEscalations List<Property Map>
    Configuration for time-based escalation.

    CheckGroupAlertSettingsParallelRunFailureThreshold, CheckGroupAlertSettingsParallelRunFailureThresholdArgs

    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, and 100. (Default 10).
    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, and 100. (Default 10).
    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, and 100. (Default 10).
    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, and 100. (Default 10).
    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, and 100. (Default 10).
    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, and 100. (Default 10).

    CheckGroupAlertSettingsReminder, CheckGroupAlertSettingsReminderArgs

    Amount int
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    Interval int
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).
    Amount int
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    Interval int
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).
    amount Integer
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    interval Integer
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).
    amount number
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    interval number
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).
    amount int
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    interval int
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).
    amount Number
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    interval Number
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).

    CheckGroupAlertSettingsRunBasedEscalation, CheckGroupAlertSettingsRunBasedEscalationArgs

    FailedRunThreshold int
    Send an alert notification after the given number of consecutive check runs have failed. Possible values are between 1 and 5. (Default 1).
    FailedRunThreshold int
    Send an alert notification after the given number of consecutive check runs have failed. Possible values are between 1 and 5. (Default 1).
    failedRunThreshold Integer
    Send an alert notification after the given number of consecutive check runs have failed. Possible values are between 1 and 5. (Default 1).
    failedRunThreshold number
    Send an alert notification after the given number of consecutive check runs have failed. Possible values are between 1 and 5. (Default 1).
    failed_run_threshold int
    Send an alert notification after the given number of consecutive check runs have failed. Possible values are between 1 and 5. (Default 1).
    failedRunThreshold Number
    Send an alert notification after the given number of consecutive check runs have failed. Possible values are between 1 and 5. (Default 1).

    CheckGroupAlertSettingsSslCertificate, CheckGroupAlertSettingsSslCertificateArgs

    AlertThreshold int
    No longer available.
    Enabled bool
    No longer available.
    AlertThreshold int
    No longer available.
    Enabled bool
    No longer available.
    alertThreshold Integer
    No longer available.
    enabled Boolean
    No longer available.
    alertThreshold number
    No longer available.
    enabled boolean
    No longer available.
    alert_threshold int
    No longer available.
    enabled bool
    No longer available.
    alertThreshold Number
    No longer available.
    enabled Boolean
    No longer available.

    CheckGroupAlertSettingsTimeBasedEscalation, CheckGroupAlertSettingsTimeBasedEscalationArgs

    MinutesFailingThreshold int
    Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).
    MinutesFailingThreshold int
    Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).
    minutesFailingThreshold Integer
    Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).
    minutesFailingThreshold number
    Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).
    minutes_failing_threshold int
    Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).
    minutesFailingThreshold Number
    Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).

    CheckGroupApiCheckDefaults, CheckGroupApiCheckDefaultsArgs

    Assertions List<CheckGroupApiCheckDefaultsAssertion>
    BasicAuth CheckGroupApiCheckDefaultsBasicAuth
    Headers Dictionary<string, string>
    QueryParameters Dictionary<string, string>
    Url string
    The base url for this group which you can reference with the GROUP_BASE_URL variable in all group checks.
    Assertions []CheckGroupApiCheckDefaultsAssertion
    BasicAuth CheckGroupApiCheckDefaultsBasicAuth
    Headers map[string]string
    QueryParameters map[string]string
    Url string
    The base url for this group which you can reference with the GROUP_BASE_URL variable in all group checks.
    assertions List<CheckGroupApiCheckDefaultsAssertion>
    basicAuth CheckGroupApiCheckDefaultsBasicAuth
    headers Map<String,String>
    queryParameters Map<String,String>
    url String
    The base url for this group which you can reference with the GROUP_BASE_URL variable in all group checks.
    assertions CheckGroupApiCheckDefaultsAssertion[]
    basicAuth CheckGroupApiCheckDefaultsBasicAuth
    headers {[key: string]: string}
    queryParameters {[key: string]: string}
    url string
    The base url for this group which you can reference with the GROUP_BASE_URL variable in all group checks.
    assertions Sequence[CheckGroupApiCheckDefaultsAssertion]
    basic_auth CheckGroupApiCheckDefaultsBasicAuth
    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_URL variable in all group checks.
    assertions List<Property Map>
    basicAuth Property Map
    headers Map<String>
    queryParameters Map<String>
    url String
    The base url for this group which you can reference with the GROUP_BASE_URL variable in all group checks.

    CheckGroupApiCheckDefaultsAssertion, CheckGroupApiCheckDefaultsAssertionArgs

    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, and NOT_NULL.
    Source string
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_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, and NOT_NULL.
    Source string
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_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, and NOT_NULL.
    source String
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_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, and NOT_NULL.
    source string
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_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, and NOT_NULL.
    source str
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_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, and NOT_NULL.
    source String
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_TIME.
    target String
    property String

    CheckGroupApiCheckDefaultsBasicAuth, CheckGroupApiCheckDefaultsBasicAuthArgs

    Password string
    Username string
    Password string
    Username string
    password String
    username String
    password string
    username string
    password String
    username String

    CheckGroupEnvironmentVariable, CheckGroupEnvironmentVariableArgs

    Key string
    Value string
    Locked bool
    Secret bool
    Key string
    Value string
    Locked bool
    Secret bool
    key String
    value String
    locked Boolean
    secret Boolean
    key string
    value string
    locked boolean
    secret boolean
    key str
    value str
    locked bool
    secret bool
    key String
    value String
    locked Boolean
    secret Boolean

    CheckGroupRetryStrategy, CheckGroupRetryStrategyArgs

    Type string
    Determines which type of retry strategy to use. Possible values are FIXED, LINEAR, EXPONENTIAL, SINGLE_RETRY, and NO_RETRIES.
    BaseBackoffSeconds int
    The number of seconds to wait before the first retry attempt. (Default 60).
    MaxDurationSeconds int
    The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 600).
    MaxRetries int
    The maximum number of times to retry the check/monitor. Value must be between 1 and 10. Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 2).
    OnlyOn CheckGroupRetryStrategyOnlyOn
    Apply the retry strategy only if the defined conditions match.
    SameRegion 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, and NO_RETRIES.
    BaseBackoffSeconds int
    The number of seconds to wait before the first retry attempt. (Default 60).
    MaxDurationSeconds int
    The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 600).
    MaxRetries int
    The maximum number of times to retry the check/monitor. Value must be between 1 and 10. Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 2).
    OnlyOn CheckGroupRetryStrategyOnlyOn
    Apply the retry strategy only if the defined conditions match.
    SameRegion 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, and NO_RETRIES.
    baseBackoffSeconds Integer
    The number of seconds to wait before the first retry attempt. (Default 60).
    maxDurationSeconds Integer
    The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 600).
    maxRetries Integer
    The maximum number of times to retry the check/monitor. Value must be between 1 and 10. Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 2).
    onlyOn CheckGroupRetryStrategyOnlyOn
    Apply the retry strategy only if the defined conditions match.
    sameRegion 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, and NO_RETRIES.
    baseBackoffSeconds number
    The number of seconds to wait before the first retry attempt. (Default 60).
    maxDurationSeconds number
    The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 600).
    maxRetries number
    The maximum number of times to retry the check/monitor. Value must be between 1 and 10. Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 2).
    onlyOn CheckGroupRetryStrategyOnlyOn
    Apply the retry strategy only if the defined conditions match.
    sameRegion 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, and NO_RETRIES.
    base_backoff_seconds int
    The number of seconds to wait before the first retry attempt. (Default 60).
    max_duration_seconds int
    The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 600).
    max_retries int
    The maximum number of times to retry the check/monitor. Value must be between 1 and 10. Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 2).
    only_on CheckGroupRetryStrategyOnlyOn
    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, and NO_RETRIES.
    baseBackoffSeconds Number
    The number of seconds to wait before the first retry attempt. (Default 60).
    maxDurationSeconds Number
    The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 600).
    maxRetries Number
    The maximum number of times to retry the check/monitor. Value must be between 1 and 10. Available when type is FIXED, LINEAR, or EXPONENTIAL. (Default 2).
    onlyOn Property Map
    Apply the retry strategy only if the defined conditions match.
    sameRegion Boolean
    Whether retries should be run in the same region as the initial check/monitor run. (Default true).

    CheckGroupRetryStrategyOnlyOn, CheckGroupRetryStrategyOnlyOnArgs

    NetworkError bool
    When true, retry only if the cause of the failure is a network error. (Default false).
    NetworkError bool
    When true, retry only if the cause of the failure is a network error. (Default false).
    networkError Boolean
    When true, retry only if the cause of the failure is a network error. (Default false).
    networkError boolean
    When true, retry only if the cause of the failure is a network error. (Default false).
    network_error bool
    When true, retry only if the cause of the failure is a network error. (Default false).
    networkError Boolean
    When true, retry only if the cause of the failure is a network error. (Default false).

    Package Details

    Repository
    checkly checkly/pulumi-checkly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the checkly Terraform Provider.
    checkly logo
    Checkly v2.7.0 published on Tuesday, Nov 4, 2025 by Checkly
    checkly/pulumi-checkly
      Meet Neo: Your AI Platform Teammate