Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Checkly
  4. API Docs
  5. MaintenanceWindow
Viewing docs for Checkly v2.14.0
published on Friday, Oct 9, 2026 by Checkly
Schema (JSON)
checkly/pulumi-checkly

checkly.MaintenanceWindow

checkly logo Checkly
Viewing docs for Checkly v2.14.0
published on Friday, Oct 9, 2026 by Checkly
Schema (JSON)
checkly/pulumi-checkly

    Example Usage

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

const maintenance_1 = new checkly.MaintenanceWindow("maintenance-1", {
    name: "Maintenance Windows",
    startsAt: "2014-08-24T00:00:00.000Z",
    endsAt: "2014-08-25T00:00:00.000Z",
    repeatUnit: "MONTH",
    repeatEndsAt: "2014-08-24T00:00:00.000Z",
    repeatInterval: 1,
    tags: ["production"],
    timezone: "America/New_York",
    description: "Monthly database maintenance",
    silenceAlertsTags: ["production"],
});
// Show a maintenance window on a status page
const api = new checkly.StatusPageService("api", {name: "API"});
const example = new checkly.StatusPage("example", {
    name: "Example Application",
    url: "my-example-status-page",
    cards: [{
        name: "Services",
        serviceAttachments: [{
            serviceId: api.id,
        }],
    }],
});
const maintenance_2 = new checkly.MaintenanceWindow("maintenance-2", {
    name: "Status page maintenance",
    startsAt: "2028-08-24T00:00:00.000Z",
    endsAt: "2028-08-24T02:00:00.000Z",
    tags: ["api"],
    description: "We're upgrading our API servers.",
    statusPageVisibility: {
        enabled: true,
        severity: "MINOR",
        notifyOnStart: true,
        statusPageIds: [example.id],
        serviceIds: [api.id],
    },
});

    import pulumi
import pulumi_checkly as checkly

maintenance_1 = checkly.MaintenanceWindow("maintenance-1",
    name="Maintenance Windows",
    starts_at="2014-08-24T00:00:00.000Z",
    ends_at="2014-08-25T00:00:00.000Z",
    repeat_unit="MONTH",
    repeat_ends_at="2014-08-24T00:00:00.000Z",
    repeat_interval=1,
    tags=["production"],
    timezone="America/New_York",
    description="Monthly database maintenance",
    silence_alerts_tags=["production"])
# Show a maintenance window on a status page
api = checkly.StatusPageService("api", name="API")
example = checkly.StatusPage("example",
    name="Example Application",
    url="my-example-status-page",
    cards=[{
        "name": "Services",
        "service_attachments": [{
            "service_id": api.id,
        }],
    }])
