governance_controls

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

Overview

Name	governance_controls
Type	Resource
Id	datadog.organization.governance_controls

Fields

The following fields are returned by SELECT queries:

get_governance_control

Name	Datatype	Description
id	string	The detection type that uniquely identifies the control. (example: unused_api_keys)
attributes	object	The attributes of a governance control.
type	string	JSON:API resource type for a governance control. (governance_control) (example: governance_control)

list_governance_controls

Name	Datatype	Description
id	string	The detection type that uniquely identifies the control. (example: unused_api_keys)
attributes	object	The attributes of a governance control.
type	string	JSON:API resource type for a governance control. (governance_control) (example: governance_control)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_governance_control	select	detection_type		Retrieve a single governance control by its detection type, including the organization's current<br />detection, notification, and mitigation configuration and detection counts.
list_governance_controls	select			Retrieve the list of governance controls configured for the organization. Each control pairs a<br />detection definition with the organization's current detection, notification, and mitigation<br />configuration, along with counts of active and mitigated detections.
update_governance_control	update	detection_type, data		Update the detection, notification, and mitigation configuration of a governance control. Only<br />the attributes present in the request are modified. Changing the mitigation type or its<br />parameters may require additional permissions.

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
detection_type	string	The detection type that identifies the control, for example unused_api_keys. (example: unused_api_keys)
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.

SELECT examples

get_governance_control

Retrieve a single governance control by its detection type, including the organization's current<br />detection, notification, and mitigation configuration and detection counts.

SELECT
id,
attributes,
type
FROM datadog.organization.governance_controls
WHERE detection_type = '{{ detection_type }}' -- required
;

list_governance_controls

Retrieve the list of governance controls configured for the organization. Each control pairs a<br />detection definition with the organization's current detection, notification, and mitigation<br />configuration, along with counts of active and mitigated detections.

SELECT
id,
attributes,
type
FROM datadog.organization.governance_controls
;

UPDATE examples

update_governance_control

Update the detection, notification, and mitigation configuration of a governance control. Only<br />the attributes present in the request are modified. Changing the mitigation type or its<br />parameters may require additional permissions.

UPDATE datadog.organization.governance_controls
SET 
data = '{{ data }}'
WHERE 
detection_type = '{{ detection_type }}' --required
AND data = '{{ data }}' --required
RETURNING
data;