Class: Ansible::Ruby::Modules::Datadog_monitor

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#api_key ⇒ Object

Returns Your DataDog API key.

Returns:

  • (Object) —

    Your DataDog API key.



10
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 10

attribute :api_key

#app_key ⇒ Object

Returns Your DataDog app key.

Returns:

  • (Object) —

    Your DataDog app key.



14
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 14

attribute :app_key

#escalation_message ⇒ Object?

Returns A message to include with a re-notification. Supports the ‘@username’ notification we allow elsewhere. Not applicable if renotify_interval is None.

Returns:

  • (Object, nil) —

    A message to include with a re-notification. Supports the ‘@username’ notification we allow elsewhere. Not applicable if renotify_interval is None



54
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 54

attribute :escalation_message

#message ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



33
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 33

attribute :message

#name ⇒ Object

Returns The name of the alert.

Returns:

  • (Object) —

    The name of the alert.



29
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 29

attribute :name

#no_data_timeframe ⇒ Integer?

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

Returns:

  • (Integer, nil) —

    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.



44
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 44

attribute :no_data_timeframe

#notify_audit ⇒ Boolean?

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

Returns:

  • (Boolean, nil) —

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



57
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 57

attribute :notify_audit

#notify_no_data ⇒ Boolean?

Returns A boolean indicating whether this monitor will notify when data stops reporting..

Returns:

  • (Boolean, nil) —

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



40
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 40

attribute :notify_no_data

#query ⇒ Object?

Returns The monitor query to notify on with syntax varying depending on what type of monitor you are creating.

Returns:

  • (Object, nil) —

    The monitor query to notify on with syntax varying depending on what type of monitor you are creating.



26
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 26

attribute :query

#renotify_interval ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



51
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 51

attribute :renotify_interval

#silenced ⇒ String?

Returns Dictionary of scopes to timestamps or None. Each scope will be muted until the given POSIX timestamp or forever if the value is None.

Returns:

  • (String, nil) —

    Dictionary of scopes to timestamps or None. Each scope will be muted until the given POSIX timestamp or forever if the value is None.



36
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 36

attribute :silenced

#state ⇒ :present, ...

Returns The designated state of the monitor.

Returns:

  • (:present, :absent, :muted, :unmuted) —

    The designated state of the monitor.



18
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 18

attribute :state

#thresholds ⇒ Array<String>, ...

Returns A dictionary of thresholds by status. This option is only available for service checks and metric alerts. Because each of them can have multiple thresholds, we don’t define them directly in the query.

Returns:

  • (Array<String>, String, nil) —

    A dictionary of thresholds by status. This option is only available for service checks and metric alerts. Because each of them can have multiple thresholds, we don’t define them directly in the query.



61
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 61

attribute :thresholds

#timeout_h ⇒ Object?

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

Returns:

  • (Object, nil) —

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



48
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 48

attribute :timeout_h

#type ⇒ :"metric alert", ...

Returns The type of the monitor.,The ‘event alert’is available starting at Ansible 2.1.

Returns:

  • (:"metric alert", :"service check", :"event alert", nil) —

    The type of the monitor.,The ‘event alert’is available starting at Ansible 2.1



22
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 22

attribute :type