static_analysis_ai_ruleset_rule_revisions

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

Overview

Name	static_analysis_ai_ruleset_rule_revisions
Type	Resource
Id	datadog.security.static_analysis_ai_ruleset_rule_revisions

Fields

The following fields are returned by SELECT queries:

get_ai_custom_rule_revision

Name	Datatype	Description
id	string	The revision identifier. (example: revision-abc-123)
attributes	object	Response attributes of an AI custom rule revision.
type	string	AI custom rule revision resource type. (ai_rule_revision) (example: ai_rule_revision)

list_ai_custom_rule_revisions

Name	Datatype	Description
id	string	The revision identifier. (example: revision-abc-123)
attributes	object	Response attributes of an AI custom rule revision.
type	string	AI custom rule revision resource type. (ai_rule_revision) (example: ai_rule_revision)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ai_custom_rule_revision	select	ruleset_name, rule_name, id		Get a specific revision of an AI custom rule.
list_ai_custom_rule_revisions	select	ruleset_name, rule_name	page[offset], page[limit]	Get all revisions for an AI custom rule.
create_ai_custom_rule_revision	insert	ruleset_name, rule_name		Create a new revision for an AI custom rule.

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
id	string	The revision identifier.
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.
page[limit]	integer (int64)	The maximum number of revisions to return.
page[offset]	integer (int64)	The offset for pagination.

SELECT examples

get_ai_custom_rule_revision

Get a specific revision of an AI custom rule.

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

list_ai_custom_rule_revisions

Get all revisions for an AI custom rule.

SELECT
id,
attributes,
type
FROM datadog.security.static_analysis_ai_ruleset_rule_revisions
WHERE ruleset_name = '{{ ruleset_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND page[offset] = '{{ page[offset] }}'
AND page[limit] = '{{ page[limit] }}'
;

INSERT examples

create_ai_custom_rule_revision

Create a new revision for an AI custom rule.

INSERT INTO datadog.security.static_analysis_ai_ruleset_rule_revisions (
data,
ruleset_name,
rule_name
)
SELECT 
'{{ data }}',
'{{ ruleset_name }}',
'{{ rule_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: static_analysis_ai_ruleset_rule_revisions
props:
  - name: ruleset_name
    value: "{{ ruleset_name }}"
    description: Required parameter for the static_analysis_ai_ruleset_rule_revisions resource.
  - name: rule_name
    value: "{{ rule_name }}"
    description: Required parameter for the static_analysis_ai_ruleset_rule_revisions resource.
  - name: data
    description: |
      Request data for creating an AI custom rule revision.
    value:
      attributes:
        category: "{{ category }}"
        content: "{{ content }}"
        cwe: "{{ cwe }}"
        description: "{{ description }}"
        directories:
          - "{{ directories }}"
        execution_mode: "{{ execution_mode }}"
        globs:
          - "{{ globs }}"
        is_published: {{ is_published }}
        is_testing: {{ is_testing }}
        severity: "{{ severity }}"
        short_description: "{{ short_description }}"
        version_id: {{ version_id }}
      id: "{{ id }}"
      type: "{{ type }}"