Package @pulumi/datadog

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-datadog repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-datadog repo.

var datadog = require("@pulumi/datadog");
import * as datadog from "@pulumi/datadog";

Modules ▾

class Downtime

extends CustomResource

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

Example Usage

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

// Create a new daily 1700-0900 Datadog downtime
const foo = new datadog.Downtime("foo", {
    end: 1483365600,
    recurrence: {
        period: 1,
        type: "days",
    },
    scopes: ["*"],
    start: 1483308000,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-datadog/blob/master/website/docs/r/downtime.html.markdown.

constructor

new Downtime(name: string, args: DowntimeArgs, opts?: pulumi.CustomResourceOptions)

Create a Downtime resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DowntimeState, opts?: pulumi.CustomResourceOptions): Downtime

Get an existing Downtime resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Downtime. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property active

public active: pulumi.Output<boolean | undefined>;

A flag indicating if the downtime is active now.

property disabled

public disabled: pulumi.Output<boolean | undefined>;

A flag indicating if the downtime was disabled.

property end

public end: pulumi.Output<number | undefined>;

POSIX timestamp to end the downtime.

property endDate

public endDate: pulumi.Output<string | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property message

public message: pulumi.Output<string | undefined>;

A message to include with notifications for this downtime.

property monitorId

public monitorId: pulumi.Output<number | undefined>;

When specified, this downtime will only apply to this monitor

property monitorTags

public monitorTags: pulumi.Output<string[] | undefined>;

A list of monitor tags to match. The resulting downtime applies to monitors that match all provided monitor tags. This option conflicts with monitor_id as it will match all monitors that match these tags.

property recurrence

public recurrence: pulumi.Output<{
    period: number;
    type: string;
    untilDate: undefined | number;
    untilOccurrences: undefined | number;
    weekDays: string[];
} | undefined>;

A dictionary to configure the downtime to be recurring.

property scopes

public scopes: pulumi.Output<string[]>;

A list of items to apply the downtime to, e.g. host:X

property start

public start: pulumi.Output<number | undefined>;

POSIX timestamp to start the downtime.

property startDate

public startDate: pulumi.Output<string | undefined>;

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

property timezone

public timezone: pulumi.Output<string | undefined>;

The timezone for the downtime, default UTC. It must be a valid IANA Time Zone.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class MetricMetadata

extends CustomResource

Provides a Datadog metric_metadata resource. This can be used to manage a metric’s metadata.

Example Usage

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

// Manage a Datadog metric's metadata
const requestTime = new datadog.MetricMetadata("request_time", {
    description: "99th percentile request time in millseconds",
    metric: "request.time",
    shortName: "Request time",
    type: "gauge",
    unit: "millisecond",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-datadog/blob/master/website/docs/r/metric_metadata.html.markdown.

constructor

new MetricMetadata(name: string, args: MetricMetadataArgs, opts?: pulumi.CustomResourceOptions)

Create a MetricMetadata resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MetricMetadataState, opts?: pulumi.CustomResourceOptions): MetricMetadata

Get an existing MetricMetadata resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of MetricMetadata. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

A description of the metric.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property metric

public metric: pulumi.Output<string>;

The name of the metric.

property perUnit

public perUnit: pulumi.Output<string | undefined>;

‘Per’ unit of the metric such as ‘second’ in ‘bytes per second’.

property shortName

public shortName: pulumi.Output<string | undefined>;

A short name of the metric.

property statsdInterval

public statsdInterval: pulumi.Output<number | undefined>;

If applicable, stasd flush interval in seconds for the metric.

property type

public type: pulumi.Output<string | undefined>;

property unit

public unit: pulumi.Output<string | undefined>;

Primary unit of the metric such as ‘byte’ or ‘operation’.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Monitor

extends CustomResource

constructor

new Monitor(name: string, args: MonitorArgs, opts?: pulumi.CustomResourceOptions)

Create a Monitor resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MonitorState, opts?: pulumi.CustomResourceOptions): Monitor

Get an existing Monitor resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Monitor. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enableLogsSample

public enableLogsSample: pulumi.Output<boolean | undefined>;

A boolean indicating whether or not to include a list of log values which triggered the alert. Defaults to false. This is only used by log monitors. triggering tags into the title. Defaults to true.

property escalationMessage

public escalationMessage: pulumi.Output<string | undefined>;

A message to include with a re-notification. Supports the ‘@username’ notification allowed elsewhere.

property evaluationDelay

public evaluationDelay: pulumi.Output<number>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property includeTags

public includeTags: pulumi.Output<boolean | undefined>;

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

property locked

public locked: pulumi.Output<boolean | undefined>;

A boolean indicating whether changes to to this monitor should be restricted to the creator or admins. Defaults to False.

property message

public message: pulumi.Output<string>;

A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same ‘@username’ notation as events.

property name

public name: pulumi.Output<string>;

Name of Datadog monitor

property newHostDelay

public newHostDelay: pulumi.Output<number | undefined>;

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300. * evaluation_delay (Optional, only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.

property noDataTimeframe

public noDataTimeframe: pulumi.Output<number | undefined>;

The number of minutes before a monitor will notify when data stops reporting. Must be at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks. Default: 2x timeframe for metric alerts, 2 minutes for service checks. Defaults to 10 minutes.

property notifyAudit

public notifyAudit: pulumi.Output<boolean | undefined>;

A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.

property notifyNoData

public notifyNoData: pulumi.Output<boolean | undefined>;

A boolean indicating whether this monitor will notify when data stops reporting. Defaults to false.

property query

public query: pulumi.Output<string>;

property renotifyInterval

public renotifyInterval: pulumi.Output<number | undefined>;

The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it’s not resolved.

property requireFullWindow

public requireFullWindow: pulumi.Output<boolean | undefined>;

A boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to False for sparse metrics, otherwise some evaluations will be skipped. Default: True for “on average”, “at all times” and “in total” aggregation. False otherwise.

property silenced

public silenced: pulumi.Output<{[key: string]: number} | undefined>;

property tags

public tags: pulumi.Output<string[] | undefined>;

A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it’s not currently possible to filter by these tags when querying via the API

property thresholdWindows

public thresholdWindows: pulumi.Output<{
    recoveryWindow: undefined | string;
    triggerWindow: undefined | string;
} | undefined>;

A mapping containing recovery_window and trigger_window values, e.g. last_15m. Can only be used for anomaly monitors. * recovery_window describes how long an anomalous metric must be normal before the alert recovers.

property thresholds

public thresholds: pulumi.Output<{
    critical: undefined | number;
    criticalRecovery: undefined | number;
    ok: undefined | number;
    unknown: undefined | number;
    warning: undefined | number;
    warningRecovery: undefined | number;
} | undefined>;
  • Metric alerts: A dictionary of thresholds by threshold type. Currently we have four threshold types for metric alerts: critical, critical recovery, warning, and warning recovery. Critical is defined in the query, but can also be specified in this option. Warning and recovery thresholds can only be specified using the thresholds option. Example usage: thresholds = { critical = 90 critical_recovery = 85 warning = 80 warning_recovery = 75 } Warning: the critical threshold value must match the one contained in the query argument. The threshold from the previous example is valid along with a query like avg(last_1h):avg:system.disk.in_use{role:sqlserver} by {host} > 90 but along with something like avg(last_1h):avg:system.disk.in_use{role:sqlserver} by {host} > 95 would make the Datadog API return a HTTP error 400, complaining “The value provided for parameter ‘query’ is invalid”.
  • Service checks: A dictionary of thresholds by status. Because service checks can have multiple thresholds, we don’t define them directly in the query. Default values: thresholds = { ok = 1 critical = 1 warning = 1 unknown = 1 }

property timeoutH

public timeoutH: pulumi.Output<number | undefined>;

The number of hours of the monitor not reporting data before it will automatically resolve from a triggered state. Defaults to false.

property type

public type: pulumi.Output<string>;

The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Available options to choose from are: * metric alert * service check * event alert * query alert * composite * log alert

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Provider

extends ProviderResource

The provider type for the datadog package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

This content is derived from https://github.com/terraform-providers/terraform-provider-datadog/blob/master/website/docs/index.html.markdown.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ScreenBoard

extends CustomResource

Provides a Datadog screenboard resource. This can be used to create and manage Datadog screenboards.

This content is derived from https://github.com/terraform-providers/terraform-provider-datadog/blob/master/website/docs/r/screenboard.html.markdown.

constructor

new ScreenBoard(name: string, args: ScreenBoardArgs, opts?: pulumi.CustomResourceOptions)

Create a ScreenBoard resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ScreenBoardState, opts?: pulumi.CustomResourceOptions): ScreenBoard

Get an existing ScreenBoard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of ScreenBoard. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property height

public height: pulumi.Output<string | undefined>;

Height of the screenboard

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property readOnly

public readOnly: pulumi.Output<boolean | undefined>;

property shared

public shared: pulumi.Output<boolean | undefined>;

Whether the screenboard is shared or not

property templateVariables

public templateVariables: pulumi.Output<{
    default: undefined | string;
    name: string;
    prefix: undefined | string;
}[] | undefined>;

A list of template variables for using Dashboard templating.

property title

public title: pulumi.Output<string>;

Name of the screenboard

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property widgets

public widgets: pulumi.Output<{
    alertId: undefined | number;
    autoRefresh: undefined | false | true;
    bgcolor: undefined | string;
    check: undefined | string;
    color: undefined | string;
    colorPreference: undefined | string;
    columns: undefined | string;
    displayFormat: undefined | string;
    env: undefined | string;
    eventSize: undefined | string;
    fontSize: undefined | string;
    group: undefined | string;
    groupBies: string[];
    grouping: undefined | string;
    height: undefined | number;
    hideZeroCounts: undefined | false | true;
    html: undefined | string;
    layoutVersion: undefined | string;
    legend: undefined | false | true;
    legendSize: undefined | string;
    logset: undefined | string;
    manageStatusShowTitle: undefined | false | true;
    manageStatusTitleAlign: undefined | string;
    manageStatusTitleSize: undefined | string;
    manageStatusTitleText: undefined | string;
    margin: undefined | string;
    monitor: undefined | {[key: string]: string};
    mustShowBreakdown: undefined | false | true;
    mustShowDistribution: undefined | false | true;
    mustShowErrors: undefined | false | true;
    mustShowHits: undefined | false | true;
    mustShowLatency: undefined | false | true;
    mustShowResourceList: undefined | false | true;
    params: undefined | {[key: string]: string};
    precision: undefined | string;
    query: undefined | string;
    rules: {
        color: undefined | string;
        threshold: undefined | number;
        timeframe: undefined | string;
    }[];
    serviceName: undefined | string;
    serviceService: undefined | string;
    sizeVersion: undefined | string;
    sizing: undefined | string;
    tags: string[];
    text: undefined | string;
    textAlign: undefined | string;
    textSize: undefined | string;
    tick: undefined | false | true;
    tickEdge: undefined | string;
    tickPos: undefined | string;
    tileDeves: {
        autoscale: undefined | false | true;
        customUnit: undefined | string;
        events: {
            q: string;
        }[];
        groups: string[];
        markers: {
            label: undefined | string;
            type: string;
            value: string;
        }[];
        noGroupHosts: undefined | false | true;
        noMetricHosts: undefined | false | true;
        nodeType: undefined | string;
        precision: undefined | string;
        requests: {
            aggregator: undefined | string;
            changeType: undefined | string;
            compareTo: undefined | string;
            conditionalFormats: {
                color: undefined | string;
                comparator: string;
                customBgColor: undefined | string;
                invert: undefined | false | true;
                palette: undefined | string;
                value: undefined | string;
            }[];
            extraCol: undefined | string;
            increaseGood: undefined | false | true;
            limit: undefined | number;
            metadataJson: undefined | string;
            metric: undefined | string;
            orderBy: undefined | string;
            orderDir: undefined | string;
            q: undefined | string;
            queryType: undefined | string;
            style: undefined | {[key: string]: any};
            tagFilters: string[];
            textFilter: undefined | string;
            type: undefined | string;
        }[];
        scopes: string[];
        style: undefined | {[key: string]: any};
        textAlign: undefined | string;
        viz: string;
    }[];
    time: undefined | {[key: string]: string};
    timeframes: string[];
    title: undefined | string;
    titleAlign: undefined | string;
    titleSize: undefined | number;
    type: string;
    unit: undefined | string;
    url: undefined | string;
    vizType: undefined | string;
    width: undefined | number;
    x: number;
    y: number;
}[]>;

A list of widget definitions.

property width

public width: pulumi.Output<string | undefined>;

Width of the screenboard

class SyntheticsTest

extends CustomResource

constructor

new SyntheticsTest(name: string, args: SyntheticsTestArgs, opts?: pulumi.CustomResourceOptions)

Create a SyntheticsTest resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SyntheticsTestState, opts?: pulumi.CustomResourceOptions): SyntheticsTest

