1. Registry
  2. Packages
  3. Checkly
  4. API Docs
  5. StatusPageV3AutomationRule
Viewing docs for Checkly v2.14.0
published on Friday, Oct 9, 2026 by Checkly
checkly logo Checkly
Viewing docs for Checkly v2.14.0
published on Friday, Oct 9, 2026 by Checkly

    An automation rule of a v3 status page. When a check whose tags overlap with the rule’s tags fails, Checkly opens one incident on the page impacting the listed components, and resolves it when the check recovers. Import uses the composite ID <status_page_id>/<rule_id>.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as checkly from "@checkly/pulumi";
    
    const example = new checkly.StatusPageV3("example", {
        name: "Example Application",
        url: "my-example-status-page",
    });
    const api = new checkly.StatusPageV3Component("api", {
        statusPageId: example.id,
        name: "API",
        displayOrder: 0,
    });
    // When a check tagged "api" fails, an incident is opened on the page marking
    // the API component as a major outage, and resolved when the check recovers.
    const apiOutage = new checkly.StatusPageV3AutomationRule("api_outage", {
        statusPageId: example.id,
        name: "API outage",
        firstUpdate: "We are investigating an issue with the API.",
        lastUpdate: "The issue has been resolved.",
        tags: ["api"],
        components: [{
            componentId: api.id,
            targetImpact: "MAJOR_OUTAGE",
        }],
    });
    
    import pulumi
    import pulumi_checkly as checkly
    
    example = checkly.StatusPageV3("example",
        name="Example Application",
        url="my-example-status-page")
    api = checkly.StatusPageV3Component("api",
        status_page_id=example.id,
        name="API",
        display_order=0)
    # When a check tagged "api" fails, an incident is opened on the page marking
    # the API component as a major outage, and resolved when the check recovers.
    api_outage = checkly.StatusPageV3AutomationRule("api_outage",
        status_page_id=example.id,
        name="API outage",
        first_update="We are investigating an issue with the API.",
        last_update="The issue has been resolved.",
        tags=["api"],
        components=[{
            "component_id": api.id,
            "target_impact": "MAJOR_OUTAGE",
        }])
    
    package main
    
    import (
    	"github.com/checkly/pulumi-checkly/sdk/v2/go/checkly"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := checkly.NewStatusPageV3(ctx, "example", &checkly.StatusPageV3Args{
    			Name: pulumi.String("Example Application"),
    			Url:  pulumi.String("my-example-status-page"),
    		})
    		if err != nil {
    			return err
    		}
    		api, err := checkly.NewStatusPageV3Component(ctx, "api", &checkly.StatusPageV3ComponentArgs{
    			StatusPageId: example.ID(),
    			Name:         pulumi.String("API"),
    			DisplayOrder: pulumi.Int(0),
    		})
    		if err != nil {
    			return err
    		}
    		// When a check tagged "api" fails, an incident is opened on the page marking
    		// the API component as a major outage, and resolved when the check recovers.
    		_, err = checkly.NewStatusPageV3AutomationRule(ctx, "api_outage", &checkly.StatusPageV3AutomationRuleArgs{
    			StatusPageId: example.ID(),
    			Name:         pulumi.String("API outage"),
    			FirstUpdate:  pulumi.String("We are investigating an issue with the API."),
    			LastUpdate:   pulumi.String("The issue has been resolved."),
    			Tags: pulumi.StringArray{
    				pulumi.String("api"),
    			},
    			Components: checkly.StatusPageV3AutomationRuleComponentArray{
    				&checkly.StatusPageV3AutomationRuleComponentArgs{
    					ComponentId:  api.ID(),
    					TargetImpact: pulumi.String("MAJOR_OUTAGE"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Checkly = Pulumi.Checkly;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Checkly.StatusPageV3("example", new()
        {
            Name = "Example Application",
            Url = "my-example-status-page",
        });
    
        var api = new Checkly.StatusPageV3Component("api", new()
        {
            StatusPageId = example.Id,
            Name = "API",
            DisplayOrder = 0,
        });
    
        // When a check tagged "api" fails, an incident is opened on the page marking
        // the API component as a major outage, and resolved when the check recovers.
        var apiOutage = new Checkly.StatusPageV3AutomationRule("api_outage", new()
        {
            StatusPageId = example.Id,
            Name = "API outage",
            FirstUpdate = "We are investigating an issue with the API.",
            LastUpdate = "The issue has been resolved.",
            Tags = new[]
            {
                "api",
            },
            Components = new[]
            {
                new Checkly.Inputs.StatusPageV3AutomationRuleComponentArgs
                {
                    ComponentId = api.Id,
                    TargetImpact = "MAJOR_OUTAGE",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.checkly.StatusPageV3;
    import com.pulumi.checkly.StatusPageV3Args;
    import com.pulumi.checkly.StatusPageV3Component;
    import com.pulumi.checkly.StatusPageV3ComponentArgs;
    import com.pulumi.checkly.StatusPageV3AutomationRule;
    import com.pulumi.checkly.StatusPageV3AutomationRuleArgs;
    import com.pulumi.checkly.inputs.StatusPageV3AutomationRuleComponentArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new StatusPageV3("example", StatusPageV3Args.builder()
                .name("Example Application")
                .url("my-example-status-page")
                .build());
    
            var api = new StatusPageV3Component("api", StatusPageV3ComponentArgs.builder()
                .statusPageId(example.id())
                .name("API")
                .displayOrder(0)
                .build());
    
            // When a check tagged "api" fails, an incident is opened on the page marking
            // the API component as a major outage, and resolved when the check recovers.
            var apiOutage = new StatusPageV3AutomationRule("apiOutage", StatusPageV3AutomationRuleArgs.builder()
                .statusPageId(example.id())
                .name("API outage")
                .firstUpdate("We are investigating an issue with the API.")
                .lastUpdate("The issue has been resolved.")
                .tags("api")
                .components(StatusPageV3AutomationRuleComponentArgs.builder()
                    .componentId(api.id())
                    .targetImpact("MAJOR_OUTAGE")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: checkly:StatusPageV3
        properties:
          name: Example Application
          url: my-example-status-page
      api:
        type: checkly:StatusPageV3Component
        properties:
          statusPageId: ${example.id}
          name: API
          displayOrder: 0
      # When a check tagged "api" fails, an incident is opened on the page marking
      # the API component as a major outage, and resolved when the check recovers.
      apiOutage:
        type: checkly:StatusPageV3AutomationRule
        name: api_outage
        properties:
          statusPageId: ${example.id}
          name: API outage
          firstUpdate: We are investigating an issue with the API.
          lastUpdate: The issue has been resolved.
          tags:
            - api
          components:
            - componentId: ${api.id}
              targetImpact: MAJOR_OUTAGE
    
    Example coming soon!
    

    Create StatusPageV3AutomationRule Resource

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

    Constructor syntax

    new StatusPageV3AutomationRule(name: string, args: StatusPageV3AutomationRuleArgs, opts?: CustomResourceOptions);
    @overload
    def StatusPageV3AutomationRule(resource_name: str,
                                   args: StatusPageV3AutomationRuleArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def StatusPageV3AutomationRule(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   first_update: Optional[str] = None,
                                   last_update: Optional[str] = None,
                                   status_page_id: Optional[str] = None,
                                   tags: Optional[Sequence[str]] = None,
                                   components: Optional[Sequence[StatusPageV3AutomationRuleComponentArgs]] = None,
                                   cool_down_window_minutes: Optional[int] = None,
                                   enabled: Optional[bool] = None,
                                   name: Optional[str] = None,
                                   notify_subscribers: Optional[bool] = None)
    func NewStatusPageV3AutomationRule(ctx *Context, name string, args StatusPageV3AutomationRuleArgs, opts ...ResourceOption) (*StatusPageV3AutomationRule, error)
    public StatusPageV3AutomationRule(string name, StatusPageV3AutomationRuleArgs args, CustomResourceOptions? opts = null)
    public StatusPageV3AutomationRule(String name, StatusPageV3AutomationRuleArgs args)
    public StatusPageV3AutomationRule(String name, StatusPageV3AutomationRuleArgs args, CustomResourceOptions options)
    
    type: checkly:StatusPageV3AutomationRule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "checkly_status_page_v3_automation_rule" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args StatusPageV3AutomationRuleArgs
    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 StatusPageV3AutomationRuleArgs
    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 StatusPageV3AutomationRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StatusPageV3AutomationRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StatusPageV3AutomationRuleArgs
    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 statusPageV3AutomationRuleResource = new Checkly.StatusPageV3AutomationRule("statusPageV3AutomationRuleResource", new()
    {
        FirstUpdate = "string",
        LastUpdate = "string",
        StatusPageId = "string",
        Tags = new[]
        {
            "string",
        },
        Components = new[]
        {
            new Checkly.Inputs.StatusPageV3AutomationRuleComponentArgs
            {
                ComponentId = "string",
                TargetImpact = "string",
            },
        },
        CoolDownWindowMinutes = 0,
        Enabled = false,
        Name = "string",
        NotifySubscribers = false,
    });
    
    example, err := checkly.NewStatusPageV3AutomationRule(ctx, "statusPageV3AutomationRuleResource", &checkly.StatusPageV3AutomationRuleArgs{
    	FirstUpdate:  pulumi.String("string"),
    	LastUpdate:   pulumi.String("string"),
    	StatusPageId: pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Components: checkly.StatusPageV3AutomationRuleComponentArray{
    		&checkly.StatusPageV3AutomationRuleComponentArgs{
    			ComponentId:  pulumi.String("string"),
    			TargetImpact: pulumi.String("string"),
    		},
    	},
    	CoolDownWindowMinutes: pulumi.Int(0),
    	Enabled:               pulumi.Bool(false),
    	Name:                  pulumi.String("string"),
    	NotifySubscribers:     pulumi.Bool(false),
    })
    
    resource "checkly_status_page_v3_automation_rule" "statusPageV3AutomationRuleResource" {
      lifecycle {
        create_before_destroy = true
      }
      first_update   = "string"
      last_update    = "string"
      status_page_id = "string"
      tags           = ["string"]
      components {
        component_id  = "string"
        target_impact = "string"
      }
      cool_down_window_minutes = 0
      enabled                  = false
      name                     = "string"
      notify_subscribers       = false
    }
    
    var statusPageV3AutomationRuleResource = new StatusPageV3AutomationRule("statusPageV3AutomationRuleResource", StatusPageV3AutomationRuleArgs.builder()
        .firstUpdate("string")
        .lastUpdate("string")
        .statusPageId("string")
        .tags("string")
        .components(StatusPageV3AutomationRuleComponentArgs.builder()
            .componentId("string")
            .targetImpact("string")
            .build())
        .coolDownWindowMinutes(0)
        .enabled(false)
        .name("string")
        .notifySubscribers(false)
        .build());
    
    status_page_v3_automation_rule_resource = checkly.StatusPageV3AutomationRule("statusPageV3AutomationRuleResource",
        first_update="string",
        last_update="string",
        status_page_id="string",
        tags=["string"],
        components=[{
            "component_id": "string",
            "target_impact": "string",
        }],
        cool_down_window_minutes=0,
        enabled=False,
        name="string",
        notify_subscribers=False)
    
    const statusPageV3AutomationRuleResource = new checkly.StatusPageV3AutomationRule("statusPageV3AutomationRuleResource", {
        firstUpdate: "string",
        lastUpdate: "string",
        statusPageId: "string",
        tags: ["string"],
        components: [{
            componentId: "string",
            targetImpact: "string",
        }],
        coolDownWindowMinutes: 0,
        enabled: false,
        name: "string",
        notifySubscribers: false,
    });
    
    type: checkly:StatusPageV3AutomationRule
    properties:
        components:
            - componentId: string
              targetImpact: string
        coolDownWindowMinutes: 0
        enabled: false
        firstUpdate: string
        lastUpdate: string
        name: string
        notifySubscribers: false
        statusPageId: string
        tags:
            - string
    

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

    FirstUpdate string
    Body of the status update that opens the incident.
    LastUpdate string
    Body of the status update that resolves the incident.
    StatusPageId string
    The ID of the v3 status page the rule belongs to.
    Tags List<string>
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    Components List<StatusPageV3AutomationRuleComponent>
    The components an automated incident impacts, with the impact each gets.
    CoolDownWindowMinutes int
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    Enabled bool
    A disabled rule never opens incidents. (Default true).
    Name string
    The name of the rule.
    NotifySubscribers bool
    Whether subscribers are notified of the automated updates. (Default true).
    FirstUpdate string
    Body of the status update that opens the incident.
    LastUpdate string
    Body of the status update that resolves the incident.
    StatusPageId string
    The ID of the v3 status page the rule belongs to.
    Tags []string
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    Components []StatusPageV3AutomationRuleComponentArgs
    The components an automated incident impacts, with the impact each gets.
    CoolDownWindowMinutes int
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    Enabled bool
    A disabled rule never opens incidents. (Default true).
    Name string
    The name of the rule.
    NotifySubscribers bool
    Whether subscribers are notified of the automated updates. (Default true).
    first_update string
    Body of the status update that opens the incident.
    last_update string
    Body of the status update that resolves the incident.
    status_page_id string
    The ID of the v3 status page the rule belongs to.
    tags list(string)
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    components list(object)
    The components an automated incident impacts, with the impact each gets.
    cool_down_window_minutes number
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    enabled bool
    A disabled rule never opens incidents. (Default true).
    name string
    The name of the rule.
    notify_subscribers bool
    Whether subscribers are notified of the automated updates. (Default true).
    firstUpdate String
    Body of the status update that opens the incident.
    lastUpdate String
    Body of the status update that resolves the incident.
    statusPageId String
    The ID of the v3 status page the rule belongs to.
    tags List<String>
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    components List<StatusPageV3AutomationRuleComponent>
    The components an automated incident impacts, with the impact each gets.
    coolDownWindowMinutes Integer
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    enabled Boolean
    A disabled rule never opens incidents. (Default true).
    name String
    The name of the rule.
    notifySubscribers Boolean
    Whether subscribers are notified of the automated updates. (Default true).
    firstUpdate string
    Body of the status update that opens the incident.
    lastUpdate string
    Body of the status update that resolves the incident.
    statusPageId string
    The ID of the v3 status page the rule belongs to.
    tags string[]
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    components StatusPageV3AutomationRuleComponent[]
    The components an automated incident impacts, with the impact each gets.
    coolDownWindowMinutes number
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    enabled boolean
    A disabled rule never opens incidents. (Default true).
    name string
    The name of the rule.
    notifySubscribers boolean
    Whether subscribers are notified of the automated updates. (Default true).
    first_update str
    Body of the status update that opens the incident.
    last_update str
    Body of the status update that resolves the incident.
    status_page_id str
    The ID of the v3 status page the rule belongs to.
    tags Sequence[str]
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    components Sequence[StatusPageV3AutomationRuleComponentArgs]
    The components an automated incident impacts, with the impact each gets.
    cool_down_window_minutes int
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    enabled bool
    A disabled rule never opens incidents. (Default true).
    name str
    The name of the rule.
    notify_subscribers bool
    Whether subscribers are notified of the automated updates. (Default true).
    firstUpdate String
    Body of the status update that opens the incident.
    lastUpdate String
    Body of the status update that resolves the incident.
    statusPageId String
    The ID of the v3 status page the rule belongs to.
    tags List<String>
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    components List<Property Map>
    The components an automated incident impacts, with the impact each gets.
    coolDownWindowMinutes Number
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    enabled Boolean
    A disabled rule never opens incidents. (Default true).
    name String
    The name of the rule.
    notifySubscribers Boolean
    Whether subscribers are notified of the automated updates. (Default true).

    Outputs

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

    Get an existing StatusPageV3AutomationRule 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?: StatusPageV3AutomationRuleState, opts?: CustomResourceOptions): StatusPageV3AutomationRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            components: Optional[Sequence[StatusPageV3AutomationRuleComponentArgs]] = None,
            cool_down_window_minutes: Optional[int] = None,
            enabled: Optional[bool] = None,
            first_update: Optional[str] = None,
            last_update: Optional[str] = None,
            name: Optional[str] = None,
            notify_subscribers: Optional[bool] = None,
            status_page_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None) -> StatusPageV3AutomationRule
    func GetStatusPageV3AutomationRule(ctx *Context, name string, id IDInput, state *StatusPageV3AutomationRuleState, opts ...ResourceOption) (*StatusPageV3AutomationRule, error)
    public static StatusPageV3AutomationRule Get(string name, Input<string> id, StatusPageV3AutomationRuleState? state, CustomResourceOptions? opts = null)
    public static StatusPageV3AutomationRule get(String name, Output<String> id, StatusPageV3AutomationRuleState state, CustomResourceOptions options)
    resources:  _:    type: checkly:StatusPageV3AutomationRule    get:      id: ${id}
    import {
      to = checkly_status_page_v3_automation_rule.example
      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:
    Components List<StatusPageV3AutomationRuleComponent>
    The components an automated incident impacts, with the impact each gets.
    CoolDownWindowMinutes int
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    Enabled bool
    A disabled rule never opens incidents. (Default true).
    FirstUpdate string
    Body of the status update that opens the incident.
    LastUpdate string
    Body of the status update that resolves the incident.
    Name string
    The name of the rule.
    NotifySubscribers bool
    Whether subscribers are notified of the automated updates. (Default true).
    StatusPageId string
    The ID of the v3 status page the rule belongs to.
    Tags List<string>
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    Components []StatusPageV3AutomationRuleComponentArgs
    The components an automated incident impacts, with the impact each gets.
    CoolDownWindowMinutes int
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    Enabled bool
    A disabled rule never opens incidents. (Default true).
    FirstUpdate string
    Body of the status update that opens the incident.
    LastUpdate string
    Body of the status update that resolves the incident.
    Name string
    The name of the rule.
    NotifySubscribers bool
    Whether subscribers are notified of the automated updates. (Default true).
    StatusPageId string
    The ID of the v3 status page the rule belongs to.
    Tags []string
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    components list(object)
    The components an automated incident impacts, with the impact each gets.
    cool_down_window_minutes number
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    enabled bool
    A disabled rule never opens incidents. (Default true).
    first_update string
    Body of the status update that opens the incident.
    last_update string
    Body of the status update that resolves the incident.
    name string
    The name of the rule.
    notify_subscribers bool
    Whether subscribers are notified of the automated updates. (Default true).
    status_page_id string
    The ID of the v3 status page the rule belongs to.
    tags list(string)
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    components List<StatusPageV3AutomationRuleComponent>
    The components an automated incident impacts, with the impact each gets.
    coolDownWindowMinutes Integer
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    enabled Boolean
    A disabled rule never opens incidents. (Default true).
    firstUpdate String
    Body of the status update that opens the incident.
    lastUpdate String
    Body of the status update that resolves the incident.
    name String
    The name of the rule.
    notifySubscribers Boolean
    Whether subscribers are notified of the automated updates. (Default true).
    statusPageId String
    The ID of the v3 status page the rule belongs to.
    tags List<String>
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    components StatusPageV3AutomationRuleComponent[]
    The components an automated incident impacts, with the impact each gets.
    coolDownWindowMinutes number
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    enabled boolean
    A disabled rule never opens incidents. (Default true).
    firstUpdate string
    Body of the status update that opens the incident.
    lastUpdate string
    Body of the status update that resolves the incident.
    name string
    The name of the rule.
    notifySubscribers boolean
    Whether subscribers are notified of the automated updates. (Default true).
    statusPageId string
    The ID of the v3 status page the rule belongs to.
    tags string[]
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    components Sequence[StatusPageV3AutomationRuleComponentArgs]
    The components an automated incident impacts, with the impact each gets.
    cool_down_window_minutes int
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    enabled bool
    A disabled rule never opens incidents. (Default true).
    first_update str
    Body of the status update that opens the incident.
    last_update str
    Body of the status update that resolves the incident.
    name str
    The name of the rule.
    notify_subscribers bool
    Whether subscribers are notified of the automated updates. (Default true).
    status_page_id str
    The ID of the v3 status page the rule belongs to.
    tags Sequence[str]
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.
    components List<Property Map>
    The components an automated incident impacts, with the impact each gets.
    coolDownWindowMinutes Number
    Minimum minutes after an automated incident before this rule may open the next one. 0 disables the cool down. (Default 5).
    enabled Boolean
    A disabled rule never opens incidents. (Default true).
    firstUpdate String
    Body of the status update that opens the incident.
    lastUpdate String
    Body of the status update that resolves the incident.
    name String
    The name of the rule.
    notifySubscribers Boolean
    Whether subscribers are notified of the automated updates. (Default true).
    statusPageId String
    The ID of the v3 status page the rule belongs to.
    tags List<String>
    A failing check matches this rule when it, or its group, carries ANY of these tags. At least one tag is required.

    Supporting Types

    StatusPageV3AutomationRuleComponent, StatusPageV3AutomationRuleComponentArgs

    ComponentId string
    The ID of the impacted component. Must be on the same status page.
    TargetImpact string
    The impact set on the component while the incident is open. The allowed values are UNDER_MAINTENANCE, DEGRADED_PERFORMANCE, PARTIAL_OUTAGE and MAJOR_OUTAGE.
    ComponentId string
    The ID of the impacted component. Must be on the same status page.
    TargetImpact string
    The impact set on the component while the incident is open. The allowed values are UNDER_MAINTENANCE, DEGRADED_PERFORMANCE, PARTIAL_OUTAGE and MAJOR_OUTAGE.
    component_id string
    The ID of the impacted component. Must be on the same status page.
    target_impact string
    The impact set on the component while the incident is open. The allowed values are UNDER_MAINTENANCE, DEGRADED_PERFORMANCE, PARTIAL_OUTAGE and MAJOR_OUTAGE.
    componentId String
    The ID of the impacted component. Must be on the same status page.
    targetImpact String
    The impact set on the component while the incident is open. The allowed values are UNDER_MAINTENANCE, DEGRADED_PERFORMANCE, PARTIAL_OUTAGE and MAJOR_OUTAGE.
    componentId string
    The ID of the impacted component. Must be on the same status page.
    targetImpact string
    The impact set on the component while the incident is open. The allowed values are UNDER_MAINTENANCE, DEGRADED_PERFORMANCE, PARTIAL_OUTAGE and MAJOR_OUTAGE.
    component_id str
    The ID of the impacted component. Must be on the same status page.
    target_impact str
    The impact set on the component while the incident is open. The allowed values are UNDER_MAINTENANCE, DEGRADED_PERFORMANCE, PARTIAL_OUTAGE and MAJOR_OUTAGE.
    componentId String
    The ID of the impacted component. Must be on the same status page.
    targetImpact String
    The impact set on the component while the incident is open. The allowed values are UNDER_MAINTENANCE, DEGRADED_PERFORMANCE, PARTIAL_OUTAGE and MAJOR_OUTAGE.

    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
    Viewing docs for Checkly v2.14.0
    published on Friday, Oct 9, 2026 by Checkly

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial