1. Docs
2. Reference
3. API
4. @pulumi/datadog

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

• aws
• config
• gcp
• pagerduty
• types

Resources

• Dashboard
• DashboardList
• Downtime
• LogsCustomPipeline
• LogsIndex
• LogsIndexOrder
• LogsIntegrationPipeline
• LogsPipelineOrder
• MetricMetadata
• Monitor
• Provider
• ScreenBoard
• ServiceLevelObjective
• SyntheticsTest
• TimeBoard
• User

Functions

• getIpRanges

Others

• DashboardArgs
• DashboardListArgs
• DashboardListState
• DashboardState
• DowntimeArgs
• DowntimeState
• getEnv
• getEnvBoolean
• getEnvNumber
• GetIpRangesResult
• getVersion
• LogsCustomPipelineArgs
• LogsCustomPipelineState
• LogsIndexArgs
• LogsIndexOrderArgs
• LogsIndexOrderState
• LogsIndexState
• LogsIntegrationPipelineArgs
• LogsIntegrationPipelineState
• LogsPipelineOrderArgs
• LogsPipelineOrderState
• MetricMetadataArgs
• MetricMetadataState
• MonitorArgs
• MonitorState
• ProviderArgs
• ScreenBoardArgs
• ScreenBoardState
• ServiceLevelObjectiveArgs
• ServiceLevelObjectiveState
• SyntheticsTestArgs
• SyntheticsTestState
• TimeBoardArgs
• TimeBoardState
• UserArgs
• UserState

Resources

Resource Dashboard

class Dashboard extends CustomResource

constructor

new Dashboard(name: string, args: DashboardArgs, opts?: pulumi.CustomResourceOptions)

Create a Dashboard 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?: DashboardState, opts?: pulumi.CustomResourceOptions): Dashboard

Get an existing Dashboard 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): obj is Dashboard

Returns true if the given object is an instance of Dashboard. 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>;

The description of the dashboard.

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 isReadOnly

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

Whether this dashboard is read-only.

property layoutType

public layoutType: pulumi.Output<string>;

The layout type of the dashboard, either ‘free’ or ‘ordered’.

property notifyLists

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

The list of handles of users to notify when changes are made to this dashboard.

property templateVariablePresets

public templateVariablePresets: pulumi.Output<DashboardTemplateVariablePreset[] | undefined>;

The list of selectable template variable presets for this dashboard.

property templateVariables

public templateVariables: pulumi.Output<DashboardTemplateVariable[] | undefined>;

The list of template variables for this dashboard.

property title

public title: pulumi.Output<string>;

The title 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.

property widgets

public widgets: pulumi.Output<DashboardWidget[]>;

The list of widgets to display on the dashboard.

Resource DashboardList

class DashboardList extends CustomResource

constructor

new DashboardList(name: string, args: DashboardListArgs, opts?: pulumi.CustomResourceOptions)

Create a DashboardList 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?: DashboardListState, opts?: pulumi.CustomResourceOptions): DashboardList

Get an existing DashboardList 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): obj is DashboardList

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

property dashItems

public dashItems: pulumi.Output<DashboardListDashItem[] | undefined>;

An individual dashboard object to add to this Dashboard List. If present, must contain the following:

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 name

public name: pulumi.Output<string>;

The name of this Dashbaord List.

property urn

urn: Output<URN>;

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

Resource Downtime

class Downtime extends CustomResource

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

Example: downtime for a specific monitor

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

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

Example: downtime for all monitors

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

// 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,
});

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): obj is Downtime

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 monitorId as it will match all monitors that match these tags.

property recurrence

public recurrence: pulumi.Output<DowntimeRecurrence | 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.

Resource LogsCustomPipeline

class LogsCustomPipeline extends CustomResource

Provides a Datadog Logs Pipeline API resource, which is used to create and manage Datadog logs custom pipelines.

Example Usage

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

