static_analysis_custom_ruleset_rules

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

Overview

Name	static_analysis_custom_ruleset_rules
Type	Resource
Id	datadog.security.static_analysis_custom_ruleset_rules

Fields

The following fields are returned by SELECT queries:

get_custom_rule

Name	Datatype	Description
id	string	Rule identifier (example: my-rule)
attributes	object	A custom static analysis rule within a ruleset.
type	string	Resource type (custom_rule) (example: custom_rule)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_rule	select	ruleset_name, rule_name		Get a custom rule by name
create_custom_rule	replace	ruleset_name		Create a new custom rule within a ruleset
delete_custom_rule	delete	ruleset_name, rule_name		Delete a 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
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_custom_rule

Get a custom rule by name

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

REPLACE examples

create_custom_rule

Create a new custom rule within a ruleset

REPLACE datadog.security.static_analysis_custom_ruleset_rules
SET 
data = '{{ data }}'
WHERE 
ruleset_name = '{{ ruleset_name }}' --required
RETURNING
data;

DELETE examples

delete_custom_rule

Delete a custom rule

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