static_analysis_ai_ruleset_rules

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

Overview

Name	static_analysis_ai_ruleset_rules
Type	Resource
Id	datadog.security.static_analysis_ai_ruleset_rules

Fields

The following fields are returned by SELECT queries:

get_ai_custom_rule

Name	Datatype	Description
id	string	The rule identifier. (example: my-ai-rule)
attributes	object	An AI custom rule embedded within a ruleset response.
type	string	AI custom rule resource type. (ai_rule) (example: ai_rule)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ai_custom_rule	select	ruleset_name, rule_name		Get an AI custom rule by name within a ruleset.
create_ai_custom_rule	insert	ruleset_name		Create a new AI custom rule within a ruleset.
delete_ai_custom_rule	delete	ruleset_name, rule_name		Delete an AI custom rule by name within a ruleset.

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_name	string	The rule name.
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.

SELECT examples

get_ai_custom_rule

Get an AI custom rule by name within a ruleset.

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

INSERT examples

create_ai_custom_rule

Create a new AI custom rule within a ruleset.

INSERT INTO datadog.security.static_analysis_ai_ruleset_rules (
data,
ruleset_name
)
SELECT 
'{{ data }}',
'{{ ruleset_name }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: static_analysis_ai_ruleset_rules
props:
  - name: ruleset_name
    value: "{{ ruleset_name }}"
    description: Required parameter for the static_analysis_ai_ruleset_rules resource.
  - name: data
    description: |
      Request data for creating an AI custom rule.
    value:
      attributes:
        name: "{{ name }}"
      id: "{{ id }}"
      type: "{{ type }}"

DELETE examples

delete_ai_custom_rule

Delete an AI custom rule by name within a ruleset.

DELETE FROM datadog.security.static_analysis_ai_ruleset_rules
WHERE ruleset_name = '{{ ruleset_name }}' --required
AND rule_name = '{{ rule_name }}' --required
;