const samplePipeline = new datadog.LogsCustomPipeline("samplePipeline", {
    filters: [{
        query: "source:foo",
    }],
    isEnabled: true,
    name: "sample pipeline",
    processors: [
        {
            arithmeticProcessor: {
                expression: "(time1 - time2)*1000",
                isEnabled: true,
                isReplaceMissing: true,
                name: "sample arithmetic processor",
                target: "myArithmetic",
            },
        },
        {
            attributeRemapper: {
                isEnabled: true,
                name: "sample attribute processor",
                overrideOnConflict: false,
                preserveSource: true,
                sourceType: "tag",
                sources: ["db.instance"],
                target: "db",
                targetType: "tag",
            },
        },
        {
            categoryProcessor: {
                categories: [
                    {
                        filters: [{
                            query: "@severity: \".\"",
                        }],
                        name: "debug",
                    },
                    {
                        filters: [{
                            query: "@severity: \"-\"",
                        }],
                        name: "verbose",
                    },
                ],
                isEnabled: true,
                name: "sample category processor",
                target: "foo.severity",
            },
        },
        {
            dateRemapper: {
                isEnabled: true,
                name: "sample date remapper",
                sources: [
                    "_timestamp",
                    "publishedDate",
                ],
            },
        },
        {
            geoIpParser: {
                isEnabled: true,
                name: "sample geo ip parser",
                sources: ["network.client.ip"],
                target: "network.client.geoip",
            },
        },
        {
            grokParser: {
                grok: {
                    matchRules: "Rule %%{word:my_word2} %%{number:my_float2}",
                    supportRules: "",
                },
                isEnabled: true,
                name: "sample grok parser",
                samples: ["sample log 1"],
                source: "message",
            },
        },
        {
            messageRemapper: {
                isEnabled: true,
                name: "sample message remapper",
                sources: ["msg"],
            },
        },
        {
            pipeline: {
                filters: [{
                    query: "source:foo",
                }],
                isEnabled: true,
                name: "nested pipeline",
                processors: [{
                    urlParser: {
                        name: "sample url parser",
                        normalizeEndingSlashes: true,
                        sources: [
                            "url",
                            "extra",
                        ],
                        target: "httpUrl",
                    },
                }],
            },
        },
        {
            serviceRemapper: {
                isEnabled: true,
                name: "sample service remapper",
                sources: ["service"],
            },
        },
        {
            statusRemapper: {
                isEnabled: true,
                name: "sample status remapper",
                sources: [
                    "info",
                    "trace",
                ],
            },
        },
        {
            stringBuilderProcessor: {
                isEnabled: true,
                isReplaceMissing: false,
                name: "sample string builder processor",
                target: "userActivity",
                template: "%%{user.name} logged in at %%{timestamp}",
            },
        },
        {
            traceIdRemapper: {
                isEnabled: true,
                name: "sample trace id remapper",
                sources: ["dd.trace_id"],
            },
        },
        {
            userAgentParser: {
                isEnabled: true,
                isEncoded: false,
                name: "sample user agent parser",
                sources: [
                    "user",
                    "agent",
                ],
                target: "httpAgent",
            },
        },
    ],
});

Important Notes

Each datadog..LogsCustomPipeline resource defines a complete pipeline. The order of the pipelines is maintained in a different resource datadog_logs_pipeline_order. When creating a new pipeline, you need to explicitly add this pipeline to the datadog..LogsPipelineOrder resource to track the pipeline. Similarly, when a pipeline needs to be destroyed, remove its references from the datadog..LogsPipelineOrder resource.

constructor

new LogsCustomPipeline(name: string, args: LogsCustomPipelineArgs, opts?: pulumi.CustomResourceOptions)

Create a LogsCustomPipeline 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?: LogsCustomPipelineState, opts?: pulumi.CustomResourceOptions): LogsCustomPipeline

Get an existing LogsCustomPipeline 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): obj is LogsCustomPipeline

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

property filters

public filters: pulumi.Output<LogsCustomPipelineFilter[]>;

Defines the nested pipeline filter. Only logs that match the filter criteria are processed by this pipeline.

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 isEnabled

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

If the processor is enabled or not.

property name

public name: pulumi.Output<string>;

Name of the processor

property processors

public processors: pulumi.Output<LogsCustomPipelineProcessor[] | undefined>;