Get an existing SyntheticsTest resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of SyntheticsTest. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property assertions

public assertions: pulumi.Output<{[key: string]: any}[] | undefined>;

property deviceIds

public deviceIds: pulumi.Output<string[] | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property locations

public locations: pulumi.Output<string[]>;

property message

public message: pulumi.Output<string | undefined>;

property monitorId

public monitorId: pulumi.Output<number>;

property name

public name: pulumi.Output<string>;

property options

public options: pulumi.Output<{
    followRedirects: undefined | false | true;
    minFailureDuration: undefined | number;
    minLocationFailed: undefined | number;
    tickEvery: number;
} | undefined>;

property request

public request: pulumi.Output<{
    body: undefined | string;
    method: string;
    timeout: undefined | number;
    url: string;
}>;

property requestHeaders

public requestHeaders: pulumi.Output<{[key: string]: any} | undefined>;

property status

public status: pulumi.Output<string>;

property tags

public tags: pulumi.Output<string[]>;

property type

public type: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class TimeBoard

extends CustomResource

Provides a Datadog timeboard resource. This can be used to create and manage Datadog timeboards.

This content is derived from https://github.com/terraform-providers/terraform-provider-datadog/blob/master/website/docs/r/timeboard.html.markdown.

constructor

new TimeBoard(name: string, args: TimeBoardArgs, opts?: pulumi.CustomResourceOptions)

