finding_automation_due_date_rules

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

Overview

Name	finding_automation_due_date_rules
Type	Resource
Id	datadog.security.finding_automation_due_date_rules

Fields

The following fields are returned by SELECT queries:

get_security_findings_automation_due_date_rule

Successfully retrieved the due date rule

Name	Datatype	Description
id	string (uuid)	The ID of the due date rule. (example: 00000000-0000-0000-0000-000000000000)
attributes	object	Attributes of a due date rule returned by the API.
type	string	The JSON:API type for due date rules. (due_date_rules) (example: due_date_rules)

list_security_findings_automation_due_date_rules

Successfully retrieved the list of due date rules

Name	Datatype	Description
id	string (uuid)	The ID of the due date rule. (example: 00000000-0000-0000-0000-000000000000)
attributes	object	Attributes of a due date rule returned by the API.
type	string	The JSON:API type for due date rules. (due_date_rules) (example: due_date_rules)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_security_findings_automation_due_date_rule	select	rule_id		Get the details of a due date rule by ID.
list_security_findings_automation_due_date_rules	select		page[size], page[number]	Get all due date rules for the current organization.
create_security_findings_automation_due_date_rule	insert	data		Create a new due date rule for the current organization.
update_security_findings_automation_due_date_rule	replace	rule_id, data		Update an existing due date rule by ID.
delete_security_findings_automation_due_date_rule	delete	rule_id		Delete an existing due date rule by ID.
reorder_security_findings_automation_due_date_rules	exec	data		Reorder the list of due date rules for the current organization.

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
rule_id	string (uuid)	The ID of the due date rule.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
page[number]	integer (int64)	The page number to return.
page[size]	integer (int64)	The number of rules per page. Maximum is 1000.

SELECT examples

get_security_findings_automation_due_date_rule

Get the details of a due date rule by ID.

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

list_security_findings_automation_due_date_rules

Get all due date rules for the current organization.

SELECT
id,
attributes,
type
FROM datadog.security.finding_automation_due_date_rules
WHERE page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
;

INSERT examples

create_security_findings_automation_due_date_rule

Create a new due date rule for the current organization.

INSERT INTO datadog.security.finding_automation_due_date_rules (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: finding_automation_due_date_rules
props:
  - name: data
    description: |
      The data object for a due date rule create or update request.
    value:
      attributes:
        action:
          due_days_per_severity:
            - due_in_days: {{ due_in_days }}
              severity: "{{ severity }}"
          due_from: "{{ due_from }}"
          reason_description: "{{ reason_description }}"
        enabled: {{ enabled }}
        name: "{{ name }}"
        rule:
          finding_types:
            - "{{ finding_types }}"
          query: "{{ query }}"
      type: "{{ type }}"

REPLACE examples

update_security_findings_automation_due_date_rule

Update an existing due date rule by ID.

REPLACE datadog.security.finding_automation_due_date_rules
SET 
data = '{{ data }}'
WHERE 
rule_id = '{{ rule_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_security_findings_automation_due_date_rule

Delete an existing due date rule by ID.

DELETE FROM datadog.security.finding_automation_due_date_rules
WHERE rule_id = '{{ rule_id }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

reorder_security_findings_automation_due_date_rules

Reorder the list of due date rules for the current organization.

EXEC datadog.security.finding_automation_due_date_rules.reorder_security_findings_automation_due_date_rules 
@@json=
'{
"data": "{{ data }}"
}'
;