Checkly

v1.1.2 published on Wednesday, Aug 3, 2022 by checkly

CheckGroup

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

Example Usage

using Pulumi;
using Checkly = Pulumi.Checkly;

class MyStack : Stack
{
    public MyStack()
    {
        var test_group1CheckGroup = new Checkly.CheckGroup("test-group1CheckGroup", new Checkly.CheckGroupArgs
        {
            Activated = true,
            Muted = false,
            Tags = 
            {
                "auto",
            },
            Locations = 
            {
                "eu-west-1",
            },
            Concurrency = 3,
            ApiCheckDefaults = new Checkly.Inputs.CheckGroupApiCheckDefaultsArgs
            {
                Url = "http://example.com/",
                Headers = 
                {
                    { "X-Test", "foo" },
                },
                QueryParameters = 
                {
                    { "query", "foo" },
                },
                Assertions = 
                {
                    new Checkly.Inputs.CheckGroupApiCheckDefaultsAssertionArgs
                    {
                        Source = "STATUS_CODE",
                        Property = "",
                        Comparison = "EQUALS",
                        Target = "200",
                    },
                    new Checkly.Inputs.CheckGroupApiCheckDefaultsAssertionArgs
                    {
                        Source = "TEXT_BODY",
                        Property = "",
                        Comparison = "CONTAINS",
                        Target = "welcome",
                    },
                },
                BasicAuth = new Checkly.Inputs.CheckGroupApiCheckDefaultsBasicAuthArgs
                {
                    Username = "user",
                    Password = "pass",
                },
            },
            EnvironmentVariables = 
            {
                { "ENVTEST", "Hello world" },
            },
            DoubleCheck = true,
            UseGlobalAlertSettings = false,
            AlertSettings = new Checkly.Inputs.CheckGroupAlertSettingsArgs
            {
                EscalationType = "RUN_BASED",
                RunBasedEscalations = 
                {
                    new Checkly.Inputs.CheckGroupAlertSettingsRunBasedEscalationArgs
                    {
                        FailedRunThreshold = 1,
                    },
                },
                TimeBasedEscalations = 
                {
                    new Checkly.Inputs.CheckGroupAlertSettingsTimeBasedEscalationArgs
                    {
                        MinutesFailingThreshold = 5,
                    },
                },
                Reminders = 
                {
                    new Checkly.Inputs.CheckGroupAlertSettingsReminderArgs
                    {
                        Amount = 2,
                        Interval = 5,
                    },
                },
            },
            LocalSetupScript = "setup-test",
            LocalTeardownScript = "teardown-test",
        });
        // Add a check to a group
        var test_check1 = new Checkly.Check("test-check1", new Checkly.CheckArgs
        {
            GroupId = test_group1CheckGroup.Id,
            GroupOrder = 1,
        });
        // Using with alert channels
        var emailAc1 = new Checkly.AlertChannel("emailAc1", new Checkly.AlertChannelArgs
        {
            Email = new Checkly.Inputs.AlertChannelEmailArgs
            {
                Address = "info@example.com",
            },
        });
        var emailAc2 = new Checkly.AlertChannel("emailAc2", new Checkly.AlertChannelArgs
        {
            Email = new Checkly.Inputs.AlertChannelEmailArgs
            {
                Address = "info2@example.com",
            },
        });
        // Connect the check group to the alert channels
        var test_group1Index_checkGroupCheckGroup = new Checkly.CheckGroup("test-group1Index/checkGroupCheckGroup", new Checkly.CheckGroupArgs
        {
            AlertChannelSubscriptions = 
            {
                new Checkly.Inputs.CheckGroupAlertChannelSubscriptionArgs
                {
                    ChannelId = emailAc1.Id,
                    Activated = true,
                },
                new Checkly.Inputs.CheckGroupAlertChannelSubscriptionArgs
                {
                    ChannelId = emailAc2.Id,
                    Activated = true,
                },
            },
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkly.NewCheckGroup(ctx, "test-group1CheckGroup", &checkly.CheckGroupArgs{
			Activated: pulumi.Bool(true),
			Muted:     pulumi.Bool(false),
			Tags: pulumi.StringArray{
				pulumi.String("auto"),
			},
			Locations: pulumi.StringArray{
				pulumi.String("eu-west-1"),
			},
			Concurrency: pulumi.Int(3),
			ApiCheckDefaults: &CheckGroupApiCheckDefaultsArgs{
				Url: pulumi.String("http://example.com/"),
				Headers: pulumi.AnyMap{
					"X-Test": pulumi.Any("foo"),
				},
				QueryParameters: pulumi.AnyMap{
					"query": pulumi.Any("foo"),
				},
				Assertions: CheckGroupApiCheckDefaultsAssertionArray{
					&CheckGroupApiCheckDefaultsAssertionArgs{
						Source:     pulumi.String("STATUS_CODE"),
						Property:   pulumi.String(""),
						Comparison: pulumi.String("EQUALS"),
						Target:     pulumi.String("200"),
					},
					&CheckGroupApiCheckDefaultsAssertionArgs{
						Source:     pulumi.String("TEXT_BODY"),
						Property:   pulumi.String(""),
						Comparison: pulumi.String("CONTAINS"),
						Target:     pulumi.String("welcome"),
					},
				},
				BasicAuth: &CheckGroupApiCheckDefaultsBasicAuthArgs{
					Username: pulumi.String("user"),
					Password: pulumi.String("pass"),
				},
			},
			EnvironmentVariables: pulumi.AnyMap{
				"ENVTEST": pulumi.Any("Hello world"),
			},
			DoubleCheck:            pulumi.Bool(true),
			UseGlobalAlertSettings: pulumi.Bool(false),
			AlertSettings: &CheckGroupAlertSettingsArgs{
				EscalationType: pulumi.String("RUN_BASED"),
				RunBasedEscalations: CheckGroupAlertSettingsRunBasedEscalationArray{
					&CheckGroupAlertSettingsRunBasedEscalationArgs{
						FailedRunThreshold: pulumi.Int(1),
					},
				},
				TimeBasedEscalations: CheckGroupAlertSettingsTimeBasedEscalationArray{
					&CheckGroupAlertSettingsTimeBasedEscalationArgs{
						MinutesFailingThreshold: pulumi.Int(5),
					},
				},
				Reminders: CheckGroupAlertSettingsReminderArray{
					&CheckGroupAlertSettingsReminderArgs{
						Amount:   pulumi.Int(2),
						Interval: pulumi.Int(5),
					},
				},
			},
			LocalSetupScript:    pulumi.String("setup-test"),
			LocalTeardownScript: pulumi.String("teardown-test"),
		})
		if err != nil {
			return err
		}
		_, err = checkly.NewCheck(ctx, "test-check1", &checkly.CheckArgs{
			GroupId:    test_group1CheckGroup.ID(),
			GroupOrder: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		emailAc1, err := checkly.NewAlertChannel(ctx, "emailAc1", &checkly.AlertChannelArgs{
			Email: &AlertChannelEmailArgs{
				Address: pulumi.String("info@example.com"),
			},
		})
		if err != nil {
			return err
		}
		emailAc2, err := checkly.NewAlertChannel(ctx, "emailAc2", &checkly.AlertChannelArgs{
			Email: &AlertChannelEmailArgs{
				Address: pulumi.String("info2@example.com"),
			},
		})
		if err != nil {
			return err
		}
		_, err = checkly.NewCheckGroup(ctx, "test-group1Index/checkGroupCheckGroup", &checkly.CheckGroupArgs{
			AlertChannelSubscriptions: CheckGroupAlertChannelSubscriptionArray{
				&CheckGroupAlertChannelSubscriptionArgs{
					ChannelId: emailAc1.ID(),
					Activated: pulumi.Bool(true),
				},
				&CheckGroupAlertChannelSubscriptionArgs{
					ChannelId: emailAc2.ID(),
					Activated: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_checkly as checkly

test_group1_check_group = checkly.CheckGroup("test-group1CheckGroup",
    activated=True,
    muted=False,
    tags=["auto"],
    locations=["eu-west-1"],
    concurrency=3,
    api_check_defaults=checkly.CheckGroupApiCheckDefaultsArgs(
        url="http://example.com/",
        headers={
            "X-Test": "foo",
        },
        query_parameters={
            "query": "foo",
        },
        assertions=[
            checkly.CheckGroupApiCheckDefaultsAssertionArgs(
                source="STATUS_CODE",
                property="",
                comparison="EQUALS",
                target="200",
            ),
            checkly.CheckGroupApiCheckDefaultsAssertionArgs(
                source="TEXT_BODY",
                property="",
                comparison="CONTAINS",
                target="welcome",
            ),
        ],
        basic_auth=checkly.CheckGroupApiCheckDefaultsBasicAuthArgs(
            username="user",
            password="pass",
        ),
    ),
    environment_variables={
        "ENVTEST": "Hello world",
    },
    double_check=True,
    use_global_alert_settings=False,
    alert_settings=checkly.CheckGroupAlertSettingsArgs(
        escalation_type="RUN_BASED",
        run_based_escalations=[checkly.CheckGroupAlertSettingsRunBasedEscalationArgs(
            failed_run_threshold=1,
        )],
        time_based_escalations=[checkly.CheckGroupAlertSettingsTimeBasedEscalationArgs(
            minutes_failing_threshold=5,
        )],
        reminders=[checkly.CheckGroupAlertSettingsReminderArgs(
            amount=2,
            interval=5,
        )],
    ),
    local_setup_script="setup-test",
    local_teardown_script="teardown-test")
# Add a check to a group
test_check1 = checkly.Check("test-check1",
    group_id=test_group1_check_group.id,
    group_order=1)
# Using with alert channels
email_ac1 = checkly.AlertChannel("emailAc1", email=checkly.AlertChannelEmailArgs(
    address="info@example.com",
))
email_ac2 = checkly.AlertChannel("emailAc2", email=checkly.AlertChannelEmailArgs(
    address="info2@example.com",
))
# Connect the check group to the alert channels
test_group1_index_check_group_check_group = checkly.CheckGroup("test-group1Index/checkGroupCheckGroup", alert_channel_subscriptions=[
    checkly.CheckGroupAlertChannelSubscriptionArgs(
        channel_id=email_ac1.id,
        activated=True,
    ),
    checkly.CheckGroupAlertChannelSubscriptionArgs(
        channel_id=email_ac2.id,
        activated=True,
    ),
])
import * as pulumi from "@pulumi/pulumi";
import * as pulumi from "@checkly/pulumi";

const test_group1CheckGroup = new checkly.CheckGroup("test-group1CheckGroup", {
    activated: true,
    muted: false,
    tags: ["auto"],
    locations: ["eu-west-1"],
    concurrency: 3,
    apiCheckDefaults: {
        url: "http://example.com/",
        headers: {
            "X-Test": "foo",
        },
        queryParameters: {
            query: "foo",
        },
        assertions: [
            {
                source: "STATUS_CODE",
                property: "",
                comparison: "EQUALS",
                target: "200",
            },
            {
                source: "TEXT_BODY",
                property: "",
                comparison: "CONTAINS",
                target: "welcome",
            },
        ],
        basicAuth: {
            username: "user",
            password: "pass",
        },
    },
    environmentVariables: {
        ENVTEST: "Hello world",
    },
    doubleCheck: true,
    useGlobalAlertSettings: false,
    alertSettings: {
        escalationType: "RUN_BASED",
        runBasedEscalations: [{
            failedRunThreshold: 1,
        }],
        timeBasedEscalations: [{
            minutesFailingThreshold: 5,
        }],
        reminders: [{
            amount: 2,
            interval: 5,
        }],
    },
    localSetupScript: "setup-test",
    localTeardownScript: "teardown-test",
});
// Add a check to a group
const test_check1 = new checkly.Check("test-check1", {
    groupId: test_group1CheckGroup.id,
    groupOrder: 1,
});
// Using with alert channels
const emailAc1 = new checkly.AlertChannel("emailAc1", {email: {
    address: "info@example.com",
}});
const emailAc2 = new checkly.AlertChannel("emailAc2", {email: {
    address: "info2@example.com",
}});
// Connect the check group to the alert channels
const test_group1Index_checkGroupCheckGroup = new checkly.CheckGroup("test-group1Index/checkGroupCheckGroup", {alertChannelSubscriptions: [
    {
        channelId: emailAc1.id,
        activated: true,
    },
    {
        channelId: emailAc2.id,
        activated: true,
    },
]});

Coming soon!

Create CheckGroup Resource

new CheckGroup(name: string, args: CheckGroupArgs, opts?: CustomResourceOptions);
@overload
def CheckGroup(resource_name: 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_variables: Optional[Mapping[str, Any]] = 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,
               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)
@overload
def CheckGroup(resource_name: str,
               args: CheckGroupArgs,
               opts: Optional[ResourceOptions] = 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.

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.

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

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<CheckGroupAlertChannelSubscriptionArgs>
AlertSettings CheckGroupAlertSettingsArgs
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.

EnvironmentVariables Dictionary<string, object>

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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
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.

EnvironmentVariables map[string]interface{}

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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<CheckGroupAlertChannelSubscriptionArgs>
alertSettings CheckGroupAlertSettingsArgs
apiCheckDefaults CheckGroupApiCheckDefaultsArgs
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.

environmentVariables Map<String,Object>

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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 CheckGroupAlertChannelSubscriptionArgs[]
alertSettings CheckGroupAlertSettingsArgs
apiCheckDefaults CheckGroupApiCheckDefaultsArgs
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.

environmentVariables {[key: string]: any}

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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
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.

environment_variables Mapping[str, Any]

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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
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.

environmentVariables Map<Any>

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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_variables: Optional[Mapping[str, Any]] = 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,
        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)
Resource lookup is not supported in YAML
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<CheckGroupAlertChannelSubscriptionArgs>
AlertSettings CheckGroupAlertSettingsArgs
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.

EnvironmentVariables Dictionary<string, object>

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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
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.

EnvironmentVariables map[string]interface{}

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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<CheckGroupAlertChannelSubscriptionArgs>
alertSettings CheckGroupAlertSettingsArgs
apiCheckDefaults CheckGroupApiCheckDefaultsArgs
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.

environmentVariables Map<String,Object>

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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 CheckGroupAlertChannelSubscriptionArgs[]
alertSettings CheckGroupAlertSettingsArgs
apiCheckDefaults CheckGroupApiCheckDefaultsArgs
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.

environmentVariables {[key: string]: any}

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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
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.

environment_variables Mapping[str, Any]

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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
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.

environmentVariables Map<Any>

Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

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.

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

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

CheckGroupAlertSettings

escalationType String
reminders List<Property Map>
runBasedEscalations List<Property Map>
sslCertificates List<Property Map>

Deprecated:

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

timeBasedEscalations List<Property Map>

CheckGroupAlertSettingsReminder

amount Integer
interval Integer
amount number
interval number
amount Number
interval Number

CheckGroupAlertSettingsRunBasedEscalation

CheckGroupAlertSettingsSslCertificate

alertThreshold Integer
enabled Boolean
alertThreshold number
enabled boolean
alertThreshold Number
enabled Boolean

CheckGroupAlertSettingsTimeBasedEscalation

CheckGroupApiCheckDefaults

CheckGroupApiCheckDefaultsAssertion

Comparison string
Source string
Target string
Property string
Comparison string
Source string
Target string
Property string
comparison String
source String
target String
property String
comparison string
source string
target string
property string
comparison String
source String
target String
property String

CheckGroupApiCheckDefaultsBasicAuth

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

Package Details

Repository
https://github.com/checkly/pulumi-checkly
License
MIT
Notes

This Pulumi package is based on the checkly Terraform Provider.