1. Packages
  2. Checkly
  3. API Docs
  4. MaintenanceWindow
Checkly v2.2.0 published on Wednesday, Apr 9, 2025 by Checkly

checkly.MaintenanceWindow

Explore with Pulumi AI

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"],
});
Copy
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"])
Copy
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"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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",
        },
    });

});
Copy
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 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")
            .build());

    }
}
Copy
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
Copy

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,
                      ends_at: Optional[str] = None,
                      starts_at: Optional[str] = None,
                      name: Optional[str] = None,
                      repeat_ends_at: Optional[str] = None,
                      repeat_interval: Optional[int] = None,
                      repeat_unit: Optional[str] = None,
                      tags: Optional[Sequence[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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MaintenanceWindowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. MaintenanceWindowArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MaintenanceWindowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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()
{
    EndsAt = "string",
    StartsAt = "string",
    Name = "string",
    RepeatEndsAt = "string",
    RepeatInterval = 0,
    RepeatUnit = "string",
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := checkly.NewMaintenanceWindow(ctx, "maintenanceWindowResource", &checkly.MaintenanceWindowArgs{
	EndsAt:         pulumi.String("string"),
	StartsAt:       pulumi.String("string"),
	Name:           pulumi.String("string"),
	RepeatEndsAt:   pulumi.String("string"),
	RepeatInterval: pulumi.Int(0),
	RepeatUnit:     pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var maintenanceWindowResource = new MaintenanceWindow("maintenanceWindowResource", MaintenanceWindowArgs.builder()
    .endsAt("string")
    .startsAt("string")
    .name("string")
    .repeatEndsAt("string")
    .repeatInterval(0)
    .repeatUnit("string")
    .tags("string")
    .build());
Copy
maintenance_window_resource = checkly.MaintenanceWindow("maintenanceWindowResource",
    ends_at="string",
    starts_at="string",
    name="string",
    repeat_ends_at="string",
    repeat_interval=0,
    repeat_unit="string",
    tags=["string"])
Copy
const maintenanceWindowResource = new checkly.MaintenanceWindow("maintenanceWindowResource", {
    endsAt: "string",
    startsAt: "string",
    name: "string",
    repeatEndsAt: "string",
    repeatInterval: 0,
    repeatUnit: "string",
    tags: ["string"],
});
Copy
type: checkly:MaintenanceWindow
properties:
    endsAt: string
    name: string
    repeatEndsAt: string
    repeatInterval: 0
    repeatUnit: string
    startsAt: string
    tags:
        - string
Copy

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 This property is required. string
The end date of the maintenance window.
StartsAt This property is required. string
The start date of the maintenance window.
Name string
The maintenance window name.
RepeatEndsAt string
The date on which the maintenance window should stop repeating.
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.
Tags List<string>
The names of the checks and groups maintenance window should apply to.
EndsAt This property is required. string
The end date of the maintenance window.
StartsAt This property is required. string
The start date of the maintenance window.
Name string
The maintenance window name.
RepeatEndsAt string
The date on which the maintenance window should stop repeating.
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.
Tags []string
The names of the checks and groups maintenance window should apply to.
endsAt This property is required. String
The end date of the maintenance window.
startsAt This property is required. String
The start date of the maintenance window.
name String
The maintenance window name.
repeatEndsAt String
The date on which the maintenance window should stop repeating.
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.
tags List<String>
The names of the checks and groups maintenance window should apply to.
endsAt This property is required. string
The end date of the maintenance window.
startsAt This property is required. string
The start date of the maintenance window.
name string
The maintenance window name.
repeatEndsAt string
The date on which the maintenance window should stop repeating.
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.
tags string[]
The names of the checks and groups maintenance window should apply to.
ends_at This property is required. str
The end date of the maintenance window.
starts_at This property is required. str
The start date of the maintenance window.
name str
The maintenance window name.
repeat_ends_at str
The date on which the maintenance window should stop repeating.
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.
tags Sequence[str]
The names of the checks and groups maintenance window should apply to.
endsAt This property is required. String
The end date of the maintenance window.
startsAt This property is required. String
The start date of the maintenance window.
name String
The maintenance window name.
repeatEndsAt String
The date on which the maintenance window should stop repeating.
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.
tags List<String>
The names of the checks and groups maintenance window should apply to.

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 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,
        ends_at: Optional[str] = None,
        name: Optional[str] = None,
        repeat_ends_at: Optional[str] = None,
        repeat_interval: Optional[int] = None,
        repeat_unit: Optional[str] = None,
        starts_at: Optional[str] = None,
        tags: Optional[Sequence[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}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
EndsAt string
The end date of the maintenance window.
Name string
The maintenance window name.
RepeatEndsAt string
The date on which the maintenance window should stop repeating.
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.
StartsAt string
The start date of the maintenance window.
Tags List<string>
The names of the checks and groups maintenance window should apply to.
EndsAt string
The end date of the maintenance window.
Name string
The maintenance window name.
RepeatEndsAt string
The date on which the maintenance window should stop repeating.
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.
StartsAt string
The start date of the maintenance window.
Tags []string
The names of the checks and groups maintenance window should apply to.
endsAt String
The end date of the maintenance window.
name String
The maintenance window name.
repeatEndsAt String
The date on which the maintenance window should stop repeating.
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.
startsAt String
The start date of the maintenance window.
tags List<String>
The names of the checks and groups maintenance window should apply to.
endsAt string
The end date of the maintenance window.
name string
The maintenance window name.
repeatEndsAt string
The date on which the maintenance window should stop repeating.
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.
startsAt string
The start date of the maintenance window.
tags string[]
The names of the checks and groups maintenance window should apply to.
ends_at str
The end date of the maintenance window.
name str
The maintenance window name.
repeat_ends_at str
The date on which the maintenance window should stop repeating.
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.
starts_at str
The start date of the maintenance window.
tags Sequence[str]
The names of the checks and groups maintenance window should apply to.
endsAt String
The end date of the maintenance window.
name String
The maintenance window name.
repeatEndsAt String
The date on which the maintenance window should stop repeating.
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.
startsAt String
The start date of the maintenance window.
tags List<String>
The names of the checks and groups maintenance window should apply to.

Package Details

Repository
checkly checkly/pulumi-checkly
License
Apache-2.0
Notes
This Pulumi package is based on the checkly Terraform Provider.