Classes
| Name | Description |
|---|---|
| DatadogDashboard | Datadog Dashboard 1.0.0. |
| DatadogDowntime | Datadog Monitor Downtime 2.0.0. |
| DatadogIAMUser | Datadog Application User 1.2.0. |
| DatadogIntegrationAWS | Datadog Integration 1.1.0. |
| DatadogMonitor | Datadog Monitor 3.0.0. |
Structs
| Name | Description |
|---|---|
| DatadogCredentials | Credentials for the Datadog API. |
| DatadogDashboardProps | No description |
| DatadogDowntimeProps | No description |
| DatadogIAMUserProps | No description |
| DatadogIntegrationAWSProps | No description |
| DatadogMonitorProps | No description |
| MonitorOptions | No description |
| MonitorThresholdWindows | No description |
| MonitorThresholds | No description |
Enums
| Name | Description |
|---|---|
| MonitorType | The type of the monitor. |
Datadog Dashboard 1.0.0.
new DatadogDashboard(scope: Construct, id: string, props: DatadogDashboardProps)- scope (
Construct) No description - id (
string) No description - props (
DatadogDashboardProps) No description- dashboardDefinition (
string) JSON string of the dashboard definition. - datadogCredentials (
DatadogCredentials) Credentials for the Datadog API.
- dashboardDefinition (
Datadog Monitor Downtime 2.0.0.
new DatadogDowntime(scope: Construct, id: string, props: DatadogDowntimeProps)- scope (
Construct) No description - id (
string) No description - props (
DatadogDowntimeProps) No description- datadogCredentials (
DatadogCredentials) Credentials for the Datadog API. - scope (
Array) The scope(s) to which the downtime applies. - active (
boolean) Whether or not this downtime is currently active. Optional - canceled (
number) POSIX Timestamp of cancellation of this downtime (null if not canceled). Optional - creatorId (
number) Id of the user who created this downtime. Optional - disabled (
boolean) Whether or not this downtime is disabled. Optional - downtimeType (
number) Type of this downtime. Optional - end (
number) POSIX timestamp to end the downtime. Optional - id (
number) Id of this downtime. Optional - message (
string) Message on the downtime. Optional - monitorId (
number) A single monitor to which the downtime applies. Optional - monitorTags (
Array) A comma-separated list of monitor tags, to which the downtime applies. Optional - parentId (
number) The ID of the parent downtime to this one. Optional - start (
number) POSIX timestamp to start the downtime. Optional - timezone (
string) The timezone for the downtime. Optional - updaterId (
number) Id of the user who updated this downtime. Optional
- datadogCredentials (
Datadog Application User 1.2.0.
new DatadogIAMUser(scope: Construct, id: string, props: DatadogIAMUserProps)- scope (
Construct) No description - id (
string) No description - props (
DatadogIAMUserProps) No description- datadogCredentials (
DatadogCredentials) Credentials for the Datadog API. - accessRole (
string) The role of the user. Optional - disabled (
boolean) Whether or not the user is disabled. Optional - email (
string) User email. Optional - handle (
string) User handle (a valid email). Optional - name (
string) User name. Optional - verified (
boolean) Whether or not the user is verified. Optional
- datadogCredentials (
Datadog Integration 1.1.0.
new DatadogIntegrationAWS(scope: Construct, id: string, props: DatadogIntegrationAWSProps)- scope (
Construct) No description - id (
string) No description - props (
DatadogIntegrationAWSProps) No description- accountId (
string) The id of the account with which to integrate. - datadogCredentials (
DatadogCredentials) Credentials for the Datadog API. - roleName (
string) The name of the created role.
- accountId (
Datadog Monitor 3.0.0.
new DatadogMonitor(scope: Construct, id: string, props: DatadogMonitorProps)- scope (
Construct) No description - id (
string) No description - props (
DatadogMonitorProps) No description- datadogCredentials (
DatadogCredentials) Credentials for the Datadog API. - query (
string) The monitor query. - type (
MonitorType) The type of the monitor. - message (
string) A message to include with notifications for the monitor. Optional - multi (
boolean) Whether or not the monitor is multi alert. Optional - name (
string) Name of the monitor. Optional - options (
MonitorOptions) The monitor options. Optional - tags (
Array) Tags associated with the monitor. Optional
- datadogCredentials (
Credentials for the Datadog API.
| Name | Type | Description |
|---|---|---|
| apiKey | string |
Datadog API key. |
| applicationKey | string |
Datadog application key. |
| apiURL? | string |
Datadog API URL (defaults to https://api.datadoghq.com) Use https://api.datadoghq.eu for EU accounts. Optional |
| Name | Type | Description |
|---|---|---|
| dashboardDefinition | string |
JSON string of the dashboard definition. |
| datadogCredentials | DatadogCredentials |
Credentials for the Datadog API. |
| Name | Type | Description |
|---|---|---|
| datadogCredentials | DatadogCredentials |
Credentials for the Datadog API. |
| scope | Array |
The scope(s) to which the downtime applies. |
| active? | boolean |
Whether or not this downtime is currently active. Optional |
| canceled? | number |
POSIX Timestamp of cancellation of this downtime (null if not canceled). Optional |
| creatorId? | number |
Id of the user who created this downtime. Optional |
| disabled? | boolean |
Whether or not this downtime is disabled. Optional |
| downtimeType? | number |
Type of this downtime. Optional |
| end? | number |
POSIX timestamp to end the downtime. Optional |
| id? | number |
Id of this downtime. Optional |
| message? | string |
Message on the downtime. Optional |
| monitorId? | number |
A single monitor to which the downtime applies. Optional |
| monitorTags? | Array |
A comma-separated list of monitor tags, to which the downtime applies. Optional |
| parentId? | number |
The ID of the parent downtime to this one. Optional |
| start? | number |
POSIX timestamp to start the downtime. Optional |
| timezone? | string |
The timezone for the downtime. Optional |
| updaterId? | number |
Id of the user who updated this downtime. Optional |
| Name | Type | Description |
|---|---|---|
| datadogCredentials | DatadogCredentials |
Credentials for the Datadog API. |
| accessRole? | string |
The role of the user. Optional |
| disabled? | boolean |
Whether or not the user is disabled. Optional |
| email? | string |
User email. Optional |
| handle? | string |
User handle (a valid email). Optional |
| name? | string |
User name. Optional |
| verified? | boolean |
Whether or not the user is verified. Optional |
| Name | Type | Description |
|---|---|---|
| accountId | string |
The id of the account with which to integrate. |
| datadogCredentials | DatadogCredentials |
Credentials for the Datadog API. |
| roleName | string |
The name of the created role. |
| Name | Type | Description |
|---|---|---|
| datadogCredentials | DatadogCredentials |
Credentials for the Datadog API. |
| query | string |
The monitor query. |
| type | MonitorType |
The type of the monitor. |
| message? | string |
A message to include with notifications for the monitor. Optional |
| multi? | boolean |
Whether or not the monitor is multi alert. Optional |
| name? | string |
Name of the monitor. Optional |
| options? | MonitorOptions |
The monitor options. Optional |
| tags? | Array |
Tags associated with the monitor. Optional |
| Name | Type | Description |
|---|---|---|
| enableLogsSample? | boolean |
Whether or not to include a sample of the logs. Optional |
| escalationMessage? | string |
Message to include with a re-notification when renotify_interval is set. Optional |
| evaluationDelay? | number |
Time in seconds to delay evaluation. Optional |
| includeTags? | boolean |
Whether or not to include triggering tags into notification title. Optional |
| locked? | boolean |
Whether or not changes to this monitor should be restricted to the creator or admins. Optional |
| minLocationFailed? | number |
Number of locations allowed to fail before triggering alert. Optional |
| newHostDelay? | number |
Time in seconds to allow a host to start reporting data before starting the evaluation of monitor results. Optional |
| noDataTimeframe? | number |
Number of minutes data stopped reporting before notifying. Optional |
| notifyAudit? | boolean |
Whether or not to notify tagged users when changes are made to the monitor. Optional |
| notifyNoData? | boolean |
Whether or not to notify when data stops reporting. Optional |
| renotifyInterval? | number |
Number of minutes after the last notification before the monitor re-notifies on the current status. Optional |
| requireFullWindow? | boolean |
Whether or not the monitor requires a full window of data before it is evaluated. Optional |
| syntheticsCheckID? | number |
ID of the corresponding synthetics check. Optional |
| thresholdWindows? | MonitorThresholdWindows |
The threshold window definitions. Optional |
| thresholds? | MonitorThresholds |
The threshold definitions. Optional |
| timeoutH? | number |
Number of hours of the monitor not reporting data before it automatically resolves. Optional |
| Name | Type | Description |
|---|---|---|
| recoveryWindow? | string |
How long an anomalous metric must be normal before recovering from an alert state. Optional |
| triggerWindow? | string |
How long a metric must be anomalous before triggering an alert. Optional |
| Name | Type | Description |
|---|---|---|
| critical? | number |
Threshold value for triggering an alert. Optional |
| criticalRecovery? | number |
Threshold value for recovering from an alert state. Optional |
| oK? | number |
Threshold value for recovering from an alert state. Optional |
| warning? | number |
Threshold value for triggering a warning. Optional |
| warningRecovery? | number |
Threshold value for recovering from a warning state. Optional |
The type of the monitor.
| Name | Description |
|---|---|
| COMPOSITE | |
| EVENT_ALERT | |
| LOG_ALERT | |
| METRIC_ALERT | |
| PROCESS_ALERT | |
| QUERY_ALERT | |
| SERVICE_CHECK | |
| SYNTHETICS_ALERT | |
| TRACE_ANALYTICS_ALERT |