Create a TimeBoard resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TimeBoardState, opts?: pulumi.CustomResourceOptions): TimeBoard

Get an existing TimeBoard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of TimeBoard. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string>;

A description of the dashboard’s content.

property graphs

public graphs: pulumi.Output<{
    autoscale: undefined | false | true;
    customUnit: undefined | string;
    events: string[];
    groups: string[];
    includeNoMetricHosts: undefined | false | true;
    includeUngroupedHosts: undefined | false | true;
    markers: {
        label: undefined | string;
        type: string;
        value: string;
    }[];
    nodeType: undefined | string;
    precision: undefined | string;
    requests: {
        aggregator: undefined | string;
        changeType: undefined | string;
        compareTo: undefined | string;
        conditionalFormats: {
            comparator: string;
            customBgColor: undefined | string;
            customFgColor: undefined | string;
            palette: undefined | string;
            value: undefined | string;
        }[];
        extraCol: undefined | string;
        increaseGood: undefined | false | true;
        metadataJson: undefined | string;
        orderBy: undefined | string;
        orderDirection: undefined | string;
        q: string;
        stacked: undefined | false | true;
        style: undefined | {[key: string]: any};
        type: undefined | string;
    }[];
    scopes: string[];
    style: undefined | {[key: string]: any};
    textAlign: undefined | string;
    title: string;
    viz: string;
    yaxis: undefined | {[key: string]: any};
}[]>;

Nested block describing a graph definition. The structure of this block is described below. Multiple graph blocks are allowed within a datadog_timeboard resource.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property readOnly

public readOnly: pulumi.Output<boolean | undefined>;

The read-only status of the timeboard. Default is false.

property templateVariables

public templateVariables: pulumi.Output<{
    default: undefined | string;
    name: string;
    prefix: undefined | string;
}[] | undefined>;

Nested block describing a template variable. The structure of this block is described below. Multiple template_variable blocks are allowed within a datadog_timeboard resource.

property title

public title: pulumi.Output<string>;

The name of the dashboard.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class User

extends CustomResource

Provides a Datadog user resource. This can be used to create and manage Datadog users.

Example Usage

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