Processors. Nested pipeline can’t take any other nested pipeline as its processor.

property urn

urn: Output<URN>;

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

Resource LogsIndex

class LogsIndex extends CustomResource

constructor

new LogsIndex(name: string, args: LogsIndexArgs, opts?: pulumi.CustomResourceOptions)

Create a LogsIndex 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?: LogsIndexState, opts?: pulumi.CustomResourceOptions): LogsIndex

Get an existing LogsIndex 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): obj is LogsIndex

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

property exclusionFilters

public exclusionFilters: pulumi.Output<LogsIndexExclusionFilter[] | undefined>;

List of exclusion filters.

property filters

public filters: pulumi.Output<LogsIndexFilter[]>;

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 name

public name: pulumi.Output<string>;

The name of the exclusion filter.

property urn

urn: Output<URN>;

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

Resource LogsIndexOrder

class LogsIndexOrder extends CustomResource

Provides a Datadog Logs Index API resource. This can be used to manage the order of Datadog logs indexes.

Example Usage

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

const sampleIndexOrder = new datadog.LogsIndexOrder("sampleIndexOrder", {
    name: "sampleIndexOrder",
    indexes: [datadog_logs_index.sample_index.id],
});

constructor

new LogsIndexOrder(name: string, args: LogsIndexOrderArgs, opts?: pulumi.CustomResourceOptions)

Create a LogsIndexOrder 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?: LogsIndexOrderState, opts?: pulumi.CustomResourceOptions): LogsIndexOrder

Get an existing LogsIndexOrder 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): obj is LogsIndexOrder

Returns true if the given object is an instance of LogsIndexOrder. 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 indexes

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

The index resource list. Logs are tested against the query filter of each index one by one following the order of the list.

property name

public name: pulumi.Output<string>;

The unique name of the index order resource.

property urn

urn: Output<URN>;

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

Resource LogsIntegrationPipeline

class LogsIntegrationPipeline extends CustomResource

Provides a Datadog Logs Pipeline API resource to manage the integrations.

Integration pipelines are the pipelines that are automatically installed for your organization when sending the logs with specific sources. You don’t need to maintain or update these types of pipelines. Keeping them as resources, however, allows you to manage the order of your pipelines by referencing them in your datadog..LogsPipelineOrder resource. If you don’t need the pipelineOrder feature, this resource declaration can be omitted.

Example Usage

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

const python = new datadog.LogsIntegrationPipeline("python", {
    isEnabled: true,
});

constructor

new LogsIntegrationPipeline(name: string, args?: LogsIntegrationPipelineArgs, opts?: pulumi.CustomResourceOptions)

Create a LogsIntegrationPipeline 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?: LogsIntegrationPipelineState, opts?: pulumi.CustomResourceOptions): LogsIntegrationPipeline

Get an existing LogsIntegrationPipeline 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): obj is LogsIntegrationPipeline

Returns true if the given object is an instance of LogsIntegrationPipeline. 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 isEnabled

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

Boolean value to enable your pipeline.

property urn

urn: Output<URN>;

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

Resource LogsPipelineOrder

class LogsPipelineOrder extends CustomResource

Provides a Datadog Logs Pipeline API resource, which is used to manage Datadog log pipelines order.

Example Usage

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

const samplePipelineOrder = new datadog.LogsPipelineOrder("samplePipelineOrder", {
    name: "samplePipelineOrder",
    pipelines: [
        datadog_logs_custom_pipeline.sample_pipeline.id,
        datadog_logs_integration_pipeline.python.id,
    ],
});

constructor

new LogsPipelineOrder(name: string, args: LogsPipelineOrderArgs, opts?: pulumi.CustomResourceOptions)

Create a LogsPipelineOrder 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?: LogsPipelineOrderState, opts?: pulumi.CustomResourceOptions): LogsPipelineOrder

Get an existing LogsPipelineOrder 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): obj is LogsPipelineOrder

Returns true if the given object is an instance of LogsPipelineOrder. 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 name

public name: pulumi.Output<string>;