maintenance_2 = checkly.MaintenanceWindow("maintenance-2",
    name="Status page maintenance",
    starts_at="2028-08-24T00:00:00.000Z",
    ends_at="2028-08-24T02:00:00.000Z",
    tags=["api"],
    description="We're upgrading our API servers.",
    status_page_visibility={
        "enabled": True,
        "severity": "MINOR",
        "notify_on_start": True,
        "status_page_ids": [example.id],
        "service_ids": [api.id],
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkly.NewMaintenanceWindow(ctx, "maintenance-1", &checkly.MaintenanceWindowArgs{
			Name:           pulumi.String("Maintenance Windows"),
			StartsAt:       pulumi.String("2014-08-24T00:00:00.000Z"),
			EndsAt:         pulumi.String("2014-08-25T00:00:00.000Z"),
			RepeatUnit:     pulumi.String("MONTH"),
			RepeatEndsAt:   pulumi.String("2014-08-24T00:00:00.000Z"),
			RepeatInterval: pulumi.Int(1),
			Tags: pulumi.StringArray{
				pulumi.String("production"),
			},
			Timezone:    pulumi.String("America/New_York"),
			Description: pulumi.String("Monthly database maintenance"),
			SilenceAlertsTags: pulumi.StringArray{
				pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		// Show a maintenance window on a status page
		api, err := checkly.NewStatusPageService(ctx, "api", &checkly.StatusPageServiceArgs{
			Name: pulumi.String("API"),
		})
		if err != nil {
			return err
		}
		example, err := checkly.NewStatusPage(ctx, "example", &checkly.StatusPageArgs{
			Name: pulumi.String("Example Application"),
			Url:  pulumi.String("my-example-status-page"),
			Cards: checkly.StatusPageCardArray{
				&checkly.StatusPageCardArgs{
					Name: pulumi.String("Services"),
					ServiceAttachments: checkly.StatusPageCardServiceAttachmentArray{
						&checkly.StatusPageCardServiceAttachmentArgs{
							ServiceId: api.ID(),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = checkly.NewMaintenanceWindow(ctx, "maintenance-2", &checkly.MaintenanceWindowArgs{
			Name:     pulumi.String("Status page maintenance"),
			StartsAt: pulumi.String("2028-08-24T00:00:00.000Z"),
			EndsAt:   pulumi.String("2028-08-24T02:00:00.000Z"),
			Tags: pulumi.StringArray{
				pulumi.String("api"),
			},
			Description: pulumi.String("We're upgrading our API servers."),
			StatusPageVisibility: &checkly.MaintenanceWindowStatusPageVisibilityArgs{
				Enabled:       pulumi.Bool(true),
				Severity:      pulumi.String("MINOR"),
				NotifyOnStart: pulumi.Bool(true),
				StatusPageIds: pulumi.StringArray{
					example.ID(),
				},
				ServiceIds: pulumi.StringArray{
					api.ID(),
				},
			},
		})
		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 maintenance_1 = new Checkly.MaintenanceWindow("maintenance-1", new()
    {
        Name = "Maintenance Windows",
        StartsAt = "2014-08-24T00:00:00.000Z",
        EndsAt = "2014-08-25T00:00:00.000Z",
        RepeatUnit = "MONTH",
        RepeatEndsAt = "2014-08-24T00:00:00.000Z",
        RepeatInterval = 1,
        Tags = new[]
        {
            "production",
        },
        Timezone = "America/New_York",
        Description = "Monthly database maintenance",
        SilenceAlertsTags = new[]
        {
            "production",
        },
    });

    // Show a maintenance window on a status page
    var api = new Checkly.StatusPageService("api", new()
    {
        Name = "API",
    });

    var example = new Checkly.StatusPage("example", new()
    {
        Name = "Example Application",
        Url = "my-example-status-page",
        Cards = new[]
        {
            new Checkly.Inputs.StatusPageCardArgs
            {
                Name = "Services",
                ServiceAttachments = new[]
                {
                    new Checkly.Inputs.StatusPageCardServiceAttachmentArgs
                    {
                        ServiceId = api.Id,
                    },
                },
            },
        },
    });

    var maintenance_2 = new Checkly.MaintenanceWindow("maintenance-2", new()
    {
        Name = "Status page maintenance",
        StartsAt = "2028-08-24T00:00:00.000Z",
        EndsAt = "2028-08-24T02:00:00.000Z",
        Tags = new[]
        {
            "api",
        },
        Description = "We're upgrading our API servers.",
        StatusPageVisibility = new Checkly.Inputs.MaintenanceWindowStatusPageVisibilityArgs
        {
            Enabled = true,
            Severity = "MINOR",
            NotifyOnStart = true,
            StatusPageIds = new[]
            {
                example.Id,
            },
            ServiceIds = new[]
            {
                api.Id,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkly.MaintenanceWindow;
import com.pulumi.checkly.MaintenanceWindowArgs;
import com.pulumi.checkly.StatusPageService;
import com.pulumi.checkly.StatusPageServiceArgs;
import com.pulumi.checkly.StatusPage;
import com.pulumi.checkly.StatusPageArgs;
import com.pulumi.checkly.inputs.StatusPageCardArgs;
import com.pulumi.checkly.inputs.MaintenanceWindowStatusPageVisibilityArgs;
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 maintenance_1 = new MaintenanceWindow("maintenance-1", MaintenanceWindowArgs.builder()
            .name("Maintenance Windows")
            .startsAt("2014-08-24T00:00:00.000Z")
            .endsAt("2014-08-25T00:00:00.000Z")
            .repeatUnit("MONTH")
            .repeatEndsAt("2014-08-24T00:00:00.000Z")
            .repeatInterval(1)
            .tags("production")
            .timezone("America/New_York")
            .description("Monthly database maintenance")
            .silenceAlertsTags("production")
            .build());

        // Show a maintenance window on a status page
        var api = new StatusPageService("api", StatusPageServiceArgs.builder()
            .name("API")
            .build());

        var example = new StatusPage("example", StatusPageArgs.builder()
            .name("Example Application")
            .url("my-example-status-page")
            .cards(StatusPageCardArgs.builder()
                .name("Services")
                .serviceAttachments(StatusPageCardServiceAttachmentArgs.builder()
                    .serviceId(api.id())
                    .build())
                .build())
            .build());

        var maintenance_2 = new MaintenanceWindow("maintenance-2", MaintenanceWindowArgs.builder()
            .name("Status page maintenance")
            .startsAt("2028-08-24T00:00:00.000Z")
            .endsAt("2028-08-24T02:00:00.000Z")
            .tags("api")
            .description("We're upgrading our API servers.")
            .statusPageVisibility(MaintenanceWindowStatusPageVisibilityArgs.builder()
                .enabled(true)
                .severity("MINOR")
                .notifyOnStart(true)
                .statusPageIds(example.id())
                .serviceIds(api.id())
                .build())
            .build());

    }
}

    resources:
  maintenance-1:
    type: checkly:MaintenanceWindow
    properties:
      name: Maintenance Windows
      startsAt: 2014-08-24T00:00:00.000Z
      endsAt: 2014-08-25T00:00:00.000Z
      repeatUnit: MONTH
      repeatEndsAt: 2014-08-24T00:00:00.000Z
      repeatInterval: 1
      tags:
        - production
      timezone: America/New_York
      description: Monthly database maintenance
      silenceAlertsTags:
        - production
  # Show a maintenance window on a status page
  api:
    type: checkly:StatusPageService
    properties:
      name: API
  example:
    type: checkly:StatusPage
    properties:
      name: Example Application
      url: my-example-status-page
      cards:
        - name: Services
          serviceAttachments:
            - serviceId: ${api.id}
  maintenance-2:
    type: checkly:MaintenanceWindow
    properties:
      name: Status page maintenance
      startsAt: 2028-08-24T00:00:00.000Z
      endsAt: 2028-08-24T02:00:00.000Z
      tags:
        - api
      description: We're upgrading our API servers.
      statusPageVisibility:
        enabled: true
        severity: MINOR
        notifyOnStart: true
        statusPageIds:
          - ${example.id}
        serviceIds:
          - ${api.id}

    Example coming soon!

    Create MaintenanceWindow Resource

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

    Constructor syntax

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

@overload
def MaintenanceWindow(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      starts_at: Optional[str] = None,
                      ends_at: Optional[str] = None,
                      pause_all_checks: Optional[bool] = None,
                      description: Optional[str] = None,
                      repeat_ends_at: Optional[str] = None,
                      repeat_interval: Optional[int] = None,
                      repeat_unit: Optional[str] = None,
                      silence_alerts_tags: Optional[Sequence[str]] = None,
                      silence_all_alerts: Optional[bool] = None,
                      name: Optional[str] = None,
                      status_page_visibility: Optional[MaintenanceWindowStatusPageVisibilityArgs] = None,
                      tags: Optional[Sequence[str]] = None,
                      timezone: Optional[str] = None)
    func NewMaintenanceWindow(ctx *Context, name string, args MaintenanceWindowArgs, opts ...ResourceOption) (*MaintenanceWindow, error)
    public MaintenanceWindow(string name, MaintenanceWindowArgs args, CustomResourceOptions? opts = null)
    public MaintenanceWindow(String name, MaintenanceWindowArgs args)
public MaintenanceWindow(String name, MaintenanceWindowArgs args, CustomResourceOptions options)

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


    resource "checkly_maintenance_window" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args MaintenanceWindowArgs
    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 MaintenanceWindowArgs
    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 MaintenanceWindowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MaintenanceWindowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MaintenanceWindowArgs
    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 maintenanceWindowResource = new Checkly.MaintenanceWindow("maintenanceWindowResource", new()
{
    StartsAt = "string",
    EndsAt = "string",
    PauseAllChecks = false,
    Description = "string",
    RepeatEndsAt = "string",
    RepeatInterval = 0,
    RepeatUnit = "string",
    SilenceAlertsTags = new[]
    {
        "string",
    },
    SilenceAllAlerts = false,
    Name = "string",
    StatusPageVisibility = new Checkly.Inputs.MaintenanceWindowStatusPageVisibilityArgs
    {
        AffectAllServices = false,
        AutoEnd = false,
        AutoStart = false,
        Enabled = false,
        NotifyOnEnd = false,
        NotifyOnStart = false,
        ReminderMinutesBefores = new[]
        {
            0,
        },
        ServiceIds = new[]
        {
            "string",
        },
        Severity = "string",
        ShowAffectedServices = false,
        StatusPageIds = new[]
        {
            "string",
        },
        SuppressAutoIncidents = false,
    },
    Tags = new[]
    {
        "string",
    },
    Timezone = "string",
});

    example, err := checkly.NewMaintenanceWindow(ctx, "maintenanceWindowResource", &checkly.MaintenanceWindowArgs{
	StartsAt:       pulumi.String("string"),
	EndsAt:         pulumi.String("string"),
	PauseAllChecks: pulumi.Bool(false),
	Description:    pulumi.String("string"),
	RepeatEndsAt:   pulumi.String("string"),
	RepeatInterval: pulumi.Int(0),
	RepeatUnit:     pulumi.String("string"),
	SilenceAlertsTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	SilenceAllAlerts: pulumi.Bool(false),
	Name:             pulumi.String("string"),
	StatusPageVisibility: &checkly.MaintenanceWindowStatusPageVisibilityArgs{
		AffectAllServices: pulumi.Bool(false),
		AutoEnd:           pulumi.Bool(false),
		AutoStart:         pulumi.Bool(false),
		Enabled:           pulumi.Bool(false),
		NotifyOnEnd:       pulumi.Bool(false),
		NotifyOnStart:     pulumi.Bool(false),
		ReminderMinutesBefores: pulumi.IntArray{
			pulumi.Int(0),
		},
		ServiceIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Severity:             pulumi.String("string"),
		ShowAffectedServices: pulumi.Bool(false),
		StatusPageIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		SuppressAutoIncidents: pulumi.Bool(false),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timezone: pulumi.String("string"),
})

    resource "checkly_maintenance_window" "maintenanceWindowResource" {
  lifecycle {
    create_before_destroy = true
  }
  starts_at           = "string"
  ends_at             = "string"
  pause_all_checks    = false
  description         = "string"
  repeat_ends_at      = "string"
  repeat_interval     = 0
  repeat_unit         = "string"
  silence_alerts_tags = ["string"]
  silence_all_alerts  = false
  name                = "string"
  status_page_visibility = {
    affect_all_services      = false
    auto_end                 = false
    auto_start               = false
    enabled                  = false
    notify_on_end            = false
    notify_on_start          = false
    reminder_minutes_befores = [0]
    service_ids              = ["string"]
    severity                 = "string"
    show_affected_services   = false
    status_page_ids          = ["string"]
    suppress_auto_incidents  = false
  }
  tags     = ["string"]
  timezone = "string"
}

    var maintenanceWindowResource = new MaintenanceWindow("maintenanceWindowResource", MaintenanceWindowArgs.builder()
    .startsAt("string")
    .endsAt("string")
    .pauseAllChecks(false)
    .description("string")
    .repeatEndsAt("string")
    .repeatInterval(0)
    .repeatUnit("string")
    .silenceAlertsTags("string")
    .silenceAllAlerts(false)
    .name("string")
    .statusPageVisibility(MaintenanceWindowStatusPageVisibilityArgs.builder()
        .affectAllServices(false)
        .autoEnd(false)
        .autoStart(false)
        .enabled(false)
        .notifyOnEnd(false)
        .notifyOnStart(false)
        .reminderMinutesBefores(0)
        .serviceIds("string")
        .severity("string")
        .showAffectedServices(false)
        .statusPageIds("string")
        .suppressAutoIncidents(false)
        .build())
    .tags("string")
    .timezone("string")
    .build());

    maintenance_window_resource = checkly.MaintenanceWindow("maintenanceWindowResource",
    starts_at="string",
    ends_at="string",
    pause_all_checks=False,
    description="string",
    repeat_ends_at="string",
    repeat_interval=0,
    repeat_unit="string",
    silence_alerts_tags=["string"],
    silence_all_alerts=False,
    name="string",
    status_page_visibility={
        "affect_all_services": False,
        "auto_end": False,
        "auto_start": False,
        "enabled": False,
        "notify_on_end": False,
        "notify_on_start": False,
        "reminder_minutes_befores": [0],
        "service_ids": ["string"],
        "severity": "string",
        "show_affected_services": False,
        "status_page_ids": ["string"],
        "suppress_auto_incidents": False,
    },
    tags=["string"],
    timezone="string")

    const maintenanceWindowResource = new checkly.MaintenanceWindow("maintenanceWindowResource", {
    startsAt: "string",
    endsAt: "string",
    pauseAllChecks: false,
    description: "string",
    repeatEndsAt: "string",
    repeatInterval: 0,
    repeatUnit: "string",
    silenceAlertsTags: ["string"],
    silenceAllAlerts: false,
    name: "string",
    statusPageVisibility: {
        affectAllServices: false,
        autoEnd: false,
        autoStart: false,
        enabled: false,
        notifyOnEnd: false,
        notifyOnStart: false,
        reminderMinutesBefores: [0],
        serviceIds: ["string"],
        severity: "string",
        showAffectedServices: false,
        statusPageIds: ["string"],
        suppressAutoIncidents: false,
    },
    tags: ["string"],
    timezone: "string",
});

    type: checkly:MaintenanceWindow
properties:
    description: string
    endsAt: string
    name: string
    pauseAllChecks: false
    repeatEndsAt: string
    repeatInterval: 0
    repeatUnit: string
    silenceAlertsTags:
        - string
    silenceAllAlerts: false
    startsAt: string
    statusPageVisibility:
        affectAllServices: false
        autoEnd: false
        autoStart: false
        enabled: false
        notifyOnEnd: false
        notifyOnStart: false
        reminderMinutesBefores:
            - 0
        serviceIds:
            - string
        severity: string
        showAffectedServices: false
        statusPageIds:
            - string
        suppressAutoIncidents: false
    tags:
        - string
    timezone: string

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

    EndsAt string
    The end date of the maintenance window.
    StartsAt string
    The start date of the maintenance window.
    Description string
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    Name string
    The maintenance window name.
    PauseAllChecks bool
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    RepeatEndsAt string
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    RepeatInterval int
    The repeat interval of the maintenance window from the first occurrence.
    RepeatUnit string
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    SilenceAlertsTags List<string>
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    SilenceAllAlerts bool
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    StatusPageVisibility MaintenanceWindowStatusPageVisibility
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    Tags List<string>
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    Timezone string
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    EndsAt string
    The end date of the maintenance window.
    StartsAt string
    The start date of the maintenance window.
    Description string
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    Name string
    The maintenance window name.
    PauseAllChecks bool
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    RepeatEndsAt string
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    RepeatInterval int
    The repeat interval of the maintenance window from the first occurrence.
    RepeatUnit string
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    SilenceAlertsTags []string
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    SilenceAllAlerts bool
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    StatusPageVisibility MaintenanceWindowStatusPageVisibilityArgs
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    Tags []string
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    Timezone string
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    ends_at string
    The end date of the maintenance window.
    starts_at string
    The start date of the maintenance window.
    description string
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    name string
    The maintenance window name.
    pause_all_checks bool
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    repeat_ends_at string
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    repeat_interval number
    The repeat interval of the maintenance window from the first occurrence.
    repeat_unit string
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    silence_alerts_tags list(string)
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    silence_all_alerts bool
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    status_page_visibility object
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    tags list(string)
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    timezone string
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    endsAt String
    The end date of the maintenance window.
    startsAt String
    The start date of the maintenance window.
    description String
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    name String
    The maintenance window name.
    pauseAllChecks Boolean
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    repeatEndsAt String
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    repeatInterval Integer
    The repeat interval of the maintenance window from the first occurrence.
    repeatUnit String
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    silenceAlertsTags List<String>
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    silenceAllAlerts Boolean
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    statusPageVisibility MaintenanceWindowStatusPageVisibility
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    tags List<String>
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    timezone String
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    endsAt string
    The end date of the maintenance window.
    startsAt string
    The start date of the maintenance window.
    description string
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    name string
    The maintenance window name.
    pauseAllChecks boolean
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    repeatEndsAt string
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    repeatInterval number
    The repeat interval of the maintenance window from the first occurrence.
    repeatUnit string
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    silenceAlertsTags string[]
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    silenceAllAlerts boolean
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    statusPageVisibility MaintenanceWindowStatusPageVisibility
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    tags string[]
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    timezone string
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    ends_at str
    The end date of the maintenance window.
    starts_at str
    The start date of the maintenance window.
    description str
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    name str
    The maintenance window name.
    pause_all_checks bool
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    repeat_ends_at str
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    repeat_interval int
    The repeat interval of the maintenance window from the first occurrence.
    repeat_unit str
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    silence_alerts_tags Sequence[str]
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    silence_all_alerts bool
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    status_page_visibility MaintenanceWindowStatusPageVisibilityArgs
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    tags Sequence[str]
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    timezone str
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    endsAt String
    The end date of the maintenance window.
    startsAt String
    The start date of the maintenance window.
    description String
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    name String
    The maintenance window name.
    pauseAllChecks Boolean
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    repeatEndsAt String
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    repeatInterval Number
    The repeat interval of the maintenance window from the first occurrence.
    repeatUnit String
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    silenceAlertsTags List<String>
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    silenceAllAlerts Boolean
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    statusPageVisibility Property Map
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    tags List<String>
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    timezone String
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.

    Outputs

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

    Get an existing MaintenanceWindow 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?: MaintenanceWindowState, opts?: CustomResourceOptions): MaintenanceWindow
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        ends_at: Optional[str] = None,
        name: Optional[str] = None,
        pause_all_checks: Optional[bool] = None,
        repeat_ends_at: Optional[str] = None,
        repeat_interval: Optional[int] = None,
        repeat_unit: Optional[str] = None,
        silence_alerts_tags: Optional[Sequence[str]] = None,
        silence_all_alerts: Optional[bool] = None,
        starts_at: Optional[str] = None,
        status_page_visibility: Optional[MaintenanceWindowStatusPageVisibilityArgs] = None,
        tags: Optional[Sequence[str]] = None,
        timezone: Optional[str] = None) -> MaintenanceWindow
    func GetMaintenanceWindow(ctx *Context, name string, id IDInput, state *MaintenanceWindowState, opts ...ResourceOption) (*MaintenanceWindow, error)
    public static MaintenanceWindow Get(string name, Input<string> id, MaintenanceWindowState? state, CustomResourceOptions? opts = null)
    public static MaintenanceWindow get(String name, Output<String> id, MaintenanceWindowState state, CustomResourceOptions options)
    resources:  _:    type: checkly:MaintenanceWindow    get:      id: ${id}
    import {
  to = checkly_maintenance_window.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:
    Description string
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    EndsAt string
    The end date of the maintenance window.
    Name string
    The maintenance window name.
    PauseAllChecks bool
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    RepeatEndsAt string
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    RepeatInterval int
    The repeat interval of the maintenance window from the first occurrence.
    RepeatUnit string
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    SilenceAlertsTags List<string>
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    SilenceAllAlerts bool
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    StartsAt string
    The start date of the maintenance window.
    StatusPageVisibility MaintenanceWindowStatusPageVisibility
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    Tags List<string>
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    Timezone string
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    Description string
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    EndsAt string
    The end date of the maintenance window.
    Name string
    The maintenance window name.
    PauseAllChecks bool
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    RepeatEndsAt string
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    RepeatInterval int
    The repeat interval of the maintenance window from the first occurrence.
    RepeatUnit string
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    SilenceAlertsTags []string
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    SilenceAllAlerts bool
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    StartsAt string
    The start date of the maintenance window.
    StatusPageVisibility MaintenanceWindowStatusPageVisibilityArgs
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    Tags []string
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    Timezone string
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    description string
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    ends_at string
    The end date of the maintenance window.
    name string
    The maintenance window name.
    pause_all_checks bool
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    repeat_ends_at string
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    repeat_interval number
    The repeat interval of the maintenance window from the first occurrence.
    repeat_unit string
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    silence_alerts_tags list(string)
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    silence_all_alerts bool
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    starts_at string
    The start date of the maintenance window.
    status_page_visibility object
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    tags list(string)
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    timezone string
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    description String
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    endsAt String
    The end date of the maintenance window.
    name String
    The maintenance window name.
    pauseAllChecks Boolean
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    repeatEndsAt String
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    repeatInterval Integer
    The repeat interval of the maintenance window from the first occurrence.
    repeatUnit String
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    silenceAlertsTags List<String>
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    silenceAllAlerts Boolean
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    startsAt String
    The start date of the maintenance window.
    statusPageVisibility MaintenanceWindowStatusPageVisibility
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    tags List<String>
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    timezone String
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    description string
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    endsAt string
    The end date of the maintenance window.
    name string
    The maintenance window name.
    pauseAllChecks boolean
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    repeatEndsAt string
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    repeatInterval number
    The repeat interval of the maintenance window from the first occurrence.
    repeatUnit string
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    silenceAlertsTags string[]
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    silenceAllAlerts boolean
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    startsAt string
    The start date of the maintenance window.
    statusPageVisibility MaintenanceWindowStatusPageVisibility
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    tags string[]
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    timezone string
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    description str
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    ends_at str
    The end date of the maintenance window.
    name str
    The maintenance window name.
    pause_all_checks bool
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    repeat_ends_at str
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    repeat_interval int
    The repeat interval of the maintenance window from the first occurrence.
    repeat_unit str
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    silence_alerts_tags Sequence[str]
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    silence_all_alerts bool
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    starts_at str
    The start date of the maintenance window.
    status_page_visibility MaintenanceWindowStatusPageVisibilityArgs
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    tags Sequence[str]
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    timezone str
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.
    description String
    A description of the maintenance window. When the window is visible on status pages, the description is shown there too.
    endsAt String
    The end date of the maintenance window.
    name String
    The maintenance window name.
    pauseAllChecks Boolean
    Pause every check in the account during the maintenance window, regardless of tags. Defaults to false.
    repeatEndsAt String
    The date on which the maintenance window should stop repeating, interpreted as a calendar date in timezone.
    repeatInterval Number
    The repeat interval of the maintenance window from the first occurrence.
    repeatUnit String
    The repeat cadence for the maintenance window. Possible values DAY, WEEK and MONTH.
    silenceAlertsTags List<String>
    The tags of the checks and groups whose alerts are silenced during the maintenance window. Ignored when silence_all_alerts is true.
    silenceAllAlerts Boolean
    Silence alerts for every check in the account during the maintenance window, regardless of silence_alerts_tags. Defaults to false.
    startsAt String
    The start date of the maintenance window.
    statusPageVisibility Property Map
    Whether and how the maintenance window appears on status pages. Omitting the block hides the window and unlinks it from all status pages and services. Only service-based status page links are supported; links to status page components can't be managed here. An account without the status page maintenance windows entitlement can only change enabled to false: keep the rest of the block as it is, because removing the block also changes the other settings, which is rejected.
    tags List<String>
    The tags of the checks and groups that are paused during the maintenance window. Ignored when pause_all_checks is true.
    timezone String
    The named IANA time zone used to schedule recurring occurrences, e.g. America/New_York. Occurrences keep the same local time across daylight-saving changes. starts_at and ends_at remain absolute instants; the time zone does not reinterpret them. Use the canonical IANA name (e.g. America/New_York, not US/Eastern): the API stores canonical names, so an alias shows as a change on every plan. UTC offsets such as +05:00 or Etc/GMT+5 are not accepted. Defaults to UTC. The time zone cannot be changed while a maintenance is active.

    Supporting Types

    MaintenanceWindowStatusPageVisibility, MaintenanceWindowStatusPageVisibilityArgs

    AffectAllServices bool
    Mark every service on the linked status pages as affected. Can't be combined with service_ids. (Default false).
    AutoEnd bool
    Complete the maintenance automatically at the scheduled end time. (Default true).
    AutoStart bool
    Start the maintenance automatically at the scheduled time. (Default true).
    Enabled bool
    Show the maintenance window on the linked status pages. All other settings in this block only take effect when this is true. (Default false).
    NotifyOnEnd bool
    Email status page subscribers when the maintenance ends. (Default false).
    NotifyOnStart bool
    Email status page subscribers when the maintenance starts. (Default false).
    ReminderMinutesBefores List<int>
    Up to three reminders, in minutes before the maintenance starts (60 to 10080), sent to status page subscribers.
    ServiceIds List<string>
    The IDs of the affected status page services (checkly.StatusPageService). Each service must be on one of the linked status pages.
    Severity string
    The severity shown on the status page. Possible values are MINOR, MEDIUM, MAJOR and CRITICAL.
    ShowAffectedServices bool
    Show which services the maintenance affects. When false, downtime during the maintenance counts against the services' uptime. (Default true).
    StatusPageIds List<string>
    The IDs of the status pages (checkly.StatusPage) to show the maintenance window on. Requires service_ids or affect_all_services.
    SuppressAutoIncidents bool
    Suppress automatically created incidents for the linked services during the maintenance. (Default false).
    AffectAllServices bool
    Mark every service on the linked status pages as affected. Can't be combined with service_ids. (Default false).
    AutoEnd bool
    Complete the maintenance automatically at the scheduled end time. (Default true).
    AutoStart bool
    Start the maintenance automatically at the scheduled time. (Default true).
    Enabled bool
    Show the maintenance window on the linked status pages. All other settings in this block only take effect when this is true. (Default false).
    NotifyOnEnd bool
    Email status page subscribers when the maintenance ends. (Default false).
    NotifyOnStart bool
    Email status page subscribers when the maintenance starts. (Default false).
    ReminderMinutesBefores []int
    Up to three reminders, in minutes before the maintenance starts (60 to 10080), sent to status page subscribers.
    ServiceIds []string
    The IDs of the affected status page services (checkly.StatusPageService). Each service must be on one of the linked status pages.
    Severity string
    The severity shown on the status page. Possible values are MINOR, MEDIUM, MAJOR and CRITICAL.
    ShowAffectedServices bool
    Show which services the maintenance affects. When false, downtime during the maintenance counts against the services' uptime. (Default true).
    StatusPageIds []string
    The IDs of the status pages (checkly.StatusPage) to show the maintenance window on. Requires service_ids or affect_all_services.
    SuppressAutoIncidents bool
    Suppress automatically created incidents for the linked services during the maintenance. (Default false).
    affect_all_services bool
    Mark every service on the linked status pages as affected. Can't be combined with service_ids. (Default false).
    auto_end bool
    Complete the maintenance automatically at the scheduled end time. (Default true).
    auto_start bool
    Start the maintenance automatically at the scheduled time. (Default true).
    enabled bool
    Show the maintenance window on the linked status pages. All other settings in this block only take effect when this is true. (Default false).
    notify_on_end bool
    Email status page subscribers when the maintenance ends. (Default false).
    notify_on_start bool
    Email status page subscribers when the maintenance starts. (Default false).
    reminder_minutes_befores list(number)
    Up to three reminders, in minutes before the maintenance starts (60 to 10080), sent to status page subscribers.
    service_ids list(string)
    The IDs of the affected status page services (checkly.StatusPageService). Each service must be on one of the linked status pages.
    severity string
    The severity shown on the status page. Possible values are MINOR, MEDIUM, MAJOR and CRITICAL.
    show_affected_services bool
    Show which services the maintenance affects. When false, downtime during the maintenance counts against the services' uptime. (Default true).
    status_page_ids list(string)
    The IDs of the status pages (checkly.StatusPage) to show the maintenance window on. Requires service_ids or affect_all_services.
    suppress_auto_incidents bool
    Suppress automatically created incidents for the linked services during the maintenance. (Default false).
    affectAllServices Boolean
    Mark every service on the linked status pages as affected. Can't be combined with service_ids. (Default false).
    autoEnd Boolean
    Complete the maintenance automatically at the scheduled end time. (Default true).
    autoStart Boolean
    Start the maintenance automatically at the scheduled time. (Default true).
    enabled Boolean
    Show the maintenance window on the linked status pages. All other settings in this block only take effect when this is true. (Default false).
    notifyOnEnd Boolean
    Email status page subscribers when the maintenance ends. (Default false).
    notifyOnStart Boolean
    Email status page subscribers when the maintenance starts. (Default false).
    reminderMinutesBefores List<Integer>
    Up to three reminders, in minutes before the maintenance starts (60 to 10080), sent to status page subscribers.
    serviceIds List<String>
    The IDs of the affected status page services (checkly.StatusPageService). Each service must be on one of the linked status pages.
    severity String
    The severity shown on the status page. Possible values are MINOR, MEDIUM, MAJOR and CRITICAL.
    showAffectedServices Boolean
    Show which services the maintenance affects. When false, downtime during the maintenance counts against the services' uptime. (Default true).
    statusPageIds List<String>
    The IDs of the status pages (checkly.StatusPage) to show the maintenance window on. Requires service_ids or affect_all_services.
    suppressAutoIncidents Boolean
    Suppress automatically created incidents for the linked services during the maintenance. (Default false).
    affectAllServices boolean
    Mark every service on the linked status pages as affected. Can't be combined with service_ids. (Default false).
    autoEnd boolean
    Complete the maintenance automatically at the scheduled end time. (Default true).
    autoStart boolean
    Start the maintenance automatically at the scheduled time. (Default true).
    enabled boolean
    Show the maintenance window on the linked status pages. All other settings in this block only take effect when this is true. (Default false).
    notifyOnEnd boolean
    Email status page subscribers when the maintenance ends. (Default false).
    notifyOnStart boolean
    Email status page subscribers when the maintenance starts. (Default false).
    reminderMinutesBefores number[]
    Up to three reminders, in minutes before the maintenance starts (60 to 10080), sent to status page subscribers.
    serviceIds string[]
    The IDs of the affected status page services (checkly.StatusPageService). Each service must be on one of the linked status pages.
    severity string
    The severity shown on the status page. Possible values are MINOR, MEDIUM, MAJOR and CRITICAL.
    showAffectedServices boolean
    Show which services the maintenance affects. When false, downtime during the maintenance counts against the services' uptime. (Default true).
    statusPageIds string[]
    The IDs of the status pages (checkly.StatusPage) to show the maintenance window on. Requires service_ids or affect_all_services.
    suppressAutoIncidents boolean
    Suppress automatically created incidents for the linked services during the maintenance. (Default false).
    affect_all_services bool
    Mark every service on the linked status pages as affected. Can't be combined with service_ids. (Default false).
    auto_end bool
    Complete the maintenance automatically at the scheduled end time. (Default true).
    auto_start bool
    Start the maintenance automatically at the scheduled time. (Default true).
    enabled bool
    Show the maintenance window on the linked status pages. All other settings in this block only take effect when this is true. (Default false).
    notify_on_end bool
    Email status page subscribers when the maintenance ends. (Default false).
    notify_on_start bool
    Email status page subscribers when the maintenance starts. (Default false).
    reminder_minutes_befores Sequence[int]
    Up to three reminders, in minutes before the maintenance starts (60 to 10080), sent to status page subscribers.
    service_ids Sequence[str]
    The IDs of the affected status page services (checkly.StatusPageService). Each service must be on one of the linked status pages.
    severity str
    The severity shown on the status page. Possible values are MINOR, MEDIUM, MAJOR and CRITICAL.
    show_affected_services bool
    Show which services the maintenance affects. When false, downtime during the maintenance counts against the services' uptime. (Default true).
    status_page_ids Sequence[str]
    The IDs of the status pages (checkly.StatusPage) to show the maintenance window on. Requires service_ids or affect_all_services.
    suppress_auto_incidents bool
    Suppress automatically created incidents for the linked services during the maintenance. (Default false).
    affectAllServices Boolean
    Mark every service on the linked status pages as affected. Can't be combined with service_ids. (Default false).
    autoEnd Boolean
    Complete the maintenance automatically at the scheduled end time. (Default true).
    autoStart Boolean
    Start the maintenance automatically at the scheduled time. (Default true).
    enabled Boolean
    Show the maintenance window on the linked status pages. All other settings in this block only take effect when this is true. (Default false).
    notifyOnEnd Boolean
    Email status page subscribers when the maintenance ends. (Default false).
    notifyOnStart Boolean
    Email status page subscribers when the maintenance starts. (Default false).
    reminderMinutesBefores List<Number>
    Up to three reminders, in minutes before the maintenance starts (60 to 10080), sent to status page subscribers.
    serviceIds List<String>
    The IDs of the affected status page services (checkly.StatusPageService). Each service must be on one of the linked status pages.
    severity String
    The severity shown on the status page. Possible values are MINOR, MEDIUM, MAJOR and CRITICAL.
    showAffectedServices Boolean
    Show which services the maintenance affects. When false, downtime during the maintenance counts against the services' uptime. (Default true).
    statusPageIds List<String>
    The IDs of the status pages (checkly.StatusPage) to show the maintenance window on. Requires service_ids or affect_all_services.
    suppressAutoIncidents Boolean
    Suppress automatically created incidents for the linked services during the maintenance. (Default false).

    Package Details

    Repository
    checkly checkly/pulumi-checkly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the checkly Terraform Provider.
    checkly logo Checkly
    Viewing docs for Checkly v2.14.0
    published on Friday, Oct 9, 2026 by Checkly
    Schema (JSON)
    checkly/pulumi-checkly

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial