monitoring_alert_policy
Generated on 18 Jun 2025
from digitalocean.cloud
version
v1.2.1
Synopsis
Create or delete monitoring alert policy. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Monitoring.
Requirements
- pydo >= 0.1.3
- azure-core >= 1.26.1
Parameters
Parameter | Choices / Default | Description |
---|---|---|
alerts dict / required |
Alert object. | |
client_override_options dict |
Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options. | |
compare str / required |
Choices:
|
Comparision. |
description str / required |
Description. | |
enabled bool / required |
Enabled. | |
entities list / elements=str / required |
Entities. | |
module_override_options dict |
Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options. | |
state str |
Choices:
|
State of the resource, present to create, absent to destroy. |
tags list / elements=str / required |
Tags. | |
timeout int |
Default: 300 |
Polling timeout in seconds. |
token str |
DigitalOcean API token. There are several environment variables which can be used to provide this value. DIGITALOCEAN_ACCESS_TOKEN , DIGITALOCEAN_TOKEN , DO_API_TOKEN , DO_API_KEY , DO_OAUTH_TOKEN and OAUTH_TOKEN |
|
type str / required |
Choices:
|
Type. |
value float / required |
Value. | |
window str / required |
Choices:
|
Window. |
Examples
- name: Create monitoring alert policy
digitalocean.cloud.monitoring_alert_policy:
token: "{{ token }}"
state: present
alerts:
email:
- [email protected]
slack:
- channel: Production Alerts
url: https://hooks.slack.com/services/T1234567/AAAAAAAA/ZZZZZZ
compare: GreaterThan
description: CPU Alert
enabled: true
entities:
- 192018292
tags:
- droplet_tag
type: v1/insights/droplet/cpu
value: 80
window: 5m
Return Values
Key | Returned | Description |
---|---|---|
alerts dict |
always | Monitoring alert policy information. Sample:
|
error dict |
failure | DigitalOcean API error. Sample:
|
msg str |
always | Monitoring alert policy result information. Sample:
|