The name attribute in the resource datadog..LogsPipelineOrder needs to be unique. It’s recommended to use the same value as the resource NAME. No related field is available in Logs Pipeline API.

property pipelines

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

The pipeline IDs list. The order of pipeline IDs in this attribute defines the overall pipeline order for logs.

property urn

urn: Output<URN>;

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

Resource MetricMetadata

class MetricMetadata extends CustomResource

Provides a Datadog metricMetadata 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("requestTime", {
    description: "99th percentile request time in millseconds",
    metric: "request.time",
    shortName: "Request time",
    type: "gauge",
    unit: "millisecond",
});

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): obj is MetricMetadata

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.

Resource Monitor

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): obj is Monitor

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>;

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 last5m 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 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.

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]: any} | 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<MonitorThresholdWindows | undefined>;

A mapping containing recoveryWindow and triggerWindow values, e.g. last15m. Can only be used for, and are required for, anomaly monitors.

property thresholds

public thresholds: pulumi.Output<MonitorThresholds | 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 criticalRecovery = 85 warning = 80 warningRecovery = 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. The available options are below. Note: The monitor type cannot be changed after a monitor is created. * 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.

Resource Provider

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.

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): obj is Provider

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.

method register

static register(provider: ProviderResource | undefined): Promise<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 urn

urn: Output<URN>;

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

Resource ScreenBoard

class ScreenBoard extends CustomResource

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): obj is ScreenBoard

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<ScreenBoardTemplateVariable[] | 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<ScreenBoardWidget[]>;

A list of widget definitions.

property width

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

Width of the screenboard

Resource ServiceLevelObjective

class ServiceLevelObjective extends CustomResource

Provides a Datadog service level objective resource. This can be used to create and manage Datadog service level objectives.

Example Usage

Metric-Based SLO

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

// Create a new Datadog service level objective
const foo = new datadog.ServiceLevelObjective("foo", {
    description: "My custom metric SLO",
    name: "Example Metric SLO",
    query: {
        denominator: "sum:my.custom.count.metric{*}.as_count()",
        numerator: "sum:my.custom.count.metric{type:good_events}.as_count()",
    },
    tags: [
        "foo:bar",
        "baz",
    ],
    thresholds: [
        {
            target: 99.9,
            targetDisplay: "99.900",
            timeframe: "7d",
            warning: 99.99,
            warningDisplay: "99.990",
        },
        {
            target: 99.9,
            targetDisplay: "99.900",
            timeframe: "30d",
            warning: 99.99,
            warningDisplay: "99.990",
        },
    ],
    type: "metric",
});

Monitor-Based SLO

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

// Create a new Datadog service level objective
const bar = new datadog.ServiceLevelObjective("bar", {
    description: "My custom monitor SLO",
    monitorIds: [
        1,
        2,
        3,
    ],
    name: "Example Monitor SLO",
    tags: [
        "foo:bar",
        "baz",
    ],
    thresholds: [
        {
            target: 99.9,
            timeframe: "7d",
            warning: 99.99,
        },
        {
            target: 99.9,
            timeframe: "30d",
            warning: 99.99,
        },
    ],
    type: "monitor",
});

constructor

new ServiceLevelObjective(name: string, args: ServiceLevelObjectiveArgs, opts?: pulumi.CustomResourceOptions)

Create a ServiceLevelObjective 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?: ServiceLevelObjectiveState, opts?: pulumi.CustomResourceOptions): ServiceLevelObjective

Get an existing ServiceLevelObjective 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): obj is ServiceLevelObjective

Returns true if the given object is an instance of ServiceLevelObjective. 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 this service level objective.

property groups

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

A custom set of groups from the monitor(s) for which to use as the SLI instead of all the groups.

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 monitorIds

public monitorIds: pulumi.Output<number[] | undefined>;

A list of numeric monitor IDs for which to use as SLIs. Their tags will be auto-imported into monitorTags field in the API resource.

property name

public name: pulumi.Output<string>;

Name of Datadog service level objective

property query

public query: pulumi.Output<ServiceLevelObjectiveQuery | undefined>;

