Datadog

Pulumi Official
Package maintained by Pulumi
v4.10.0 published on Monday, Jul 25, 2022 by Pulumi

Downtime

Provides a Datadog downtime resource. This can be used to create and manage Datadog downtimes.

Example Usage

using Pulumi;
using Datadog = Pulumi.Datadog;

class MyStack : Stack
{
    public MyStack()
    {
        // Example: downtime for all monitors
        // Create a new daily 1700-0900 Datadog downtime for all monitors
        var foo = new Datadog.Downtime("foo", new Datadog.DowntimeArgs
        {
            End = 1483365600,
            Recurrence = new Datadog.Inputs.DowntimeRecurrenceArgs
            {
                Period = 1,
                Type = "days",
            },
            Scopes = 
            {
                "*",
            },
            Start = 1483308000,
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datadog.NewDowntime(ctx, "foo", &datadog.DowntimeArgs{
			End: pulumi.Int(1483365600),
			Recurrence: &DowntimeRecurrenceArgs{
				Period: pulumi.Int(1),
				Type:   pulumi.String("days"),
			},
			Scopes: pulumi.StringArray{
				pulumi.String("*"),
			},
			Start: pulumi.Int(1483308000),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foo = new Downtime("foo", DowntimeArgs.builder()        
            .end(1483365600)
            .recurrence(DowntimeRecurrenceArgs.builder()
                .period(1)
                .type("days")
                .build())
            .scopes("*")
            .start(1483308000)
            .build());

    }
}
import pulumi
import pulumi_datadog as datadog

# Example: downtime for all monitors
# Create a new daily 1700-0900 Datadog downtime for all monitors
foo = datadog.Downtime("foo",
    end=1483365600,
    recurrence=datadog.DowntimeRecurrenceArgs(
        period=1,
        type="days",
    ),
    scopes=["*"],
    start=1483308000)
import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";

// Example: downtime for all monitors
// Create a new daily 1700-0900 Datadog downtime for all monitors
const foo = new datadog.Downtime("foo", {
    end: 1483365600,
    recurrence: {
        period: 1,
        type: "days",
    },
    scopes: ["*"],
    start: 1483308000,
});
resources:
  foo:
    type: datadog:Downtime
    properties:
      end: 1.4833656e+09
      recurrence:
        period: 1
        type: days
      scopes:
        - '*'
      start: 1.483308e+09

Create a Downtime Resource

new Downtime(name: string, args: DowntimeArgs, opts?: CustomResourceOptions);
@overload
def Downtime(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             end: Optional[int] = None,
             end_date: Optional[str] = None,
             message: Optional[str] = None,
             monitor_id: Optional[int] = None,
             monitor_tags: Optional[Sequence[str]] = None,
             mute_first_recovery_notification: Optional[bool] = None,
             recurrence: Optional[DowntimeRecurrenceArgs] = None,
             scopes: Optional[Sequence[str]] = None,
             start: Optional[int] = None,
             start_date: Optional[str] = None,
             timezone: Optional[str] = None)
@overload
def Downtime(resource_name: str,
             args: DowntimeArgs,
             opts: Optional[ResourceOptions] = None)
func NewDowntime(ctx *Context, name string, args DowntimeArgs, opts ...ResourceOption) (*Downtime, error)
public Downtime(string name, DowntimeArgs args, CustomResourceOptions? opts = null)
public Downtime(String name, DowntimeArgs args)
public Downtime(String name, DowntimeArgs args, CustomResourceOptions options)
type: datadog:Downtime
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DowntimeArgs
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 DowntimeArgs
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 DowntimeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DowntimeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DowntimeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Downtime Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Downtime resource accepts the following input properties:

Scopes List<string>

specify the group scope to which this downtime applies. For everything use '*'

End int

Optionally specify an end date when this downtime should expire

EndDate string

String representing date and time to end the downtime in RFC3339 format.

Message string

An optional message to provide when creating the downtime, can include notification handles

MonitorId int

When specified, this downtime will only apply to this monitor

MonitorTags List<string>

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

MuteFirstRecoveryNotification bool

When true the first recovery notification during the downtime will be muted

Recurrence DowntimeRecurrenceArgs

Optional recurring schedule for this downtime

Start int

Specify when this downtime should start

StartDate string

String representing date and time to start the downtime in RFC3339 format.

Timezone string

The timezone for the downtime, default UTC

Scopes []string

specify the group scope to which this downtime applies. For everything use '*'

End int

Optionally specify an end date when this downtime should expire

EndDate string

String representing date and time to end the downtime in RFC3339 format.

Message string

An optional message to provide when creating the downtime, can include notification handles

MonitorId int

When specified, this downtime will only apply to this monitor

MonitorTags []string

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

MuteFirstRecoveryNotification bool

When true the first recovery notification during the downtime will be muted

Recurrence DowntimeRecurrenceArgs

Optional recurring schedule for this downtime

Start int

Specify when this downtime should start

StartDate string

String representing date and time to start the downtime in RFC3339 format.

Timezone string

The timezone for the downtime, default UTC

scopes List<String>

specify the group scope to which this downtime applies. For everything use '*'

end Integer

Optionally specify an end date when this downtime should expire

endDate String

String representing date and time to end the downtime in RFC3339 format.

message String

An optional message to provide when creating the downtime, can include notification handles

monitorId Integer

When specified, this downtime will only apply to this monitor

monitorTags List<String>

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

muteFirstRecoveryNotification Boolean

When true the first recovery notification during the downtime will be muted

recurrence DowntimeRecurrenceArgs

Optional recurring schedule for this downtime

start Integer

Specify when this downtime should start

startDate String

String representing date and time to start the downtime in RFC3339 format.

timezone String

The timezone for the downtime, default UTC

scopes string[]

specify the group scope to which this downtime applies. For everything use '*'

end number

Optionally specify an end date when this downtime should expire

endDate string

String representing date and time to end the downtime in RFC3339 format.

message string

An optional message to provide when creating the downtime, can include notification handles

monitorId number

When specified, this downtime will only apply to this monitor

monitorTags string[]

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

muteFirstRecoveryNotification boolean

When true the first recovery notification during the downtime will be muted

recurrence DowntimeRecurrenceArgs

Optional recurring schedule for this downtime

start number

Specify when this downtime should start

startDate string

String representing date and time to start the downtime in RFC3339 format.

timezone string

The timezone for the downtime, default UTC

scopes Sequence[str]

specify the group scope to which this downtime applies. For everything use '*'

end int

Optionally specify an end date when this downtime should expire

end_date str

String representing date and time to end the downtime in RFC3339 format.

message str

An optional message to provide when creating the downtime, can include notification handles

monitor_id int

When specified, this downtime will only apply to this monitor

monitor_tags Sequence[str]

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

mute_first_recovery_notification bool

When true the first recovery notification during the downtime will be muted

recurrence DowntimeRecurrenceArgs

Optional recurring schedule for this downtime

start int

Specify when this downtime should start

start_date str

String representing date and time to start the downtime in RFC3339 format.

timezone str

The timezone for the downtime, default UTC

scopes List<String>

specify the group scope to which this downtime applies. For everything use '*'

end Number

Optionally specify an end date when this downtime should expire

endDate String

String representing date and time to end the downtime in RFC3339 format.

message String

An optional message to provide when creating the downtime, can include notification handles

monitorId Number

When specified, this downtime will only apply to this monitor

monitorTags List<String>

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

muteFirstRecoveryNotification Boolean

When true the first recovery notification during the downtime will be muted

recurrence Property Map

Optional recurring schedule for this downtime

start Number

Specify when this downtime should start

startDate String

String representing date and time to start the downtime in RFC3339 format.

timezone String

The timezone for the downtime, default UTC

Outputs

All input properties are implicitly available as output properties. Additionally, the Downtime resource produces the following output properties:

Active bool

When true indicates this downtime is being actively applied

ActiveChildId int

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

Disabled bool

When true indicates this downtime is not being applied

Id string

The provider-assigned unique ID for this managed resource.

Active bool

When true indicates this downtime is being actively applied

ActiveChildId int

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

Disabled bool

When true indicates this downtime is not being applied

Id string

The provider-assigned unique ID for this managed resource.

active Boolean

When true indicates this downtime is being actively applied

activeChildId Integer

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

disabled Boolean

When true indicates this downtime is not being applied

id String

The provider-assigned unique ID for this managed resource.

active boolean

When true indicates this downtime is being actively applied

activeChildId number

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

disabled boolean

When true indicates this downtime is not being applied

id string

The provider-assigned unique ID for this managed resource.

active bool

When true indicates this downtime is being actively applied

active_child_id int

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

disabled bool

When true indicates this downtime is not being applied

id str

The provider-assigned unique ID for this managed resource.

active Boolean

When true indicates this downtime is being actively applied

activeChildId Number

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

disabled Boolean

When true indicates this downtime is not being applied

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing Downtime Resource

Get an existing Downtime 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?: DowntimeState, opts?: CustomResourceOptions): Downtime
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        active_child_id: Optional[int] = None,
        disabled: Optional[bool] = None,
        end: Optional[int] = None,
        end_date: Optional[str] = None,
        message: Optional[str] = None,
        monitor_id: Optional[int] = None,
        monitor_tags: Optional[Sequence[str]] = None,
        mute_first_recovery_notification: Optional[bool] = None,
        recurrence: Optional[DowntimeRecurrenceArgs] = None,
        scopes: Optional[Sequence[str]] = None,
        start: Optional[int] = None,
        start_date: Optional[str] = None,
        timezone: Optional[str] = None) -> Downtime
func GetDowntime(ctx *Context, name string, id IDInput, state *DowntimeState, opts ...ResourceOption) (*Downtime, error)
public static Downtime Get(string name, Input<string> id, DowntimeState? state, CustomResourceOptions? opts = null)
public static Downtime get(String name, Output<String> id, DowntimeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Active bool

When true indicates this downtime is being actively applied

ActiveChildId int

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

Disabled bool

When true indicates this downtime is not being applied

End int

Optionally specify an end date when this downtime should expire

EndDate string

String representing date and time to end the downtime in RFC3339 format.

Message string

An optional message to provide when creating the downtime, can include notification handles

MonitorId int

When specified, this downtime will only apply to this monitor

MonitorTags List<string>

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

MuteFirstRecoveryNotification bool

When true the first recovery notification during the downtime will be muted

Recurrence DowntimeRecurrenceArgs

Optional recurring schedule for this downtime

Scopes List<string>

specify the group scope to which this downtime applies. For everything use '*'

Start int

Specify when this downtime should start

StartDate string

String representing date and time to start the downtime in RFC3339 format.

Timezone string

The timezone for the downtime, default UTC

Active bool

When true indicates this downtime is being actively applied

ActiveChildId int

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

Disabled bool

When true indicates this downtime is not being applied

End int

Optionally specify an end date when this downtime should expire

EndDate string

String representing date and time to end the downtime in RFC3339 format.

Message string

An optional message to provide when creating the downtime, can include notification handles

MonitorId int

When specified, this downtime will only apply to this monitor

MonitorTags []string

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

MuteFirstRecoveryNotification bool

When true the first recovery notification during the downtime will be muted

Recurrence DowntimeRecurrenceArgs

Optional recurring schedule for this downtime

Scopes []string

specify the group scope to which this downtime applies. For everything use '*'

Start int

Specify when this downtime should start

StartDate string

String representing date and time to start the downtime in RFC3339 format.

Timezone string

The timezone for the downtime, default UTC

active Boolean

When true indicates this downtime is being actively applied

activeChildId Integer

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

disabled Boolean

When true indicates this downtime is not being applied

end Integer

Optionally specify an end date when this downtime should expire

endDate String

String representing date and time to end the downtime in RFC3339 format.

message String

An optional message to provide when creating the downtime, can include notification handles

monitorId Integer

When specified, this downtime will only apply to this monitor

monitorTags List<String>

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

muteFirstRecoveryNotification Boolean

When true the first recovery notification during the downtime will be muted

recurrence DowntimeRecurrenceArgs

Optional recurring schedule for this downtime

scopes List<String>

specify the group scope to which this downtime applies. For everything use '*'

start Integer

Specify when this downtime should start

startDate String

String representing date and time to start the downtime in RFC3339 format.

timezone String

The timezone for the downtime, default UTC

active boolean

When true indicates this downtime is being actively applied

activeChildId number

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

disabled boolean

When true indicates this downtime is not being applied

end number

Optionally specify an end date when this downtime should expire

endDate string

String representing date and time to end the downtime in RFC3339 format.

message string

An optional message to provide when creating the downtime, can include notification handles

monitorId number

When specified, this downtime will only apply to this monitor

monitorTags string[]

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

muteFirstRecoveryNotification boolean

When true the first recovery notification during the downtime will be muted

recurrence DowntimeRecurrenceArgs

Optional recurring schedule for this downtime

scopes string[]

specify the group scope to which this downtime applies. For everything use '*'

start number

Specify when this downtime should start

startDate string

String representing date and time to start the downtime in RFC3339 format.

timezone string

The timezone for the downtime, default UTC

active bool

When true indicates this downtime is being actively applied

active_child_id int

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

disabled bool

When true indicates this downtime is not being applied

end int

Optionally specify an end date when this downtime should expire

end_date str

String representing date and time to end the downtime in RFC3339 format.

message str

An optional message to provide when creating the downtime, can include notification handles

monitor_id int

When specified, this downtime will only apply to this monitor

monitor_tags Sequence[str]

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

mute_first_recovery_notification bool

When true the first recovery notification during the downtime will be muted

recurrence DowntimeRecurrenceArgs

Optional recurring schedule for this downtime

scopes Sequence[str]

specify the group scope to which this downtime applies. For everything use '*'

start int

Specify when this downtime should start

start_date str

String representing date and time to start the downtime in RFC3339 format.

timezone str

The timezone for the downtime, default UTC

active Boolean

When true indicates this downtime is being actively applied

activeChildId Number

The id corresponding to the downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

disabled Boolean

When true indicates this downtime is not being applied

end Number

Optionally specify an end date when this downtime should expire

endDate String

String representing date and time to end the downtime in RFC3339 format.

message String

An optional message to provide when creating the downtime, can include notification handles

monitorId Number

When specified, this downtime will only apply to this monitor

monitorTags List<String>

A list of monitor tags (up to 32) to base the scheduled downtime on. Only monitors that have all selected tags are silenced

muteFirstRecoveryNotification Boolean

When true the first recovery notification during the downtime will be muted

recurrence Property Map

Optional recurring schedule for this downtime

scopes List<String>

specify the group scope to which this downtime applies. For everything use '*'

start Number

Specify when this downtime should start

startDate String

String representing date and time to start the downtime in RFC3339 format.

timezone String

The timezone for the downtime, default UTC

Supporting Types

DowntimeRecurrence

Type string
Period int
Rrule string
UntilDate int
UntilOccurrences int
WeekDays List<string>
Type string
Period int
Rrule string
UntilDate int
UntilOccurrences int
WeekDays []string
type String
period Integer
rrule String
untilDate Integer
untilOccurrences Integer
weekDays List<String>
type string
period number
rrule string
untilDate number
untilOccurrences number
weekDays string[]
type str
period int
rrule str
until_date int
until_occurrences int
week_days Sequence[str]
type String
period Number
rrule String
untilDate Number
untilOccurrences Number
weekDays List<String>

Import

 $ pulumi import datadog:index/downtime:Downtime bytes_received_localhost 2081

Package Details

Repository
https://github.com/pulumi/pulumi-datadog
License
Apache-2.0
Notes

This Pulumi package is based on the datadog Terraform Provider.