static_analysis_ai_rulesets

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

Overview

Name	static_analysis_ai_rulesets
Type	Resource
Id	datadog.security.static_analysis_ai_rulesets

Fields

The following fields are returned by SELECT queries:

get_ai_custom_ruleset

Name	Datatype	Description
id	string	The ruleset identifier. (example: my-ai-ruleset)
attributes	object	Response attributes of an AI custom ruleset.
type	string	AI custom ruleset resource type. (ai_ruleset) (example: ai_ruleset)

list_ai_custom_rulesets

Name	Datatype	Description
id	string	The ruleset identifier. (example: my-ai-ruleset)
attributes	object	Response attributes of an AI custom ruleset.
type	string	AI custom ruleset resource type. (ai_ruleset) (example: ai_ruleset)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ai_custom_ruleset	select	ruleset_name		Get an AI custom ruleset by name.
list_ai_custom_rulesets	select		page[offset], page[limit]	Get all AI custom rulesets for the authenticated organization.
create_ai_custom_ruleset	insert			Create a new AI custom ruleset for the authenticated organization.
update_ai_custom_ruleset	update	ruleset_name		Update the description of an existing AI custom ruleset.
delete_ai_custom_ruleset	delete	ruleset_name		Delete an AI custom ruleset by name.

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
ruleset_name	string	The ruleset name.
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[limit]	integer (int64)	The maximum number of rulesets to return.
page[offset]	integer (int64)	The offset for pagination.

SELECT examples

get_ai_custom_ruleset

Get an AI custom ruleset by name.

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

list_ai_custom_rulesets

Get all AI custom rulesets for the authenticated organization.

SELECT
id,
attributes,
type
FROM datadog.security.static_analysis_ai_rulesets
WHERE page[offset] = '{{ page[offset] }}'
AND page[limit] = '{{ page[limit] }}'
;

INSERT examples

create_ai_custom_ruleset

Create a new AI custom ruleset for the authenticated organization.

INSERT INTO datadog.security.static_analysis_ai_rulesets (
data
)
SELECT 
'{{ data }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: static_analysis_ai_rulesets
props:
  - name: data
    description: |
      Request data for creating an AI custom ruleset.
    value:
      attributes:
        description: "{{ description }}"
        name: "{{ name }}"
        short_description: "{{ short_description }}"
      id: "{{ id }}"
      type: "{{ type }}"

UPDATE examples

update_ai_custom_ruleset

Update the description of an existing AI custom ruleset.

UPDATE datadog.security.static_analysis_ai_rulesets
SET 
data = '{{ data }}'
WHERE 
ruleset_name = '{{ ruleset_name }}' --required;

DELETE examples

delete_ai_custom_ruleset

Delete an AI custom ruleset by name.

DELETE FROM datadog.security.static_analysis_ai_rulesets
WHERE ruleset_name = '{{ ruleset_name }}' --required
;