The metric query configuration to use for the SLI. This is a dictionary and requires both the numerator and denominator fields which should be count metrics using the sum aggregator.

property tags

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

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

property thresholds

public thresholds: pulumi.Output<ServiceLevelObjectiveThreshold[]>;

• A list of thresholds and targets that define the service level objectives from the provided SLIs.

property type

public type: pulumi.Output<string>;

The type of the service level objective. 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 * monitor

property urn

urn: Output<URN>;

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

Resource SyntheticsTest

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): obj is SyntheticsTest

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<SyntheticsTestOptions | undefined>;

property request

public request: pulumi.Output<SyntheticsTestRequest>;

property requestHeaders

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

property status

public status: pulumi.Output<string>;

property subtype

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

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.

Resource TimeBoard

class TimeBoard extends CustomResource

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): obj is TimeBoard

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<TimeBoardGraph[]>;

A list of graph definitions.

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 templateVariables

public templateVariables: pulumi.Output<TimeBoardTemplateVariable[] | undefined>;

A list of template variables for using Dashboard templating.

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.

Resource User

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",
});

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): obj is User

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>;

(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

Functions

Function getIpRanges

getIpRanges(opts?: pulumi.InvokeOptions): Promise<GetIpRangesResult>

Use this data source to retrieve information about Datadog’s IP addresses.

Example Usage

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

const test = pulumi.output(datadog.getIpRanges({ async: true }));

Others

interface DashboardArgs

interface DashboardArgs

The set of arguments for constructing a Dashboard resource.

property description

description?: pulumi.Input<string>;

The description of the dashboard.

property isReadOnly

isReadOnly?: pulumi.Input<boolean>;

Whether this dashboard is read-only.

property layoutType

layoutType: pulumi.Input<string>;

The layout type of the dashboard, either ‘free’ or ‘ordered’.

property notifyLists

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

The list of handles of users to notify when changes are made to this dashboard.

property templateVariablePresets

templateVariablePresets?: pulumi.Input<pulumi.Input<DashboardTemplateVariablePreset>[]>;

The list of selectable template variable presets for this dashboard.

property templateVariables

templateVariables?: pulumi.Input<pulumi.Input<DashboardTemplateVariable>[]>;

The list of template variables for this dashboard.

property title

title: pulumi.Input<string>;

The title of the dashboard.

property widgets

widgets: pulumi.Input<pulumi.Input<DashboardWidget>[]>;

The list of widgets to display on the dashboard.

interface DashboardListArgs

interface DashboardListArgs

The set of arguments for constructing a DashboardList resource.

property dashItems

dashItems?: pulumi.Input<pulumi.Input<DashboardListDashItem>[]>;

An individual dashboard object to add to this Dashboard List. If present, must contain the following:

property name

name: pulumi.Input<string>;

The name of this Dashbaord List.

interface DashboardListState

interface DashboardListState

Input properties used for looking up and filtering DashboardList resources.

property dashItems

dashItems?: pulumi.Input<pulumi.Input<DashboardListDashItem>[]>;

An individual dashboard object to add to this Dashboard List. If present, must contain the following:

property name

name?: pulumi.Input<string>;

The name of this Dashbaord List.

interface DashboardState

interface DashboardState

Input properties used for looking up and filtering Dashboard resources.

property description

description?: pulumi.Input<string>;

The description of the dashboard.

property isReadOnly

isReadOnly?: pulumi.Input<boolean>;

Whether this dashboard is read-only.

property layoutType

layoutType?: pulumi.Input<string>;

The layout type of the dashboard, either ‘free’ or ‘ordered’.

property notifyLists

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

The list of handles of users to notify when changes are made to this dashboard.

property templateVariablePresets

templateVariablePresets?: pulumi.Input<pulumi.Input<DashboardTemplateVariablePreset>[]>;

The list of selectable template variable presets for this dashboard.

property templateVariables

templateVariables?: pulumi.Input<pulumi.Input<DashboardTemplateVariable>[]>;

The list of template variables for this dashboard.

property title

title?: pulumi.Input<string>;

The title of the dashboard.

property widgets

widgets?: pulumi.Input<pulumi.Input<DashboardWidget>[]>;

The list of widgets to display on the dashboard.

interface DowntimeArgs

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 monitorId as it will match all monitors that match these tags.

property recurrence

recurrence?: pulumi.Input<DowntimeRecurrence>;

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

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 monitorId as it will match all monitors that match these tags.

property recurrence

recurrence?: pulumi.Input<DowntimeRecurrence>;

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.

function getEnv

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

function getEnvBoolean

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

function getEnvNumber

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

interface GetIpRangesResult

interface GetIpRangesResult

A collection of values returned by getIpRanges.

property agentsIpv4s

agentsIpv4s: string[];

An Array of IPv4 addresses in CIDR format specifying the A records for the agent endpoint.

property agentsIpv6s

agentsIpv6s: string[];

An Array of IPv6 addresses in CIDR format specifying the A records for the agent endpoint.

property apiIpv4s

apiIpv4s: string[];

An Array of IPv4 addresses in CIDR format specifying the A records for the api endpoint.

property apiIpv6s

apiIpv6s: string[];

An Array of IPv6 addresses in CIDR format specifying the A records for the api endpoint.

property apmIpv4s

apmIpv4s: string[];

An Array of IPv4 addresses in CIDR format specifying the A records for the apm endpoint.

property apmIpv6s

apmIpv6s: string[];

An Array of IPv6 addresses in CIDR format specifying the A records for the apm endpoint.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property logsIpv4s

logsIpv4s: string[];

An Array of IPv4 addresses in CIDR format specifying the A records for the logs endpoint.

property logsIpv6s

logsIpv6s: string[];

An Array of IPv6 addresses in CIDR format specifying the A records for the logs endpoint.

property processIpv4s

processIpv4s: string[];

An Array of IPv4 addresses in CIDR format specifying the A records for the process endpoint.

property processIpv6s

processIpv6s: string[];

An Array of IPv6 addresses in CIDR format specifying the A records for the process endpoint.

property syntheticsIpv4s

syntheticsIpv4s: string[];

An Array of IPv4 addresses in CIDR format specifying the A records for the synthetics endpoint.

property syntheticsIpv6s

syntheticsIpv6s: string[];

An Array of IPv6 addresses in CIDR format specifying the A records for the synthetics endpoint.

property webhooksIpv4s

webhooksIpv4s: string[];

An Array of IPv4 addresses in CIDR format specifying the A records for the webhooks endpoint.

property webhooksIpv6s

webhooksIpv6s: string[];

An Array of IPv6 addresses in CIDR format specifying the A records for the webhooks endpoint.

function getVersion

getVersion(): string

interface LogsCustomPipelineArgs

interface LogsCustomPipelineArgs

The set of arguments for constructing a LogsCustomPipeline resource.

property filters

filters: pulumi.Input<pulumi.Input<LogsCustomPipelineFilter>[]>;

Defines the nested pipeline filter. Only logs that match the filter criteria are processed by this pipeline.

property isEnabled

isEnabled?: pulumi.Input<boolean>;

If the processor is enabled or not.

property name

name: pulumi.Input<string>;

Name of the processor

property processors

processors?: pulumi.Input<pulumi.Input<LogsCustomPipelineProcessor>[]>;

Processors. Nested pipeline can’t take any other nested pipeline as its processor.

interface LogsCustomPipelineState

interface LogsCustomPipelineState

Input properties used for looking up and filtering LogsCustomPipeline resources.

property filters

filters?: pulumi.Input<pulumi.Input<LogsCustomPipelineFilter>[]>;

Defines the nested pipeline filter. Only logs that match the filter criteria are processed by this pipeline.

property isEnabled

isEnabled?: pulumi.Input<boolean>;

If the processor is enabled or not.

property name

name?: pulumi.Input<string>;

Name of the processor

property processors

processors?: pulumi.Input<pulumi.Input<LogsCustomPipelineProcessor>[]>;

Processors. Nested pipeline can’t take any other nested pipeline as its processor.

interface LogsIndexArgs

interface LogsIndexArgs

The set of arguments for constructing a LogsIndex resource.

property exclusionFilters

exclusionFilters?: pulumi.Input<pulumi.Input<LogsIndexExclusionFilter>[]>;

List of exclusion filters.

property filters

filters: pulumi.Input<pulumi.Input<LogsIndexFilter>[]>;

property name

name: pulumi.Input<string>;

The name of the exclusion filter.

interface LogsIndexOrderArgs

interface LogsIndexOrderArgs

The set of arguments for constructing a LogsIndexOrder resource.

property indexes

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

The index resource list. Logs are tested against the query filter of each index one by one following the order of the list.

property name

name: pulumi.Input<string>;

The unique name of the index order resource.

interface LogsIndexOrderState

interface LogsIndexOrderState

Input properties used for looking up and filtering LogsIndexOrder resources.

property indexes

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

The index resource list. Logs are tested against the query filter of each index one by one following the order of the list.

property name

name?: pulumi.Input<string>;

The unique name of the index order resource.

interface LogsIndexState

interface LogsIndexState

Input properties used for looking up and filtering LogsIndex resources.

property exclusionFilters

exclusionFilters?: pulumi.Input<pulumi.Input<LogsIndexExclusionFilter>[]>;

List of exclusion filters.

property filters

filters?: pulumi.Input<pulumi.Input<LogsIndexFilter>[]>;

property name

name?: pulumi.Input<string>;

The name of the exclusion filter.

interface LogsIntegrationPipelineArgs

interface LogsIntegrationPipelineArgs

The set of arguments for constructing a LogsIntegrationPipeline resource.

property isEnabled

isEnabled?: pulumi.Input<boolean>;

Boolean value to enable your pipeline.

interface LogsIntegrationPipelineState

interface LogsIntegrationPipelineState

Input properties used for looking up and filtering LogsIntegrationPipeline resources.

property isEnabled

isEnabled?: pulumi.Input<boolean>;

Boolean value to enable your pipeline.

interface LogsPipelineOrderArgs

interface LogsPipelineOrderArgs

The set of arguments for constructing a LogsPipelineOrder resource.

property name

name: pulumi.Input<string>;

The name attribute in the resource datadog..LogsPipelineOrder needs to be unique. It’s recommended to use the same value as the resource NAME. No related field is available in Logs Pipeline API.

property pipelines

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

The pipeline IDs list. The order of pipeline IDs in this attribute defines the overall pipeline order for logs.

interface LogsPipelineOrderState

interface LogsPipelineOrderState

Input properties used for looking up and filtering LogsPipelineOrder resources.

property name

name?: pulumi.Input<string>;

The name attribute in the resource datadog..LogsPipelineOrder needs to be unique. It’s recommended to use the same value as the resource NAME. No related field is available in Logs Pipeline API.

property pipelines

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

The pipeline IDs list. The order of pipeline IDs in this attribute defines the overall pipeline order for logs.

interface MetricMetadataArgs

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

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

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>;

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 last5m 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 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.

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]: any}>;

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<MonitorThresholdWindows>;