// Create a new Datadog user
const foo = new datadog.User("foo", {
    email: "new@example.com",
    handle: "new@example.com",
    name: "New User",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-datadog/blob/master/website/docs/r/user.html.markdown.

constructor

new User(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions)

Create a User resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessRole

public accessRole: pulumi.Output<string | undefined>;

Role description for user. Can be st (standard user), adm (admin user) or ro (read-only user). Default is st.

property disabled

public disabled: pulumi.Output<boolean | undefined>;

Whether the user is disabled

property email

public email: pulumi.Output<string>;

Email address for user

property handle

public handle: pulumi.Output<string>;

The user handle, must be a valid email.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property isAdmin

public isAdmin: pulumi.Output<boolean | undefined>;

(Optional) Whether the user is an administrator. Warning: the corresponding query parameter is ignored by the Datadog API, thus the argument would always trigger an execution plan.

property name

public name: pulumi.Output<string>;

Name for user

property role

public role: pulumi.Output<string | undefined>;

Role description for user. Warning: the corresponding query parameter is ignored by the Datadog API, thus the argument would always trigger an execution plan.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property verified

public verified: pulumi.Output<boolean>;

Returns true if Datadog user is verified

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface DowntimeArgs

The set of arguments for constructing a Downtime resource.

property active

active?: pulumi.Input<boolean>;

A flag indicating if the downtime is active now.

property disabled

disabled?: pulumi.Input<boolean>;

A flag indicating if the downtime was disabled.

property end

end?: pulumi.Input<number>;

POSIX timestamp to end the downtime.

property endDate

endDate?: pulumi.Input<string>;

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

property message

message?: pulumi.Input<string>;

A message to include with notifications for this downtime.

property monitorId

monitorId?: pulumi.Input<number>;

When specified, this downtime will only apply to this monitor

property monitorTags

monitorTags?: pulumi.Input<pulumi.Input<string>[]>;

A list of monitor tags to match. The resulting downtime applies to monitors that match all provided monitor tags. This option conflicts with monitor_id as it will match all monitors that match these tags.

property recurrence

recurrence?: pulumi.Input<{
    period: pulumi.Input<number>;
    type: pulumi.Input<string>;
    untilDate: pulumi.Input<number>;
    untilOccurrences: pulumi.Input<number>;
    weekDays: pulumi.Input<pulumi.Input<string>[]>;
}>;

A dictionary to configure the downtime to be recurring.

property scopes

scopes: pulumi.Input<pulumi.Input<string>[]>;

A list of items to apply the downtime to, e.g. host:X

property start

start?: pulumi.Input<number>;

POSIX timestamp to start the downtime.

property startDate

startDate?: pulumi.Input<string>;

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

property timezone

timezone?: pulumi.Input<string>;

The timezone for the downtime, default UTC. It must be a valid IANA Time Zone.

interface DowntimeState

Input properties used for looking up and filtering Downtime resources.

property active

active?: pulumi.Input<boolean>;

A flag indicating if the downtime is active now.

property disabled

disabled?: pulumi.Input<boolean>;

A flag indicating if the downtime was disabled.

property end

end?: pulumi.Input<number>;

POSIX timestamp to end the downtime.

property endDate

endDate?: pulumi.Input<string>;

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

property message

message?: pulumi.Input<string>;

A message to include with notifications for this downtime.

property monitorId

monitorId?: pulumi.Input<number>;

When specified, this downtime will only apply to this monitor

property monitorTags

monitorTags?: pulumi.Input<pulumi.Input<string>[]>;

A list of monitor tags to match. The resulting downtime applies to monitors that match all provided monitor tags. This option conflicts with monitor_id as it will match all monitors that match these tags.

property recurrence

recurrence?: pulumi.Input<{
    period: pulumi.Input<number>;
    type: pulumi.Input<string>;
    untilDate: pulumi.Input<number>;
    untilOccurrences: pulumi.Input<number>;
    weekDays: pulumi.Input<pulumi.Input<string>[]>;
}>;

A dictionary to configure the downtime to be recurring.

property scopes

scopes?: pulumi.Input<pulumi.Input<string>[]>;

A list of items to apply the downtime to, e.g. host:X

property start

start?: pulumi.Input<number>;

POSIX timestamp to start the downtime.

property startDate

startDate?: pulumi.Input<string>;

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

property timezone

timezone?: pulumi.Input<string>;

The timezone for the downtime, default UTC. It must be a valid IANA Time Zone.

interface MetricMetadataArgs

The set of arguments for constructing a MetricMetadata resource.

property description

description?: pulumi.Input<string>;

A description of the metric.

property metric

metric: pulumi.Input<string>;

The name of the metric.

property perUnit

perUnit?: pulumi.Input<string>;

‘Per’ unit of the metric such as ‘second’ in ‘bytes per second’.

property shortName

shortName?: pulumi.Input<string>;

A short name of the metric.

property statsdInterval

statsdInterval?: pulumi.Input<number>;

If applicable, stasd flush interval in seconds for the metric.

property type

type?: pulumi.Input<string>;

property unit

unit?: pulumi.Input<string>;

Primary unit of the metric such as ‘byte’ or ‘operation’.

interface MetricMetadataState

Input properties used for looking up and filtering MetricMetadata resources.

property description

description?: pulumi.Input<string>;

A description of the metric.

property metric

metric?: pulumi.Input<string>;

The name of the metric.

property perUnit

perUnit?: pulumi.Input<string>;

‘Per’ unit of the metric such as ‘second’ in ‘bytes per second’.

property shortName

shortName?: pulumi.Input<string>;

A short name of the metric.

property statsdInterval

statsdInterval?: pulumi.Input<number>;

If applicable, stasd flush interval in seconds for the metric.

property type

type?: pulumi.Input<string>;

property unit

unit?: pulumi.Input<string>;

Primary unit of the metric such as ‘byte’ or ‘operation’.

interface MonitorArgs

The set of arguments for constructing a Monitor resource.

property enableLogsSample

enableLogsSample?: pulumi.Input<boolean>;

A boolean indicating whether or not to include a list of log values which triggered the alert. Defaults to false. This is only used by log monitors. triggering tags into the title. Defaults to true.

property escalationMessage

escalationMessage?: pulumi.Input<string>;

A message to include with a re-notification. Supports the ‘@username’ notification allowed elsewhere.

property evaluationDelay

evaluationDelay?: pulumi.Input<number>;

property includeTags

includeTags?: pulumi.Input<boolean>;

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

property locked

locked?: pulumi.Input<boolean>;

A boolean indicating whether changes to to this monitor should be restricted to the creator or admins. Defaults to False.

property message

message: pulumi.Input<string>;

A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same ‘@username’ notation as events.

property name

name: pulumi.Input<string>;

Name of Datadog monitor

property newHostDelay

newHostDelay?: pulumi.Input<number>;

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300. * evaluation_delay (Optional, only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.

property noDataTimeframe

noDataTimeframe?: pulumi.Input<number>;

The number of minutes before a monitor will notify when data stops reporting. Must be at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks. Default: 2x timeframe for metric alerts, 2 minutes for service checks. Defaults to 10 minutes.

property notifyAudit

notifyAudit?: pulumi.Input<boolean>;

A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.

property notifyNoData

notifyNoData?: pulumi.Input<boolean>;

A boolean indicating whether this monitor will notify when data stops reporting. Defaults to false.

property query

query: pulumi.Input<string>;

property renotifyInterval

renotifyInterval?: pulumi.Input<number>;

The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it’s not resolved.

property requireFullWindow

requireFullWindow?: pulumi.Input<boolean>;

A boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to False for sparse metrics, otherwise some evaluations will be skipped. Default: True for “on average”, “at all times” and “in total” aggregation. False otherwise.

property silenced

silenced?: pulumi.Input<{[key: string]: pulumi.Input<number>}>;

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it’s not currently possible to filter by these tags when querying via the API

property thresholdWindows

thresholdWindows?: pulumi.Input<{
    recoveryWindow: pulumi.Input<string>;
    triggerWindow: pulumi.Input<string>;
}>;

A mapping containing recovery_window and trigger_window values, e.g. last_15m. Can only be used for anomaly monitors. * recovery_window describes how long an anomalous metric must be normal before the alert recovers.

property thresholds

thresholds?: pulumi.Input<{
    critical: pulumi.Input<number>;
    criticalRecovery: pulumi.Input<number>;
    ok: pulumi.Input<number>;
    unknown: pulumi.Input<number>;
    warning: pulumi.Input<number>;
    warningRecovery: pulumi.Input<number>;
}>;
  • Metric alerts: A dictionary of thresholds by threshold type. Currently we have four threshold types for metric alerts: critical, critical recovery, warning, and warning recovery. Critical is defined in the query, but can also be specified in this option. Warning and recovery thresholds can only be specified using the thresholds option. Example usage: thresholds = { critical = 90 critical_recovery = 85 warning = 80 warning_recovery = 75 } Warning: the critical threshold value must match the one contained in the query argument. The threshold from the previous example is valid along with a query like avg(last_1h):avg:system.disk.in_use{role:sqlserver} by {host} > 90 but along with something like avg(last_1h):avg:system.disk.in_use{role:sqlserver} by {host} > 95 would make the Datadog API return a HTTP error 400, complaining “The value provided for parameter ‘query’ is invalid”.
  • Service checks: A dictionary of thresholds by status. Because service checks can have multiple thresholds, we don’t define them directly in the query. Default values: thresholds = { ok = 1 critical = 1 warning = 1 unknown = 1 }

property timeoutH

timeoutH?: pulumi.Input<number>;

The number of hours of the monitor not reporting data before it will automatically resolve from a triggered state. Defaults to false.

property type

type: pulumi.Input<string>;

The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Available options to choose from are: * metric alert * service check * event alert * query alert * composite * log alert

interface MonitorState

Input properties used for looking up and filtering Monitor resources.

property enableLogsSample

enableLogsSample?: pulumi.Input<boolean>;

A boolean indicating whether or not to include a list of log values which triggered the alert. Defaults to false. This is only used by log monitors. triggering tags into the title. Defaults to true.

property escalationMessage

escalationMessage?: pulumi.Input<string>;

A message to include with a re-notification. Supports the ‘@username’ notification allowed elsewhere.

property evaluationDelay

evaluationDelay?: pulumi.Input<number>;

property includeTags

includeTags?: pulumi.Input<boolean>;

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

property locked

locked?: pulumi.Input<boolean>;

A boolean indicating whether changes to to this monitor should be restricted to the creator or admins. Defaults to False.

property message

message?: pulumi.Input<string>;

A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same ‘@username’ notation as events.

property name

name?: pulumi.Input<string>;

Name of Datadog monitor

property newHostDelay

newHostDelay?: pulumi.Input<number>;

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300. * evaluation_delay (Optional, only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.

property noDataTimeframe

noDataTimeframe?: pulumi.Input<number>;

The number of minutes before a monitor will notify when data stops reporting. Must be at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks. Default: 2x timeframe for metric alerts, 2 minutes for service checks. Defaults to 10 minutes.

property notifyAudit

notifyAudit?: pulumi.Input<boolean>;

A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.

property notifyNoData

notifyNoData?: pulumi.Input<boolean>;

A boolean indicating whether this monitor will notify when data stops reporting. Defaults to false.

property query

query?: pulumi.Input<string>;

property renotifyInterval

renotifyInterval?: pulumi.Input<number>;

The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it’s not resolved.

property requireFullWindow

requireFullWindow?: pulumi.Input<boolean>;

A boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to False for sparse metrics, otherwise some evaluations will be skipped. Default: True for “on average”, “at all times” and “in total” aggregation. False otherwise.

property silenced

silenced?: pulumi.Input<{[key: string]: pulumi.Input<number>}>;

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it’s not currently possible to filter by these tags when querying via the API

property thresholdWindows

thresholdWindows?: pulumi.Input<{
    recoveryWindow: pulumi.Input<string>;
    triggerWindow: pulumi.Input<string>;
}>;

A mapping containing recovery_window and trigger_window values, e.g. last_15m. Can only be used for anomaly monitors. * recovery_window describes how long an anomalous metric must be normal before the alert recovers.

property thresholds

thresholds?: pulumi.Input<{
    critical: pulumi.Input<number>;
    criticalRecovery: pulumi.Input<number>;
    ok: pulumi.Input<number>;
    unknown: pulumi.Input<number>;
    warning: pulumi.Input<number>;
    warningRecovery: pulumi.Input<number>;
}>;
  • Metric alerts: A dictionary of thresholds by threshold type. Currently we have four threshold types for metric alerts: critical, critical recovery, warning, and warning recovery. Critical is defined in the query, but can also be specified in this option. Warning and recovery thresholds can only be specified using the thresholds option. Example usage: thresholds = { critical = 90 critical_recovery = 85 warning = 80 warning_recovery = 75 } Warning: the critical threshold value must match the one contained in the query argument. The threshold from the previous example is valid along with a query like avg(last_1h):avg:system.disk.in_use{role:sqlserver} by {host} > 90 but along with something like avg(last_1h):avg:system.disk.in_use{role:sqlserver} by {host} > 95 would make the Datadog API return a HTTP error 400, complaining “The value provided for parameter ‘query’ is invalid”.
  • Service checks: A dictionary of thresholds by status. Because service checks can have multiple thresholds, we don’t define them directly in the query. Default values: thresholds = { ok = 1 critical = 1 warning = 1 unknown = 1 }

property timeoutH

timeoutH?: pulumi.Input<number>;

The number of hours of the monitor not reporting data before it will automatically resolve from a triggered state. Defaults to false.

property type

type?: pulumi.Input<string>;

The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Available options to choose from are: * metric alert * service check * event alert * query alert * composite * log alert

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property apiKey

apiKey?: pulumi.Input<string>;

property apiUrl

apiUrl?: pulumi.Input<string>;

property appKey

appKey?: pulumi.Input<string>;

interface ScreenBoardArgs

The set of arguments for constructing a ScreenBoard resource.

property height

height?: pulumi.Input<string>;

Height of the screenboard

property readOnly

readOnly?: pulumi.Input<boolean>;

property shared

shared?: pulumi.Input<boolean>;

Whether the screenboard is shared or not

property templateVariables

templateVariables?: pulumi.Input<pulumi.Input<{
    default: pulumi.Input<string>;
    name: pulumi.Input<string>;
    prefix: pulumi.Input<string>;
}>[]>;

A list of template variables for using Dashboard templating.

property title

title: pulumi.Input<string>;

Name of the screenboard

property widgets

widgets: pulumi.Input<pulumi.Input<{
    alertId: pulumi.Input<number>;
    autoRefresh: pulumi.Input<boolean>;
    bgcolor: pulumi.Input<string>;
    check: pulumi.Input<string>;
    color: pulumi.Input<string>;
    colorPreference: pulumi.Input<string>;
    columns: pulumi.Input<string>;
    displayFormat: pulumi.Input<string>;
    env: pulumi.Input<string>;
    eventSize: pulumi.Input<string>;
    fontSize: pulumi.Input<string>;
    group: pulumi.Input<string>;
    groupBies: pulumi.Input<pulumi.Input<string>[]>;
    grouping: pulumi.Input<string>;
    height: pulumi.Input<number>;
    hideZeroCounts: pulumi.Input<boolean>;
    html: pulumi.Input<string>;
    layoutVersion: pulumi.Input<string>;
    legend: pulumi.Input<boolean>;
    legendSize: pulumi.Input<string>;
    logset: pulumi.Input<string>;
    manageStatusShowTitle: pulumi.Input<boolean>;
    manageStatusTitleAlign: pulumi.Input<string>;
    manageStatusTitleSize: pulumi.Input<string>;
    manageStatusTitleText: pulumi.Input<string>;
    margin: pulumi.Input<string>;
    monitor: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    mustShowBreakdown: pulumi.Input<boolean>;
    mustShowDistribution: pulumi.Input<boolean>;
    mustShowErrors: pulumi.Input<boolean>;
    mustShowHits: pulumi.Input<boolean>;
    mustShowLatency: pulumi.Input<boolean>;
    mustShowResourceList: pulumi.Input<boolean>;
    params: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    precision: pulumi.Input<string>;
    query: pulumi.Input<string>;
    rules: pulumi.Input<pulumi.Input<{
        color: pulumi.Input<string>;
        threshold: pulumi.Input<number>;
        timeframe: pulumi.Input<string>;
    }>[]>;
    serviceName: pulumi.Input<string>;
    serviceService: pulumi.Input<string>;
    sizeVersion: pulumi.Input<string>;
    sizing: pulumi.Input<string>;
    tags: pulumi.Input<pulumi.Input<string>[]>;
    text: pulumi.Input<string>;
    textAlign: pulumi.Input<string>;
    textSize: pulumi.Input<string>;
    tick: pulumi.Input<boolean>;
    tickEdge: pulumi.Input<string>;
    tickPos: pulumi.Input<string>;
    tileDeves: pulumi.Input<pulumi.Input<{
        autoscale: pulumi.Input<boolean>;
        customUnit: pulumi.Input<string>;
        events: pulumi.Input<pulumi.Input<{
            q: pulumi.Input<string>;
        }>[]>;
        groups: pulumi.Input<pulumi.Input<string>[]>;
        markers: pulumi.Input<pulumi.Input<{
            label: pulumi.Input<string>;
            type: pulumi.Input<string>;
            value: pulumi.Input<string>;
        }>[]>;
        noGroupHosts: pulumi.Input<boolean>;
        noMetricHosts: pulumi.Input<boolean>;
        nodeType: pulumi.Input<string>;
        precision: pulumi.Input<string>;
        requests: pulumi.Input<pulumi.Input<{
            aggregator: pulumi.Input<string>;
            changeType: pulumi.Input<string>;
            compareTo: pulumi.Input<string>;
            conditionalFormats: pulumi.Input<pulumi.Input<{
                color: pulumi.Input<string>;
                comparator: pulumi.Input<string>;
                customBgColor: pulumi.Input<string>;
                invert: pulumi.Input<boolean>;
                palette: pulumi.Input<string>;
                value: pulumi.Input<string>;
            }>[]>;
            extraCol: pulumi.Input<string>;
            increaseGood: pulumi.Input<boolean>;
            limit: pulumi.Input<number>;
            metadataJson: pulumi.Input<string>;
            metric: pulumi.Input<string>;
            orderBy: pulumi.Input<string>;
            orderDir: pulumi.Input<string>;
            q: pulumi.Input<string>;
            queryType: pulumi.Input<string>;
            style: pulumi.Input<{[key: string]: any}>;
            tagFilters: pulumi.Input<pulumi.Input<string>[]>;
            textFilter: pulumi.Input<string>;
            type: pulumi.Input<string>;
        }>[]>;
        scopes: pulumi.Input<pulumi.Input<string>[]>;
        style: pulumi.Input<{[key: string]: any}>;
        textAlign: pulumi.Input<string>;
        viz: pulumi.Input<string>;
    }>[]>;
    time: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    timeframes: pulumi.Input<pulumi.Input<string>[]>;
    title: pulumi.Input<string>;
    titleAlign: pulumi.Input<string>;
    titleSize: pulumi.Input<number>;
    type: pulumi.Input<string>;
    unit: pulumi.Input<string>;
    url: pulumi.Input<string>;
    vizType: pulumi.Input<string>;
    width: pulumi.Input<number>;
    x: pulumi.Input<number>;
    y: pulumi.Input<number>;
}>[]>;

A list of widget definitions.

property width

width?: pulumi.Input<string>;

Width of the screenboard

interface ScreenBoardState

Input properties used for looking up and filtering ScreenBoard resources.

property height

height?: pulumi.Input<string>;

Height of the screenboard

property readOnly

readOnly?: pulumi.Input<boolean>;

property shared

shared?: pulumi.Input<boolean>;

Whether the screenboard is shared or not

property templateVariables

templateVariables?: pulumi.Input<pulumi.Input<{
    default: pulumi.Input<string>;
    name: pulumi.Input<string>;
    prefix: pulumi.Input<string>;
}>[]>;

A list of template variables for using Dashboard templating.

property title

title?: pulumi.Input<string>;

Name of the screenboard

property widgets

widgets?: pulumi.Input<pulumi.Input<{
    alertId: pulumi.Input<number>;
    autoRefresh: pulumi.Input<boolean>;
    bgcolor: pulumi.Input<string>;
    check: pulumi.Input<string>;
    color: pulumi.Input<string>;
    colorPreference: pulumi.Input<string>;
    columns: pulumi.Input<string>;
    displayFormat: pulumi.Input<string>;
    env: pulumi.Input<string>;
    eventSize: pulumi.Input<string>;
    fontSize: pulumi.Input<string>;
    group: pulumi.Input<string>;
    groupBies: pulumi.Input<pulumi.Input<string>[]>;
    grouping: pulumi.Input<string>;
    height: pulumi.Input<number>;
    hideZeroCounts: pulumi.Input<boolean>;
    html: pulumi.Input<string>;
    layoutVersion: pulumi.Input<string>;
    legend: pulumi.Input<boolean>;
    legendSize: pulumi.Input<string>;
    logset: pulumi.Input<string>;
    manageStatusShowTitle: pulumi.Input<boolean>;
    manageStatusTitleAlign: pulumi.Input<string>;
    manageStatusTitleSize: pulumi.Input<string>;
    manageStatusTitleText: pulumi.Input<string>;
    margin: pulumi.Input<string>;
    monitor: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    mustShowBreakdown: pulumi.Input<boolean>;
    mustShowDistribution: pulumi.Input<boolean>;
    mustShowErrors: pulumi.Input<boolean>;
    mustShowHits: pulumi.Input<boolean>;
    mustShowLatency: pulumi.Input<boolean>;
    mustShowResourceList: pulumi.Input<boolean>;
    params: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    precision: pulumi.Input<string>;
    query: pulumi.Input<string>;
    rules: pulumi.Input<pulumi.Input<{
        color: pulumi.Input<string>;
        threshold: pulumi.Input<number>;
        timeframe: pulumi.Input<string>;
    }>[]>;
    serviceName: pulumi.Input<string>;
    serviceService: pulumi.Input<string>;
    sizeVersion: pulumi.Input<string>;
    sizing: pulumi.Input<string>;
    tags: pulumi.Input<pulumi.Input<string>[]>;
    text: pulumi.Input<string>;
    textAlign: pulumi.Input<string>;
    textSize: pulumi.Input<string>;
    tick: pulumi.Input<boolean>;
    tickEdge: pulumi.Input<string>;
    tickPos: pulumi.Input<string>;
    tileDeves: pulumi.Input<pulumi.Input<{
        autoscale: pulumi.Input<boolean>;
        customUnit: pulumi.Input<string>;
        events: pulumi.Input<pulumi.Input<{
            q: pulumi.Input<string>;
        }>[]>;
        groups: pulumi.Input<pulumi.Input<string>[]>;
        markers: pulumi.Input<pulumi.Input<{
            label: pulumi.Input<string>;
            type: pulumi.Input<string>;
            value: pulumi.Input<string>;
        }>[]>;
        noGroupHosts: pulumi.Input<boolean>;
        noMetricHosts: pulumi.Input<boolean>;
        nodeType: pulumi.Input<string>;
        precision: pulumi.Input<string>;
        requests: pulumi.Input<pulumi.Input<{
            aggregator: pulumi.Input<string>;
            changeType: pulumi.Input<string>;
            compareTo: pulumi.Input<string>;
            conditionalFormats: pulumi.Input<pulumi.Input<{
                color: pulumi.Input<string>;
                comparator: pulumi.Input<string>;
                customBgColor: pulumi.Input<string>;
                invert: pulumi.Input<boolean>;
                palette: pulumi.Input<string>;
                value: pulumi.Input<string>;
            }>[]>;
            extraCol: pulumi.Input<string>;
            increaseGood: pulumi.Input<boolean>;
            limit: pulumi.Input<number>;
            metadataJson: pulumi.Input<string>;
            metric: pulumi.Input<string>;
            orderBy: pulumi.Input<string>;
            orderDir: pulumi.Input<string>;
            q: pulumi.Input<string>;
            queryType: pulumi.Input<string>;
            style: pulumi.Input<{[key: string]: any}>;
            tagFilters: pulumi.Input<pulumi.Input<string>[]>;
            textFilter: pulumi.Input<string>;
            type: pulumi.Input<string>;
        }>[]>;
        scopes: pulumi.Input<pulumi.Input<string>[]>;
        style: pulumi.Input<{[key: string]: any}>;
        textAlign: pulumi.Input<string>;
        viz: pulumi.Input<string>;
    }>[]>;
    time: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    timeframes: pulumi.Input<pulumi.Input<string>[]>;
    title: pulumi.Input<string>;
    titleAlign: pulumi.Input<string>;
    titleSize: pulumi.Input<number>;
    type: pulumi.Input<string>;
    unit: pulumi.Input<string>;
    url: pulumi.Input<string>;
    vizType: pulumi.Input<string>;
    width: pulumi.Input<number>;
    x: pulumi.Input<number>;
    y: pulumi.Input<number>;
}>[]>;

A list of widget definitions.

property width

width?: pulumi.Input<string>;

Width of the screenboard

interface SyntheticsTestArgs

The set of arguments for constructing a SyntheticsTest resource.

property assertions

assertions?: pulumi.Input<pulumi.Input<{[key: string]: any}>[]>;

property deviceIds

deviceIds?: pulumi.Input<pulumi.Input<string>[]>;

property locations

locations: pulumi.Input<pulumi.Input<string>[]>;

property message

message?: pulumi.Input<string>;

property name

property options

options?: pulumi.Input<{
    followRedirects: pulumi.Input<boolean>;
    minFailureDuration: pulumi.Input<number>;
    minLocationFailed: pulumi.Input<number>;
    tickEvery: pulumi.Input<number>;
}>;

property request

request: pulumi.Input<{
    body: pulumi.Input<string>;
    method: pulumi.Input<string>;
    timeout: pulumi.Input<number>;
    url: pulumi.Input<string>;
}>;

property requestHeaders

requestHeaders?: pulumi.Input<{[key: string]: any}>;

property status

status: pulumi.Input<string>;

property tags

property type

interface SyntheticsTestState

Input properties used for looking up and filtering SyntheticsTest resources.

property assertions

assertions?: pulumi.Input<pulumi.Input<{[key: string]: any}>[]>;

property deviceIds

deviceIds?: pulumi.Input<pulumi.Input<string>[]>;

property locations

locations?: pulumi.Input<pulumi.Input<string>[]>;

property message

message?: pulumi.Input<string>;

property monitorId

monitorId?: pulumi.Input<number>;

property name

name?: pulumi.Input<string>;

property options

options?: pulumi.Input<{
    followRedirects: pulumi.Input<boolean>;
    minFailureDuration: pulumi.Input<number>;
    minLocationFailed: pulumi.Input<number>;
    tickEvery: pulumi.Input<number>;
}>;

property request

request?: pulumi.Input<{
    body: pulumi.Input<string>;
    method: pulumi.Input<string>;
    timeout: pulumi.Input<number>;
    url: pulumi.Input<string>;
}>;

property requestHeaders

requestHeaders?: pulumi.Input<{[key: string]: any}>;

property status

status?: pulumi.Input<string>;

property tags

property type

type?: pulumi.Input<string>;

interface TimeBoardArgs

The set of arguments for constructing a TimeBoard resource.

property description

description: pulumi.Input<string>;

A description of the dashboard’s content.

property graphs

graphs: pulumi.Input<pulumi.Input<{
    autoscale: pulumi.Input<boolean>;
    customUnit: pulumi.Input<string>;
    events: pulumi.Input<pulumi.Input<string>[]>;
    groups: pulumi.Input<pulumi.Input<string>[]>;
    includeNoMetricHosts: pulumi.Input<boolean>;
    includeUngroupedHosts: pulumi.Input<boolean>;
    markers: pulumi.Input<pulumi.Input<{
        label: pulumi.Input<string>;
        type: pulumi.Input<string>;
        value: pulumi.Input<string>;
    }>[]>;
    nodeType: pulumi.Input<string>;
    precision: pulumi.Input<string>;
    requests: pulumi.Input<pulumi.Input<{
        aggregator: pulumi.Input<string>;
        changeType: pulumi.Input<string>;
        compareTo: pulumi.Input<string>;
        conditionalFormats: pulumi.Input<pulumi.Input<{
            comparator: pulumi.Input<string>;
            customBgColor: pulumi.Input<string>;
            customFgColor: pulumi.Input<string>;
            palette: pulumi.Input<string>;
            value: pulumi.Input<string>;
        }>[]>;
        extraCol: pulumi.Input<string>;
        increaseGood: pulumi.Input<boolean>;
        metadataJson: pulumi.Input<string>;
        orderBy: pulumi.Input<string>;
        orderDirection: pulumi.Input<string>;
        q: pulumi.Input<string>;
        stacked: pulumi.Input<boolean>;
        style: pulumi.Input<{[key: string]: any}>;
        type: pulumi.Input<string>;
    }>[]>;
    scopes: pulumi.Input<pulumi.Input<string>[]>;
    style: pulumi.Input<{[key: string]: any}>;
    textAlign: pulumi.Input<string>;
    title: pulumi.Input<string>;
    viz: pulumi.Input<string>;
    yaxis: pulumi.Input<{[key: string]: any}>;
}>[]>;

Nested block describing a graph definition. The structure of this block is described below. Multiple graph blocks are allowed within a datadog_timeboard resource.

property readOnly

readOnly?: pulumi.Input<boolean>;

The read-only status of the timeboard. Default is false.

property templateVariables

templateVariables?: pulumi.Input<pulumi.Input<{
    default: pulumi.Input<string>;
    name: pulumi.Input<string>;
    prefix: pulumi.Input<string>;
}>[]>;

Nested block describing a template variable. The structure of this block is described below. Multiple template_variable blocks are allowed within a datadog_timeboard resource.

property title

title: pulumi.Input<string>;

The name of the dashboard.

interface TimeBoardState

Input properties used for looking up and filtering TimeBoard resources.

property description

description?: pulumi.Input<string>;

A description of the dashboard’s content.

property graphs

graphs?: pulumi.Input<pulumi.Input<{
    autoscale: pulumi.Input<boolean>;
    customUnit: pulumi.Input<string>;
    events: pulumi.Input<pulumi.Input<string>[]>;
    groups: pulumi.Input<pulumi.Input<string>[]>;
    includeNoMetricHosts: pulumi.Input<boolean>;
    includeUngroupedHosts: pulumi.Input<boolean>;
    markers: pulumi.Input<pulumi.Input<{
        label: pulumi.Input<string>;
        type: pulumi.Input<string>;
        value: pulumi.Input<string>;
    }>[]>;
    nodeType: pulumi.Input<string>;
    precision: pulumi.Input<string>;
    requests: pulumi.Input<pulumi.Input<{
        aggregator: pulumi.Input<string>;
        changeType: pulumi.Input<string>;
        compareTo: pulumi.Input<string>;
        conditionalFormats: pulumi.Input<pulumi.Input<{
            comparator: pulumi.Input<string>;
            customBgColor: pulumi.Input<string>;
            customFgColor: pulumi.Input<string>;
            palette: pulumi.Input<string>;
            value: pulumi.Input<string>;
        }>[]>;
        extraCol: pulumi.Input<string>;
        increaseGood: pulumi.Input<boolean>;
        metadataJson: pulumi.Input<string>;
        orderBy: pulumi.Input<string>;
        orderDirection: pulumi.Input<string>;
        q: pulumi.Input<string>;
        stacked: pulumi.Input<boolean>;
        style: pulumi.Input<{[key: string]: any}>;
        type: pulumi.Input<string>;
    }>[]>;
    scopes: pulumi.Input<pulumi.Input<string>[]>;
    style: pulumi.Input<{[key: string]: any}>;
    textAlign: pulumi.Input<string>;
    title: pulumi.Input<string>;
    viz: pulumi.Input<string>;
    yaxis: pulumi.Input<{[key: string]: any}>;
}>[]>;

Nested block describing a graph definition. The structure of this block is described below. Multiple graph blocks are allowed within a datadog_timeboard resource.

property readOnly

readOnly?: pulumi.Input<boolean>;

The read-only status of the timeboard. Default is false.

property templateVariables

templateVariables?: pulumi.Input<pulumi.Input<{
    default: pulumi.Input<string>;
    name: pulumi.Input<string>;
    prefix: pulumi.Input<string>;
}>[]>;

Nested block describing a template variable. The structure of this block is described below. Multiple template_variable blocks are allowed within a datadog_timeboard resource.

property title

title?: pulumi.Input<string>;

The name of the dashboard.

interface UserArgs

The set of arguments for constructing a User resource.

property accessRole

accessRole?: pulumi.Input<string>;

Role description for user. Can be st (standard user), adm (admin user) or ro (read-only user). Default is st.

property disabled

disabled?: pulumi.Input<boolean>;

Whether the user is disabled

property email

email: pulumi.Input<string>;

Email address for user

property handle

handle: pulumi.Input<string>;

The user handle, must be a valid email.

property isAdmin

isAdmin?: pulumi.Input<boolean>;

(Optional) Whether the user is an administrator. Warning: the corresponding query parameter is ignored by the Datadog API, thus the argument would always trigger an execution plan.

property name

name: pulumi.Input<string>;

Name for user

property role

role?: pulumi.Input<string>;

Role description for user. Warning: the corresponding query parameter is ignored by the Datadog API, thus the argument would always trigger an execution plan.

interface UserState

Input properties used for looking up and filtering User resources.

property accessRole

accessRole?: pulumi.Input<string>;

Role description for user. Can be st (standard user), adm (admin user) or ro (read-only user). Default is st.

property disabled

disabled?: pulumi.Input<boolean>;

Whether the user is disabled

property email

email?: pulumi.Input<string>;

Email address for user

property handle

handle?: pulumi.Input<string>;

The user handle, must be a valid email.

property isAdmin

isAdmin?: pulumi.Input<boolean>;

(Optional) Whether the user is an administrator. Warning: the corresponding query parameter is ignored by the Datadog API, thus the argument would always trigger an execution plan.

property name

name?: pulumi.Input<string>;

Name for user

property role

role?: pulumi.Input<string>;

Role description for user. Warning: the corresponding query parameter is ignored by the Datadog API, thus the argument would always trigger an execution plan.

property verified

verified?: pulumi.Input<boolean>;

Returns true if Datadog user is verified