org_group_policy_overrides

Creates, updates, deletes, gets or lists an org_group_policy_overrides resource.

Overview

Name	org_group_policy_overrides
Type	Resource
Id	datadog.organization.org_group_policy_overrides

Fields

The following fields are returned by SELECT queries:

get_org_group_policy_override

Name	Datatype	Description
id	string (uuid)	The ID of the policy override. (example: 9f8e7d6c-5b4a-3210-fedc-ba0987654321)
attributes	object	Attributes of an org group policy override.
relationships	object	Relationships of an org group policy override.
type	string	Org group policy overrides resource type. (org_group_policy_overrides) (example: org_group_policy_overrides)

list_org_group_policy_overrides

Name	Datatype	Description
id	string (uuid)	The ID of the policy override. (example: 9f8e7d6c-5b4a-3210-fedc-ba0987654321)
attributes	object	Attributes of an org group policy override.
relationships	object	Relationships of an org group policy override.
type	string	Org group policy overrides resource type. (org_group_policy_overrides) (example: org_group_policy_overrides)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_org_group_policy_override	select	org_group_policy_override_id		Get a specific organization group policy override by its ID.
list_org_group_policy_overrides	select	filter[org_group_id]	filter[policy_id], page[number], page[size], sort	List policy overrides for an organization group. Requires a filter on org group ID. Optionally filter by policy ID.
create_org_group_policy_override	insert	data		Create a new policy override for an organization within an org group.
update_org_group_policy_override	update	org_group_policy_override_id, data		Update an existing organization group policy override.
delete_org_group_policy_override	delete	org_group_policy_override_id		Delete an organization group policy override by its ID.

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
filter[org_group_id]	string (uuid)	Filter policy overrides by org group ID.
org_group_policy_override_id	string (uuid)	The ID of the org group policy override.
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.
filter[policy_id]	string (uuid)	Filter policy overrides by policy ID.
page[number]	integer (int64)	The page number to return.
page[size]	integer (int64)	The number of items per page. Maximum is 1000.
sort	string	Field to sort overrides by. Supported values: id, org_uuid, -id, -org_uuid. Defaults to id.

SELECT examples

get_org_group_policy_override

Get a specific organization group policy override by its ID.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.org_group_policy_overrides
WHERE org_group_policy_override_id = '{{ org_group_policy_override_id }}' -- required
;

list_org_group_policy_overrides

List policy overrides for an organization group. Requires a filter on org group ID. Optionally filter by policy ID.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.org_group_policy_overrides
WHERE filter[org_group_id] = '{{ filter[org_group_id] }}' -- required
AND filter[policy_id] = '{{ filter[policy_id] }}'
AND page[number] = '{{ page[number] }}'
AND page[size] = '{{ page[size] }}'
AND sort = '{{ sort }}'
;

INSERT examples

create_org_group_policy_override

Create a new policy override for an organization within an org group.

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

Manifest

# Description fields are for documentation purposes
- name: org_group_policy_overrides
props:
  - name: data
    description: |
      Data for creating an org group policy override.
    value:
      attributes:
        org_site: "{{ org_site }}"
        org_uuid: "{{ org_uuid }}"
      relationships:
        org_group:
          data:
            id: "{{ id }}"
            type: "{{ type }}"
        org_group_policy:
          data:
            id: "{{ id }}"
            type: "{{ type }}"
      type: "{{ type }}"

UPDATE examples

update_org_group_policy_override

Update an existing organization group policy override.

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

DELETE examples

delete_org_group_policy_override

Delete an organization group policy override by its ID.

DELETE FROM datadog.organization.org_group_policy_overrides
WHERE org_group_policy_override_id = '{{ org_group_policy_override_id }}' --required
;