A mapping containing recoveryWindow and triggerWindow values, e.g. last15m. Can only be used for, and are required for, anomaly monitors.

property thresholds

thresholds?: pulumi.Input<MonitorThresholds>;

• 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 criticalRecovery = 85 warning = 80 warningRecovery = 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. The available options are below. Note: The monitor type cannot be changed after a monitor is created. * metric alert * service check * event alert * query alert * composite * log alert

interface MonitorState

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>;

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 last5m 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 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.

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]: any}>;

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<MonitorThresholdWindows>;

A mapping containing recoveryWindow and triggerWindow values, e.g. last15m. Can only be used for, and are required for, anomaly monitors.

property thresholds

thresholds?: pulumi.Input<MonitorThresholds>;

• 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 criticalRecovery = 85 warning = 80 warningRecovery = 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. The available options are below. Note: The monitor type cannot be changed after a monitor is created. * metric alert * service check * event alert * query alert * composite * log alert

interface ProviderArgs

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

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<ScreenBoardTemplateVariable>[]>;

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<ScreenBoardWidget>[]>;

A list of widget definitions.

property width

width?: pulumi.Input<string>;

Width of the screenboard

interface ScreenBoardState

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<ScreenBoardTemplateVariable>[]>;

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<ScreenBoardWidget>[]>;

