1. Packages
  2. Checkly
  3. API Docs
  4. PlaywrightCheckSuite
Checkly v2.8.0 published on Monday, Mar 2, 2026 by Checkly
checkly logo
Checkly v2.8.0 published on Monday, Mar 2, 2026 by Checkly

    Creates a Playwright check from a code bundle.

    Create PlaywrightCheckSuite Resource

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

    Constructor syntax

    new PlaywrightCheckSuite(name: string, args: PlaywrightCheckSuiteArgs, opts?: CustomResourceOptions);
    @overload
    def PlaywrightCheckSuite(resource_name: str,
                             args: PlaywrightCheckSuiteArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def PlaywrightCheckSuite(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             runtime: Optional[PlaywrightCheckSuiteRuntimeArgs] = None,
                             frequency: Optional[int] = None,
                             activated: Optional[bool] = None,
                             bundle: Optional[PlaywrightCheckSuiteBundleArgs] = None,
                             name: Optional[str] = None,
                             group_id: Optional[int] = None,
                             alert_channel_subscriptions: Optional[Sequence[PlaywrightCheckSuiteAlertChannelSubscriptionArgs]] = None,
                             group_order: Optional[int] = None,
                             muted: Optional[bool] = None,
                             locations: Optional[Sequence[str]] = None,
                             private_locations: Optional[Sequence[str]] = None,
                             run_parallel: Optional[bool] = None,
                             alert_settings: Optional[PlaywrightCheckSuiteAlertSettingsArgs] = None,
                             tags: Optional[Sequence[str]] = None,
                             trigger_incident: Optional[PlaywrightCheckSuiteTriggerIncidentArgs] = None,
                             use_global_alert_settings: Optional[bool] = None)
    func NewPlaywrightCheckSuite(ctx *Context, name string, args PlaywrightCheckSuiteArgs, opts ...ResourceOption) (*PlaywrightCheckSuite, error)
    public PlaywrightCheckSuite(string name, PlaywrightCheckSuiteArgs args, CustomResourceOptions? opts = null)
    public PlaywrightCheckSuite(String name, PlaywrightCheckSuiteArgs args)
    public PlaywrightCheckSuite(String name, PlaywrightCheckSuiteArgs args, CustomResourceOptions options)
    
    type: checkly:PlaywrightCheckSuite
    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 PlaywrightCheckSuiteArgs
    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 PlaywrightCheckSuiteArgs
    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 PlaywrightCheckSuiteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PlaywrightCheckSuiteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PlaywrightCheckSuiteArgs
    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 playwrightCheckSuiteResource = new Checkly.PlaywrightCheckSuite("playwrightCheckSuiteResource", new()
    {
        Runtime = new Checkly.Inputs.PlaywrightCheckSuiteRuntimeArgs
        {
            Playwright = new Checkly.Inputs.PlaywrightCheckSuiteRuntimePlaywrightArgs
            {
                Devices = new[]
                {
                    new Checkly.Inputs.PlaywrightCheckSuiteRuntimePlaywrightDeviceArgs
                    {
                        Type = "string",
                    },
                },
                Version = "string",
            },
            Steps = new Checkly.Inputs.PlaywrightCheckSuiteRuntimeStepsArgs
            {
                Install = new Checkly.Inputs.PlaywrightCheckSuiteRuntimeStepsInstallArgs
                {
                    Command = "string",
                },
                Test = new Checkly.Inputs.PlaywrightCheckSuiteRuntimeStepsTestArgs
                {
                    Command = "string",
                },
            },
        },
        Frequency = 0,
        Activated = false,
        Bundle = new Checkly.Inputs.PlaywrightCheckSuiteBundleArgs
        {
            Id = "string",
            Metadata = "string",
        },
        Name = "string",
        GroupId = 0,
        AlertChannelSubscriptions = new[]
        {
            new Checkly.Inputs.PlaywrightCheckSuiteAlertChannelSubscriptionArgs
            {
                Activated = false,
                ChannelId = 0,
            },
        },
        GroupOrder = 0,
        Muted = false,
        Locations = new[]
        {
            "string",
        },
        PrivateLocations = new[]
        {
            "string",
        },
        RunParallel = false,
        AlertSettings = new Checkly.Inputs.PlaywrightCheckSuiteAlertSettingsArgs
        {
            EscalationType = "string",
            ParallelRunFailureThresholds = new[]
            {
                new Checkly.Inputs.PlaywrightCheckSuiteAlertSettingsParallelRunFailureThresholdArgs
                {
                    Enabled = false,
                    Percentage = 0,
                },
            },
            Reminders = new[]
            {
                new Checkly.Inputs.PlaywrightCheckSuiteAlertSettingsReminderArgs
                {
                    Amount = 0,
                    Interval = 0,
                },
            },
            RunBasedEscalations = new[]
            {
                new Checkly.Inputs.PlaywrightCheckSuiteAlertSettingsRunBasedEscalationArgs
                {
                    FailedRunThreshold = 0,
                },
            },
            TimeBasedEscalations = new[]
            {
                new Checkly.Inputs.PlaywrightCheckSuiteAlertSettingsTimeBasedEscalationArgs
                {
                    MinutesFailingThreshold = 0,
                },
            },
        },
        Tags = new[]
        {
            "string",
        },
        TriggerIncident = new Checkly.Inputs.PlaywrightCheckSuiteTriggerIncidentArgs
        {
            Description = "string",
            Name = "string",
            NotifySubscribers = false,
            ServiceId = "string",
            Severity = "string",
        },
        UseGlobalAlertSettings = false,
    });
    
    example, err := checkly.NewPlaywrightCheckSuite(ctx, "playwrightCheckSuiteResource", &checkly.PlaywrightCheckSuiteArgs{
    	Runtime: &checkly.PlaywrightCheckSuiteRuntimeArgs{
    		Playwright: &checkly.PlaywrightCheckSuiteRuntimePlaywrightArgs{
    			Devices: checkly.PlaywrightCheckSuiteRuntimePlaywrightDeviceArray{
    				&checkly.PlaywrightCheckSuiteRuntimePlaywrightDeviceArgs{
    					Type: pulumi.String("string"),
    				},
    			},
    			Version: pulumi.String("string"),
    		},
    		Steps: &checkly.PlaywrightCheckSuiteRuntimeStepsArgs{
    			Install: &checkly.PlaywrightCheckSuiteRuntimeStepsInstallArgs{
    				Command: pulumi.String("string"),
    			},
    			Test: &checkly.PlaywrightCheckSuiteRuntimeStepsTestArgs{
    				Command: pulumi.String("string"),
    			},
    		},
    	},
    	Frequency: pulumi.Int(0),
    	Activated: pulumi.Bool(false),
    	Bundle: &checkly.PlaywrightCheckSuiteBundleArgs{
    		Id:       pulumi.String("string"),
    		Metadata: pulumi.String("string"),
    	},
    	Name:    pulumi.String("string"),
    	GroupId: pulumi.Int(0),
    	AlertChannelSubscriptions: checkly.PlaywrightCheckSuiteAlertChannelSubscriptionArray{
    		&checkly.PlaywrightCheckSuiteAlertChannelSubscriptionArgs{
    			Activated: pulumi.Bool(false),
    			ChannelId: pulumi.Int(0),
    		},
    	},
    	GroupOrder: pulumi.Int(0),
    	Muted:      pulumi.Bool(false),
    	Locations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	PrivateLocations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RunParallel: pulumi.Bool(false),
    	AlertSettings: &checkly.PlaywrightCheckSuiteAlertSettingsArgs{
    		EscalationType: pulumi.String("string"),
    		ParallelRunFailureThresholds: checkly.PlaywrightCheckSuiteAlertSettingsParallelRunFailureThresholdArray{
    			&checkly.PlaywrightCheckSuiteAlertSettingsParallelRunFailureThresholdArgs{
    				Enabled:    pulumi.Bool(false),
    				Percentage: pulumi.Int(0),
    			},
    		},
    		Reminders: checkly.PlaywrightCheckSuiteAlertSettingsReminderArray{
    			&checkly.PlaywrightCheckSuiteAlertSettingsReminderArgs{
    				Amount:   pulumi.Int(0),
    				Interval: pulumi.Int(0),
    			},
    		},
    		RunBasedEscalations: checkly.PlaywrightCheckSuiteAlertSettingsRunBasedEscalationArray{
    			&checkly.PlaywrightCheckSuiteAlertSettingsRunBasedEscalationArgs{
    				FailedRunThreshold: pulumi.Int(0),
    			},
    		},
    		TimeBasedEscalations: checkly.PlaywrightCheckSuiteAlertSettingsTimeBasedEscalationArray{
    			&checkly.PlaywrightCheckSuiteAlertSettingsTimeBasedEscalationArgs{
    				MinutesFailingThreshold: pulumi.Int(0),
    			},
    		},
    	},
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TriggerIncident: &checkly.PlaywrightCheckSuiteTriggerIncidentArgs{
    		Description:       pulumi.String("string"),
    		Name:              pulumi.String("string"),
    		NotifySubscribers: pulumi.Bool(false),
    		ServiceId:         pulumi.String("string"),
    		Severity:          pulumi.String("string"),
    	},
    	UseGlobalAlertSettings: pulumi.Bool(false),
    })
    
    var playwrightCheckSuiteResource = new PlaywrightCheckSuite("playwrightCheckSuiteResource", PlaywrightCheckSuiteArgs.builder()
        .runtime(PlaywrightCheckSuiteRuntimeArgs.builder()
            .playwright(PlaywrightCheckSuiteRuntimePlaywrightArgs.builder()
                .devices(PlaywrightCheckSuiteRuntimePlaywrightDeviceArgs.builder()
                    .type("string")
                    .build())
                .version("string")
                .build())
            .steps(PlaywrightCheckSuiteRuntimeStepsArgs.builder()
                .install(PlaywrightCheckSuiteRuntimeStepsInstallArgs.builder()
                    .command("string")
                    .build())
                .test(PlaywrightCheckSuiteRuntimeStepsTestArgs.builder()
                    .command("string")
                    .build())
                .build())
            .build())
        .frequency(0)
        .activated(false)
        .bundle(PlaywrightCheckSuiteBundleArgs.builder()
            .id("string")
            .metadata("string")
            .build())
        .name("string")
        .groupId(0)
        .alertChannelSubscriptions(PlaywrightCheckSuiteAlertChannelSubscriptionArgs.builder()
            .activated(false)
            .channelId(0)
            .build())
        .groupOrder(0)
        .muted(false)
        .locations("string")
        .privateLocations("string")
        .runParallel(false)
        .alertSettings(PlaywrightCheckSuiteAlertSettingsArgs.builder()
            .escalationType("string")
            .parallelRunFailureThresholds(PlaywrightCheckSuiteAlertSettingsParallelRunFailureThresholdArgs.builder()
                .enabled(false)
                .percentage(0)
                .build())
            .reminders(PlaywrightCheckSuiteAlertSettingsReminderArgs.builder()
                .amount(0)
                .interval(0)
                .build())
            .runBasedEscalations(PlaywrightCheckSuiteAlertSettingsRunBasedEscalationArgs.builder()
                .failedRunThreshold(0)
                .build())
            .timeBasedEscalations(PlaywrightCheckSuiteAlertSettingsTimeBasedEscalationArgs.builder()
                .minutesFailingThreshold(0)
                .build())
            .build())
        .tags("string")
        .triggerIncident(PlaywrightCheckSuiteTriggerIncidentArgs.builder()
            .description("string")
            .name("string")
            .notifySubscribers(false)
            .serviceId("string")
            .severity("string")
            .build())
        .useGlobalAlertSettings(false)
        .build());
    
    playwright_check_suite_resource = checkly.PlaywrightCheckSuite("playwrightCheckSuiteResource",
        runtime={
            "playwright": {
                "devices": [{
                    "type": "string",
                }],
                "version": "string",
            },
            "steps": {
                "install": {
                    "command": "string",
                },
                "test": {
                    "command": "string",
                },
            },
        },
        frequency=0,
        activated=False,
        bundle={
            "id": "string",
            "metadata": "string",
        },
        name="string",
        group_id=0,
        alert_channel_subscriptions=[{
            "activated": False,
            "channel_id": 0,
        }],
        group_order=0,
        muted=False,
        locations=["string"],
        private_locations=["string"],
        run_parallel=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,
            }],
        },
        tags=["string"],
        trigger_incident={
            "description": "string",
            "name": "string",
            "notify_subscribers": False,
            "service_id": "string",
            "severity": "string",
        },
        use_global_alert_settings=False)
    
    const playwrightCheckSuiteResource = new checkly.PlaywrightCheckSuite("playwrightCheckSuiteResource", {
        runtime: {
            playwright: {
                devices: [{
                    type: "string",
                }],
                version: "string",
            },
            steps: {
                install: {
                    command: "string",
                },
                test: {
                    command: "string",
                },
            },
        },
        frequency: 0,
        activated: false,
        bundle: {
            id: "string",
            metadata: "string",
        },
        name: "string",
        groupId: 0,
        alertChannelSubscriptions: [{
            activated: false,
            channelId: 0,
        }],
        groupOrder: 0,
        muted: false,
        locations: ["string"],
        privateLocations: ["string"],
        runParallel: false,
        alertSettings: {
            escalationType: "string",
            parallelRunFailureThresholds: [{
                enabled: false,
                percentage: 0,
            }],
            reminders: [{
                amount: 0,
                interval: 0,
            }],
            runBasedEscalations: [{
                failedRunThreshold: 0,
            }],
            timeBasedEscalations: [{
                minutesFailingThreshold: 0,
            }],
        },
        tags: ["string"],
        triggerIncident: {
            description: "string",
            name: "string",
            notifySubscribers: false,
            serviceId: "string",
            severity: "string",
        },
        useGlobalAlertSettings: false,
    });
    
    type: checkly:PlaywrightCheckSuite
    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
        bundle:
            id: string
            metadata: string
        frequency: 0
        groupId: 0
        groupOrder: 0
        locations:
            - string
        muted: false
        name: string
        privateLocations:
            - string
        runParallel: false
        runtime:
            playwright:
                devices:
                    - type: string
                version: string
            steps:
                install:
                    command: string
                test:
                    command: string
        tags:
            - string
        triggerIncident:
            description: string
            name: string
            notifySubscribers: false
            serviceId: string
            severity: string
        useGlobalAlertSettings: false
    

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

    Activated bool
    Determines whether the check will run periodically or not after being deployed.
    Bundle PlaywrightCheckSuiteBundle
    Attaches a code bundle to the check.
    Frequency int
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    Runtime PlaywrightCheckSuiteRuntime
    Configure the runtime environment of the Playwright check.
    AlertChannelSubscriptions List<PlaywrightCheckSuiteAlertChannelSubscription>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    AlertSettings PlaywrightCheckSuiteAlertSettings
    Determines the alert escalation policy for the check.
    GroupId int
    The ID of the check group that this check is part of.
    GroupOrder int
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    Locations List<string>
    An array of one or more data center locations where to run the this check.
    Muted bool
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    Name string
    The name of the check.
    PrivateLocations List<string>
    An array of one or more private locations slugs.
    RunParallel bool
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    Tags List<string>
    A list of tags for organizing and filtering checks and monitors.
    TriggerIncident PlaywrightCheckSuiteTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).
    Activated bool
    Determines whether the check will run periodically or not after being deployed.
    Bundle PlaywrightCheckSuiteBundleArgs
    Attaches a code bundle to the check.
    Frequency int
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    Runtime PlaywrightCheckSuiteRuntimeArgs
    Configure the runtime environment of the Playwright check.
    AlertChannelSubscriptions []PlaywrightCheckSuiteAlertChannelSubscriptionArgs
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    AlertSettings PlaywrightCheckSuiteAlertSettingsArgs
    Determines the alert escalation policy for the check.
    GroupId int
    The ID of the check group that this check is part of.
    GroupOrder int
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    Locations []string
    An array of one or more data center locations where to run the this check.
    Muted bool
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    Name string
    The name of the check.
    PrivateLocations []string
    An array of one or more private locations slugs.
    RunParallel bool
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    Tags []string
    A list of tags for organizing and filtering checks and monitors.
    TriggerIncident PlaywrightCheckSuiteTriggerIncidentArgs
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).
    activated Boolean
    Determines whether the check will run periodically or not after being deployed.
    bundle PlaywrightCheckSuiteBundle
    Attaches a code bundle to the check.
    frequency Integer
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    runtime PlaywrightCheckSuiteRuntime
    Configure the runtime environment of the Playwright check.
    alertChannelSubscriptions List<PlaywrightCheckSuiteAlertChannelSubscription>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    alertSettings PlaywrightCheckSuiteAlertSettings
    Determines the alert escalation policy for the check.
    groupId Integer
    The ID of the check group that this check is part of.
    groupOrder Integer
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    locations List<String>
    An array of one or more data center locations where to run the this check.
    muted Boolean
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    name String
    The name of the check.
    privateLocations List<String>
    An array of one or more private locations slugs.
    runParallel Boolean
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    tags List<String>
    A list of tags for organizing and filtering checks and monitors.
    triggerIncident PlaywrightCheckSuiteTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).
    activated boolean
    Determines whether the check will run periodically or not after being deployed.
    bundle PlaywrightCheckSuiteBundle
    Attaches a code bundle to the check.
    frequency number
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    runtime PlaywrightCheckSuiteRuntime
    Configure the runtime environment of the Playwright check.
    alertChannelSubscriptions PlaywrightCheckSuiteAlertChannelSubscription[]
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    alertSettings PlaywrightCheckSuiteAlertSettings
    Determines the alert escalation policy for the check.
    groupId number
    The ID of the check group that this check is part of.
    groupOrder number
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    locations string[]
    An array of one or more data center locations where to run the this check.
    muted boolean
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    name string
    The name of the check.
    privateLocations string[]
    An array of one or more private locations slugs.
    runParallel boolean
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    tags string[]
    A list of tags for organizing and filtering checks and monitors.
    triggerIncident PlaywrightCheckSuiteTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).
    activated bool
    Determines whether the check will run periodically or not after being deployed.
    bundle PlaywrightCheckSuiteBundleArgs
    Attaches a code bundle to the check.
    frequency int
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    runtime PlaywrightCheckSuiteRuntimeArgs
    Configure the runtime environment of the Playwright check.
    alert_channel_subscriptions Sequence[PlaywrightCheckSuiteAlertChannelSubscriptionArgs]
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    alert_settings PlaywrightCheckSuiteAlertSettingsArgs
    Determines the alert escalation policy for the check.
    group_id int
    The ID of the check group that this check is part of.
    group_order int
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    locations Sequence[str]
    An array of one or more data center locations where to run the this check.
    muted bool
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    name str
    The name of the check.
    private_locations Sequence[str]
    An array of one or more private locations slugs.
    run_parallel bool
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    tags Sequence[str]
    A list of tags for organizing and filtering checks and monitors.
    trigger_incident PlaywrightCheckSuiteTriggerIncidentArgs
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    use_global_alert_settings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).
    activated Boolean
    Determines whether the check will run periodically or not after being deployed.
    bundle Property Map
    Attaches a code bundle to the check.
    frequency Number
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    runtime Property Map
    Configure the runtime environment of the Playwright check.
    alertChannelSubscriptions List<Property Map>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    alertSettings Property Map
    Determines the alert escalation policy for the check.
    groupId Number
    The ID of the check group that this check is part of.
    groupOrder Number
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    locations List<String>
    An array of one or more data center locations where to run the this check.
    muted Boolean
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    name String
    The name of the check.
    privateLocations List<String>
    An array of one or more private locations slugs.
    runParallel Boolean
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    tags List<String>
    A list of tags for organizing and filtering checks and monitors.
    triggerIncident Property Map
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).

    Outputs

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

    Get an existing PlaywrightCheckSuite 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?: PlaywrightCheckSuiteState, opts?: CustomResourceOptions): PlaywrightCheckSuite
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            activated: Optional[bool] = None,
            alert_channel_subscriptions: Optional[Sequence[PlaywrightCheckSuiteAlertChannelSubscriptionArgs]] = None,
            alert_settings: Optional[PlaywrightCheckSuiteAlertSettingsArgs] = None,
            bundle: Optional[PlaywrightCheckSuiteBundleArgs] = None,
            frequency: Optional[int] = None,
            group_id: Optional[int] = None,
            group_order: Optional[int] = None,
            locations: Optional[Sequence[str]] = None,
            muted: Optional[bool] = None,
            name: Optional[str] = None,
            private_locations: Optional[Sequence[str]] = None,
            run_parallel: Optional[bool] = None,
            runtime: Optional[PlaywrightCheckSuiteRuntimeArgs] = None,
            tags: Optional[Sequence[str]] = None,
            trigger_incident: Optional[PlaywrightCheckSuiteTriggerIncidentArgs] = None,
            use_global_alert_settings: Optional[bool] = None) -> PlaywrightCheckSuite
    func GetPlaywrightCheckSuite(ctx *Context, name string, id IDInput, state *PlaywrightCheckSuiteState, opts ...ResourceOption) (*PlaywrightCheckSuite, error)
    public static PlaywrightCheckSuite Get(string name, Input<string> id, PlaywrightCheckSuiteState? state, CustomResourceOptions? opts = null)
    public static PlaywrightCheckSuite get(String name, Output<String> id, PlaywrightCheckSuiteState state, CustomResourceOptions options)
    resources:  _:    type: checkly:PlaywrightCheckSuite    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 whether the check will run periodically or not after being deployed.
    AlertChannelSubscriptions List<PlaywrightCheckSuiteAlertChannelSubscription>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    AlertSettings PlaywrightCheckSuiteAlertSettings
    Determines the alert escalation policy for the check.
    Bundle PlaywrightCheckSuiteBundle
    Attaches a code bundle to the check.
    Frequency int
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    GroupId int
    The ID of the check group that this check is part of.
    GroupOrder int
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    Locations List<string>
    An array of one or more data center locations where to run the this check.
    Muted bool
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    Name string
    The name of the check.
    PrivateLocations List<string>
    An array of one or more private locations slugs.
    RunParallel bool
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    Runtime PlaywrightCheckSuiteRuntime
    Configure the runtime environment of the Playwright check.
    Tags List<string>
    A list of tags for organizing and filtering checks and monitors.
    TriggerIncident PlaywrightCheckSuiteTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).
    Activated bool
    Determines whether the check will run periodically or not after being deployed.
    AlertChannelSubscriptions []PlaywrightCheckSuiteAlertChannelSubscriptionArgs
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    AlertSettings PlaywrightCheckSuiteAlertSettingsArgs
    Determines the alert escalation policy for the check.
    Bundle PlaywrightCheckSuiteBundleArgs
    Attaches a code bundle to the check.
    Frequency int
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    GroupId int
    The ID of the check group that this check is part of.
    GroupOrder int
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    Locations []string
    An array of one or more data center locations where to run the this check.
    Muted bool
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    Name string
    The name of the check.
    PrivateLocations []string
    An array of one or more private locations slugs.
    RunParallel bool
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    Runtime PlaywrightCheckSuiteRuntimeArgs
    Configure the runtime environment of the Playwright check.
    Tags []string
    A list of tags for organizing and filtering checks and monitors.
    TriggerIncident PlaywrightCheckSuiteTriggerIncidentArgs
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).
    activated Boolean
    Determines whether the check will run periodically or not after being deployed.
    alertChannelSubscriptions List<PlaywrightCheckSuiteAlertChannelSubscription>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    alertSettings PlaywrightCheckSuiteAlertSettings
    Determines the alert escalation policy for the check.
    bundle PlaywrightCheckSuiteBundle
    Attaches a code bundle to the check.
    frequency Integer
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    groupId Integer
    The ID of the check group that this check is part of.
    groupOrder Integer
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    locations List<String>
    An array of one or more data center locations where to run the this check.
    muted Boolean
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    name String
    The name of the check.
    privateLocations List<String>
    An array of one or more private locations slugs.
    runParallel Boolean
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    runtime PlaywrightCheckSuiteRuntime
    Configure the runtime environment of the Playwright check.
    tags List<String>
    A list of tags for organizing and filtering checks and monitors.
    triggerIncident PlaywrightCheckSuiteTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).
    activated boolean
    Determines whether the check will run periodically or not after being deployed.
    alertChannelSubscriptions PlaywrightCheckSuiteAlertChannelSubscription[]
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    alertSettings PlaywrightCheckSuiteAlertSettings
    Determines the alert escalation policy for the check.
    bundle PlaywrightCheckSuiteBundle
    Attaches a code bundle to the check.
    frequency number
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    groupId number
    The ID of the check group that this check is part of.
    groupOrder number
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    locations string[]
    An array of one or more data center locations where to run the this check.
    muted boolean
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    name string
    The name of the check.
    privateLocations string[]
    An array of one or more private locations slugs.
    runParallel boolean
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    runtime PlaywrightCheckSuiteRuntime
    Configure the runtime environment of the Playwright check.
    tags string[]
    A list of tags for organizing and filtering checks and monitors.
    triggerIncident PlaywrightCheckSuiteTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).
    activated bool
    Determines whether the check will run periodically or not after being deployed.
    alert_channel_subscriptions Sequence[PlaywrightCheckSuiteAlertChannelSubscriptionArgs]
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    alert_settings PlaywrightCheckSuiteAlertSettingsArgs
    Determines the alert escalation policy for the check.
    bundle PlaywrightCheckSuiteBundleArgs
    Attaches a code bundle to the check.
    frequency int
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    group_id int
    The ID of the check group that this check is part of.
    group_order int
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    locations Sequence[str]
    An array of one or more data center locations where to run the this check.
    muted bool
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    name str
    The name of the check.
    private_locations Sequence[str]
    An array of one or more private locations slugs.
    run_parallel bool
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    runtime PlaywrightCheckSuiteRuntimeArgs
    Configure the runtime environment of the Playwright check.
    tags Sequence[str]
    A list of tags for organizing and filtering checks and monitors.
    trigger_incident PlaywrightCheckSuiteTriggerIncidentArgs
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    use_global_alert_settings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).
    activated Boolean
    Determines whether the check will run periodically or not after being deployed.
    alertChannelSubscriptions List<Property Map>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you.
    alertSettings Property Map
    Determines the alert escalation policy for the check.
    bundle Property Map
    Attaches a code bundle to the check.
    frequency Number
    Controls how often the check should run. Defined in minutes. The allowed values are 1 (1 minute), 2 (2 minutes), 5 (5 minutes), 10 (10 minutes), 15 (15 minutes), 30 (30 minutes), 60 (1 hour), 120 (2 hours), 180 (3 hours), 360 (6 hours), 720 (12 hours) and 1440 (24 hours).
    groupId Number
    The ID of the check group that this check is part of.
    groupOrder Number
    The position of the check in the check group. It determines in what order checks and monitors are run when a group is triggered from the API or from CI/CD.
    locations List<String>
    An array of one or more data center locations where to run the this check.
    muted Boolean
    Determines if any notifications will be sent out when the check fails and/or recovers. (Default false).
    name String
    The name of the check.
    privateLocations List<String>
    An array of one or more private locations slugs.
    runParallel Boolean
    Determines whether the check should run on all selected locations in parallel or round-robin. (Default false).
    runtime Property Map
    Configure the runtime environment of the Playwright check.
    tags List<String>
    A list of tags for organizing and filtering checks and monitors.
    triggerIncident Property Map
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check. (Default true).

    Supporting Types

    PlaywrightCheckSuiteAlertChannelSubscription, PlaywrightCheckSuiteAlertChannelSubscriptionArgs

    Activated bool
    Whether an alert should be sent to this channel.
    ChannelId int
    The ID of the alert channel.
    Activated bool
    Whether an alert should be sent to this channel.
    ChannelId int
    The ID of the alert channel.
    activated Boolean
    Whether an alert should be sent to this channel.
    channelId Integer
    The ID of the alert channel.
    activated boolean
    Whether an alert should be sent to this channel.
    channelId number
    The ID of the alert channel.
    activated bool
    Whether an alert should be sent to this channel.
    channel_id int
    The ID of the alert channel.
    activated Boolean
    Whether an alert should be sent to this channel.
    channelId Number
    The ID of the alert channel.

    PlaywrightCheckSuiteAlertSettings, PlaywrightCheckSuiteAlertSettingsArgs

    EscalationType string
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    ParallelRunFailureThresholds List<PlaywrightCheckSuiteAlertSettingsParallelRunFailureThreshold>
    Configuration for parallel run failure threshold.
    Reminders List<PlaywrightCheckSuiteAlertSettingsReminder>
    Defines how often to send reminder notifications after initial alert.
    RunBasedEscalations List<PlaywrightCheckSuiteAlertSettingsRunBasedEscalation>
    Configuration for run-based escalation.
    TimeBasedEscalations List<PlaywrightCheckSuiteAlertSettingsTimeBasedEscalation>
    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 []PlaywrightCheckSuiteAlertSettingsParallelRunFailureThreshold
    Configuration for parallel run failure threshold.
    Reminders []PlaywrightCheckSuiteAlertSettingsReminder
    Defines how often to send reminder notifications after initial alert.
    RunBasedEscalations []PlaywrightCheckSuiteAlertSettingsRunBasedEscalation
    Configuration for run-based escalation.
    TimeBasedEscalations []PlaywrightCheckSuiteAlertSettingsTimeBasedEscalation
    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<PlaywrightCheckSuiteAlertSettingsParallelRunFailureThreshold>
    Configuration for parallel run failure threshold.
    reminders List<PlaywrightCheckSuiteAlertSettingsReminder>
    Defines how often to send reminder notifications after initial alert.
    runBasedEscalations List<PlaywrightCheckSuiteAlertSettingsRunBasedEscalation>
    Configuration for run-based escalation.
    timeBasedEscalations List<PlaywrightCheckSuiteAlertSettingsTimeBasedEscalation>
    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 PlaywrightCheckSuiteAlertSettingsParallelRunFailureThreshold[]
    Configuration for parallel run failure threshold.
    reminders PlaywrightCheckSuiteAlertSettingsReminder[]
    Defines how often to send reminder notifications after initial alert.
    runBasedEscalations PlaywrightCheckSuiteAlertSettingsRunBasedEscalation[]
    Configuration for run-based escalation.
    timeBasedEscalations PlaywrightCheckSuiteAlertSettingsTimeBasedEscalation[]
    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[PlaywrightCheckSuiteAlertSettingsParallelRunFailureThreshold]
    Configuration for parallel run failure threshold.
    reminders Sequence[PlaywrightCheckSuiteAlertSettingsReminder]
    Defines how often to send reminder notifications after initial alert.
    run_based_escalations Sequence[PlaywrightCheckSuiteAlertSettingsRunBasedEscalation]
    Configuration for run-based escalation.
    time_based_escalations Sequence[PlaywrightCheckSuiteAlertSettingsTimeBasedEscalation]
    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.
    timeBasedEscalations List<Property Map>
    Configuration for time-based escalation.

    PlaywrightCheckSuiteAlertSettingsParallelRunFailureThreshold, PlaywrightCheckSuiteAlertSettingsParallelRunFailureThresholdArgs

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

    PlaywrightCheckSuiteAlertSettingsReminder, PlaywrightCheckSuiteAlertSettingsReminderArgs

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

    PlaywrightCheckSuiteAlertSettingsRunBasedEscalation, PlaywrightCheckSuiteAlertSettingsRunBasedEscalationArgs

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

    PlaywrightCheckSuiteAlertSettingsTimeBasedEscalation, PlaywrightCheckSuiteAlertSettingsTimeBasedEscalationArgs

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

    PlaywrightCheckSuiteBundle, PlaywrightCheckSuiteBundleArgs

    Id string
    The ID of the code bundle.
    Metadata string
    The generated metadata of the code bundle.
    Id string
    The ID of the code bundle.
    Metadata string
    The generated metadata of the code bundle.
    id String
    The ID of the code bundle.
    metadata String
    The generated metadata of the code bundle.
    id string
    The ID of the code bundle.
    metadata string
    The generated metadata of the code bundle.
    id str
    The ID of the code bundle.
    metadata str
    The generated metadata of the code bundle.
    id String
    The ID of the code bundle.
    metadata String
    The generated metadata of the code bundle.

    PlaywrightCheckSuiteRuntime, PlaywrightCheckSuiteRuntimeArgs

    Playwright PlaywrightCheckSuiteRuntimePlaywright
    Configure the Playwright capabilities that should be made available to the runtime environment.
    Steps PlaywrightCheckSuiteRuntimeSteps
    Customize the actions taken during test execution.
    Playwright PlaywrightCheckSuiteRuntimePlaywright
    Configure the Playwright capabilities that should be made available to the runtime environment.
    Steps PlaywrightCheckSuiteRuntimeSteps
    Customize the actions taken during test execution.
    playwright PlaywrightCheckSuiteRuntimePlaywright
    Configure the Playwright capabilities that should be made available to the runtime environment.
    steps PlaywrightCheckSuiteRuntimeSteps
    Customize the actions taken during test execution.
    playwright PlaywrightCheckSuiteRuntimePlaywright
    Configure the Playwright capabilities that should be made available to the runtime environment.
    steps PlaywrightCheckSuiteRuntimeSteps
    Customize the actions taken during test execution.
    playwright PlaywrightCheckSuiteRuntimePlaywright
    Configure the Playwright capabilities that should be made available to the runtime environment.
    steps PlaywrightCheckSuiteRuntimeSteps
    Customize the actions taken during test execution.
    playwright Property Map
    Configure the Playwright capabilities that should be made available to the runtime environment.
    steps Property Map
    Customize the actions taken during test execution.

    PlaywrightCheckSuiteRuntimePlaywright, PlaywrightCheckSuiteRuntimePlaywrightArgs

    Devices List<PlaywrightCheckSuiteRuntimePlaywrightDevice>
    The list of devices that should be made available for Playwright.
    Version string
    The Playwright version to use.
    Devices []PlaywrightCheckSuiteRuntimePlaywrightDevice
    The list of devices that should be made available for Playwright.
    Version string
    The Playwright version to use.
    devices List<PlaywrightCheckSuiteRuntimePlaywrightDevice>
    The list of devices that should be made available for Playwright.
    version String
    The Playwright version to use.
    devices PlaywrightCheckSuiteRuntimePlaywrightDevice[]
    The list of devices that should be made available for Playwright.
    version string
    The Playwright version to use.
    devices Sequence[PlaywrightCheckSuiteRuntimePlaywrightDevice]
    The list of devices that should be made available for Playwright.
    version str
    The Playwright version to use.
    devices List<Property Map>
    The list of devices that should be made available for Playwright.
    version String
    The Playwright version to use.

    PlaywrightCheckSuiteRuntimePlaywrightDevice, PlaywrightCheckSuiteRuntimePlaywrightDeviceArgs

    Type string
    The type of the device.
    Type string
    The type of the device.
    type String
    The type of the device.
    type string
    The type of the device.
    type str
    The type of the device.
    type String
    The type of the device.

    PlaywrightCheckSuiteRuntimeSteps, PlaywrightCheckSuiteRuntimeStepsArgs

    Install PlaywrightCheckSuiteRuntimeStepsInstall
    Customize the install step, which is used to initialize the environment prior to starting the test run.
    Test PlaywrightCheckSuiteRuntimeStepsTest
    Customize the test step.
    Install PlaywrightCheckSuiteRuntimeStepsInstall
    Customize the install step, which is used to initialize the environment prior to starting the test run.
    Test PlaywrightCheckSuiteRuntimeStepsTest
    Customize the test step.
    install PlaywrightCheckSuiteRuntimeStepsInstall
    Customize the install step, which is used to initialize the environment prior to starting the test run.
    test PlaywrightCheckSuiteRuntimeStepsTest
    Customize the test step.
    install PlaywrightCheckSuiteRuntimeStepsInstall
    Customize the install step, which is used to initialize the environment prior to starting the test run.
    test PlaywrightCheckSuiteRuntimeStepsTest
    Customize the test step.
    install PlaywrightCheckSuiteRuntimeStepsInstall
    Customize the install step, which is used to initialize the environment prior to starting the test run.
    test PlaywrightCheckSuiteRuntimeStepsTest
    Customize the test step.
    install Property Map
    Customize the install step, which is used to initialize the environment prior to starting the test run.
    test Property Map
    Customize the test step.

    PlaywrightCheckSuiteRuntimeStepsInstall, PlaywrightCheckSuiteRuntimeStepsInstallArgs

    Command string
    The command used to install dependencies prior to running Playwright. The default value is the appropriate install command for your package manager (e.g. npm install for npm).
    Command string
    The command used to install dependencies prior to running Playwright. The default value is the appropriate install command for your package manager (e.g. npm install for npm).
    command String
    The command used to install dependencies prior to running Playwright. The default value is the appropriate install command for your package manager (e.g. npm install for npm).
    command string
    The command used to install dependencies prior to running Playwright. The default value is the appropriate install command for your package manager (e.g. npm install for npm).
    command str
    The command used to install dependencies prior to running Playwright. The default value is the appropriate install command for your package manager (e.g. npm install for npm).
    command String
    The command used to install dependencies prior to running Playwright. The default value is the appropriate install command for your package manager (e.g. npm install for npm).

    PlaywrightCheckSuiteRuntimeStepsTest, PlaywrightCheckSuiteRuntimeStepsTestArgs

    Command string
    The command used to run Playwright. The default value is the appropriate exec command for your package manager (e.g. npx playwright test for npm).
    Command string
    The command used to run Playwright. The default value is the appropriate exec command for your package manager (e.g. npx playwright test for npm).
    command String
    The command used to run Playwright. The default value is the appropriate exec command for your package manager (e.g. npx playwright test for npm).
    command string
    The command used to run Playwright. The default value is the appropriate exec command for your package manager (e.g. npx playwright test for npm).
    command str
    The command used to run Playwright. The default value is the appropriate exec command for your package manager (e.g. npx playwright test for npm).
    command String
    The command used to run Playwright. The default value is the appropriate exec command for your package manager (e.g. npx playwright test for npm).

    PlaywrightCheckSuiteTriggerIncident, PlaywrightCheckSuiteTriggerIncidentArgs

    Description string
    A detailed description of the incident.
    Name string
    The name of the incident.
    NotifySubscribers bool
    Whether to notify subscribers when the incident is triggered.
    ServiceId string
    The status page service that this incident will be associated with.
    Severity string
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.
    Description string
    A detailed description of the incident.
    Name string
    The name of the incident.
    NotifySubscribers bool
    Whether to notify subscribers when the incident is triggered.
    ServiceId string
    The status page service that this incident will be associated with.
    Severity string
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.
    description String
    A detailed description of the incident.
    name String
    The name of the incident.
    notifySubscribers Boolean
    Whether to notify subscribers when the incident is triggered.
    serviceId String
    The status page service that this incident will be associated with.
    severity String
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.
    description string
    A detailed description of the incident.
    name string
    The name of the incident.
    notifySubscribers boolean
    Whether to notify subscribers when the incident is triggered.
    serviceId string
    The status page service that this incident will be associated with.
    severity string
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.
    description str
    A detailed description of the incident.
    name str
    The name of the incident.
    notify_subscribers bool
    Whether to notify subscribers when the incident is triggered.
    service_id str
    The status page service that this incident will be associated with.
    severity str
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.
    description String
    A detailed description of the incident.
    name String
    The name of the incident.
    notifySubscribers Boolean
    Whether to notify subscribers when the incident is triggered.
    serviceId String
    The status page service that this incident will be associated with.
    severity String
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.

    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.8.0 published on Monday, Mar 2, 2026 by Checkly
      Try Pulumi Cloud free. Your team will thank you.