scanning_groups

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

Overview

Name	scanning_groups
Type	Resource
Id	datadog.security.scanning_groups

Fields

The following fields are returned by SELECT queries:

list_scanning_groups

Name	Datatype	Description
id	string	ID of the configuration.
attributes	object	Attributes of the Sensitive Data configuration.
relationships	object	Relationships of the configuration.
type	string	Sensitive Data Scanner configuration type. (sensitive_data_scanner_configuration) (default: sensitive_data_scanner_configuration, example: sensitive_data_scanner_configuration)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_scanning_groups	select			List all the Scanning groups in your organization.
create_scanning_group	insert			Create a scanning group.<br />The request MAY include a configuration relationship.<br />A rules relationship can be omitted entirely, but if it is included it MUST be<br />null or an empty array (rules cannot be created at the same time).<br />The new group will be ordered last within the configuration.
update_scanning_group	update	group_id, data, meta		Update a group, including the order of the rules.<br />Rules within the group are reordered by including a rules relationship. If the rules<br />relationship is present, its data section MUST contain linkages for all of the rules<br />currently in the group, and MUST NOT contain any others.
delete_scanning_group	delete	group_id		Delete a given group.
reorder_scanning_groups	exec	data, meta		Reorder the list of groups.

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
group_id	string	The ID of a group of rules.
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

list_scanning_groups

List all the Scanning groups in your organization.

SELECT
id,
attributes,
relationships,
type
FROM datadog.security.scanning_groups
;

INSERT examples

create_scanning_group

Create a scanning group.<br />The request MAY include a configuration relationship.<br />A rules relationship can be omitted entirely, but if it is included it MUST be<br />null or an empty array (rules cannot be created at the same time).<br />The new group will be ordered last within the configuration.

INSERT INTO datadog.security.scanning_groups (
data,
meta
)
SELECT 
'{{ data }}',
'{{ meta }}'
RETURNING
data,
meta
;

Manifest

# Description fields are for documentation purposes
- name: scanning_groups
props:
  - name: data
    description: |
      Data related to the creation of a group.
    value:
      attributes:
        description: "{{ description }}"
        filter:
          query: "{{ query }}"
        is_enabled: {{ is_enabled }}
        name: "{{ name }}"
        product_list:
          - "{{ product_list }}"
        samplings:
          - product: "{{ product }}"
            rate: {{ rate }}
      relationships:
        configuration:
          data:
            id: "{{ id }}"
            type: "{{ type }}"
        rules:
          data:
            - id: "{{ id }}"
              type: "{{ type }}"
      type: "{{ type }}"
  - name: meta
    description: |
      Meta payload containing information about the API.
    value:
      version: {{ version }}

UPDATE examples

update_scanning_group

Update a group, including the order of the rules.<br />Rules within the group are reordered by including a rules relationship. If the rules<br />relationship is present, its data section MUST contain linkages for all of the rules<br />currently in the group, and MUST NOT contain any others.

UPDATE datadog.security.scanning_groups
SET 
data = '{{ data }}',
meta = '{{ meta }}'
WHERE 
group_id = '{{ group_id }}' --required
AND data = '{{ data }}' --required
AND meta = '{{ meta }}' --required
RETURNING
meta;

DELETE examples

delete_scanning_group

Delete a given group.

DELETE FROM datadog.security.scanning_groups
WHERE group_id = '{{ group_id }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

reorder_scanning_groups

Reorder the list of groups.

EXEC datadog.security.scanning_groups.reorder_scanning_groups 
@@json=
'{
"data": "{{ data }}", 
"meta": "{{ meta }}"
}'
;