A list of widget definitions.

property width

width?: pulumi.Input<string>;

Width of the screenboard

interface ServiceLevelObjectiveArgs

interface ServiceLevelObjectiveArgs

The set of arguments for constructing a ServiceLevelObjective resource.

property description

description?: pulumi.Input<string>;

A description of this service level objective.

property groups

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

A custom set of groups from the monitor(s) for which to use as the SLI instead of all the groups.

property monitorIds

monitorIds?: pulumi.Input<pulumi.Input<number>[]>;

A list of numeric monitor IDs for which to use as SLIs. Their tags will be auto-imported into monitorTags field in the API resource.

property name

name: pulumi.Input<string>;

Name of Datadog service level objective

property query

query?: pulumi.Input<ServiceLevelObjectiveQuery>;

The metric query configuration to use for the SLI. This is a dictionary and requires both the numerator and denominator fields which should be count metrics using the sum aggregator.

property tags

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

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

property thresholds

thresholds: pulumi.Input<pulumi.Input<ServiceLevelObjectiveThreshold>[]>;

• A list of thresholds and targets that define the service level objectives from the provided SLIs.

property type

type: pulumi.Input<string>;

The type of the service level objective. 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 * monitor

interface ServiceLevelObjectiveState

interface ServiceLevelObjectiveState

