vulnerability_notification_rules

Creates, updates, deletes, gets or lists a vulnerability_notification_rules resource.

Overview

Name	vulnerability_notification_rules
Type	Resource
Id	datadog.security.vulnerability_notification_rules

Fields

The following fields are returned by SELECT queries:

get_vulnerability_notification_rule

Notification rule details.

Name	Datatype	Description
id	string	The ID of a notification rule. (example: aaa-bbb-ccc)
attributes	object	Attributes of the notification rule.
type	string	The rule type associated to notification rules. (example: notification_rules)

get_vulnerability_notification_rules

The list of notification rules.

Name	Datatype	Description
id	string	The ID of a notification rule. (example: aaa-bbb-ccc)
attributes	object	Attributes of the notification rule.
type	string	The rule type associated to notification rules. (example: notification_rules)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vulnerability_notification_rule	select	id, region		Get the details of a notification rule for security vulnerabilities.
get_vulnerability_notification_rules	select	region		Returns the list of notification rules for security vulnerabilities.
create_vulnerability_notification_rule	insert	region		Create a new notification rule for security vulnerabilities and return the created rule.
patch_vulnerability_notification_rule	update	id, region		Partially update the notification rule. All fields are optional; if a field is not provided, it is not updated.
delete_vulnerability_notification_rule	delete	id, region		Delete a notification rule for security vulnerabilities.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	ID of the notification rule.
region	string	(default: datadoghq.com)

SELECT examples

get_vulnerability_notification_rule

Get the details of a notification rule for security vulnerabilities.

SELECT
id,
attributes,
type
FROM datadog.security.vulnerability_notification_rules
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

get_vulnerability_notification_rules

Returns the list of notification rules for security vulnerabilities.

SELECT
id,
attributes,
type
FROM datadog.security.vulnerability_notification_rules
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_vulnerability_notification_rule

Create a new notification rule for security vulnerabilities and return the created rule.

INSERT INTO datadog.security.vulnerability_notification_rules (
data__data,
region
)
SELECT 
'{{ data }}',
'{{ region }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: vulnerability_notification_rules
  props:
    - name: region
      value: string
      description: Required parameter for the vulnerability_notification_rules resource.
    - name: data
      value: object
      description: |
        Data of the notification rule create request: the rule type, and the rule attributes. All fields are required.

UPDATE examples

patch_vulnerability_notification_rule

Partially update the notification rule. All fields are optional; if a field is not provided, it is not updated.

UPDATE datadog.security.vulnerability_notification_rules
SET 
data__data = '{{ data }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
RETURNING
data;

DELETE examples

delete_vulnerability_notification_rule

Delete a notification rule for security vulnerabilities.

DELETE FROM datadog.security.vulnerability_notification_rules
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;