Input properties used for looking up and filtering ServiceLevelObjective resources.

property description

description?: pulumi.Input<string>;

A description of this service level objective.

property groups

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

A custom set of groups from the monitor(s) for which to use as the SLI instead of all the groups.

property monitorIds

monitorIds?: pulumi.Input<pulumi.Input<number>[]>;

A list of numeric monitor IDs for which to use as SLIs. Their tags will be auto-imported into monitorTags field in the API resource.

property name

name?: pulumi.Input<string>;

Name of Datadog service level objective

property query

query?: pulumi.Input<ServiceLevelObjectiveQuery>;

The metric query configuration to use for the SLI. This is a dictionary and requires both the numerator and denominator fields which should be count metrics using the sum aggregator.

property tags

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

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

property thresholds

thresholds?: pulumi.Input<pulumi.Input<ServiceLevelObjectiveThreshold>[]>;

• A list of thresholds and targets that define the service level objectives from the provided SLIs.

property type

type?: pulumi.Input<string>;

The type of the service level objective. 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 * monitor

interface SyntheticsTestArgs

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

name: pulumi.Input<string>;

property options

options?: pulumi.Input<SyntheticsTestOptions>;

property request

request: pulumi.Input<SyntheticsTestRequest>;

property requestHeaders

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

property status

status: pulumi.Input<string>;

property subtype

subtype?: pulumi.Input<string>;

property tags

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

property type

type: pulumi.Input<string>;

interface SyntheticsTestState

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<SyntheticsTestOptions>;

property request

request?: pulumi.Input<SyntheticsTestRequest>;

property requestHeaders

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

property status

status?: pulumi.Input<string>;

property subtype

subtype?: pulumi.Input<string>;

property tags

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

property type

type?: pulumi.Input<string>;

interface TimeBoardArgs

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<TimeBoardGraph>[]>;

A list of graph definitions.

property readOnly

readOnly?: pulumi.Input<boolean>;

property templateVariables

templateVariables?: pulumi.Input<pulumi.Input<TimeBoardTemplateVariable>[]>;

A list of template variables for using Dashboard templating.

property title

title: pulumi.Input<string>;

The name of the dashboard.

interface TimeBoardState

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<TimeBoardGraph>[]>;

A list of graph definitions.

property readOnly

readOnly?: pulumi.Input<boolean>;

property templateVariables

templateVariables?: pulumi.Input<pulumi.Input<TimeBoardTemplateVariable>[]>;

A list of template variables for using Dashboard templating.

property title

title?: pulumi.Input<string>;

The name of the dashboard.

interface UserArgs

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

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