Added optional field filters when creating a cloud configuration rule (#1250)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit c2ba37b49aff · 2023-07-20T16:30:04.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-07-19 18:05:03.090949",
-            "spec_repo_commit": "e9066fe1"
+            "regenerated": "2023-07-20 14:24:53.880350",
+            "spec_repo_commit": "878f93fe"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-07-19 18:05:03.104671",
-            "spec_repo_commit": "e9066fe1"
+            "regenerated": "2023-07-20 14:24:53.902379",
+            "spec_repo_commit": "878f93fe"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -2696,6 +2696,12 @@ components:
           type: array
         complianceSignalOptions:
           $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
+        filters:
+          description: Additional queries to filter matched events before they are
+            processed.
+          items:
+            $ref: '#/components/schemas/SecurityMonitoringFilter'
+          type: array
         isEnabled:
           description: Whether the rule is enabled.
           example: true
diff --git a/cassettes/v2/Security-Monitoring_1187227211/Create-a-cloud_configuration-rule-returns-OK-response_3743307914/frozen.json b/cassettes/v2/Security-Monitoring_1187227211/Create-a-cloud_configuration-rule-returns-OK-response_3743307914/frozen.json
@@ -1 +1 @@
-"2022-12-16T18:53:53.418Z"
+"2023-07-20T12:27:33.661Z"
diff --git a/cassettes/v2/Security-Monitoring_1187227211/Create-a-cloud_configuration-rule-returns-OK-response_3743307914/recording.har b/cassettes/v2/Security-Monitoring_1187227211/Create-a-cloud_configuration-rule-returns-OK-response_3743307914/recording.har
@@ -8,11 +8,11 @@
     },
     "entries": [
       {
-        "_id": "d06540cae8aacb411cd062b8c1919a24",
+        "_id": "242acd1f1aa8dce404b800b78709e4a4",
         "_order": 0,
         "cache": {},
         "request": {
-          "bodySize": 486,
+          "bodySize": 593,
           "cookies": [],
           "headers": [
             {
@@ -26,23 +26,23 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 588,
+          "headersSize": 587,
           "httpVersion": "HTTP/1.1",
           "method": "POST",
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"cases\":[{\"notifications\":[\"channel\"],\"status\":\"info\"}],\"complianceSignalOptions\":{\"userActivationStatus\":true,\"userGroupByFields\":[\"@account_id\"]},\"isEnabled\":false,\"message\":\"ddd\",\"name\":\"Test-Create_a_cloud_configuration_rule_returns_OK_response-1671216833_cloud\",\"options\":{\"complianceRuleOptions\":{\"complexRule\":false,\"regoRule\":{\"policy\":\"package datadog\\n\",\"resourceTypes\":[\"gcp_compute_disk\"]},\"resourceType\":\"gcp_compute_disk\"}},\"tags\":[\"my:tag\"],\"type\":\"cloud_configuration\"}"
+            "text": "{\"cases\":[{\"notifications\":[\"channel\"],\"status\":\"info\"}],\"complianceSignalOptions\":{\"userActivationStatus\":true,\"userGroupByFields\":[\"@account_id\"]},\"filters\":[{\"action\":\"require\",\"query\":\"resource_id:helo*\"},{\"action\":\"suppress\",\"query\":\"control:helo*\"}],\"isEnabled\":false,\"message\":\"ddd\",\"name\":\"Test-Create_a_cloud_configuration_rule_returns_OK_response-1689856053_cloud\",\"options\":{\"complianceRuleOptions\":{\"complexRule\":false,\"regoRule\":{\"policy\":\"package datadog\\n\",\"resourceTypes\":[\"gcp_compute_disk\"]},\"resourceType\":\"gcp_compute_disk\"}},\"tags\":[\"my:tag\"],\"type\":\"cloud_configuration\"}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v2/security_monitoring/rules"
         },
         "response": {
-          "bodySize": 987,
+          "bodySize": 1102,
           "content": {
             "mimeType": "application/json",
-            "size": 987,
-            "text": "{\"creationAuthorId\":1445416,\"tags\":[\"my:tag\"],\"type\":\"cloud_configuration\",\"isEnabled\":false,\"hasExtendedTitle\":true,\"message\":\"ddd\",\"options\":{\"detectionMethod\":\"threshold\",\"evaluationWindow\":7200,\"maxSignalDuration\":86400,\"complianceRuleOptions\":{\"resourceType\":\"gcp_compute_disk\",\"regoRule\":{\"policy\":\"package datadog\\n\",\"resourceTypes\":[\"gcp_compute_disk\"]},\"complexRule\":false},\"keepAlive\":21600},\"version\":1,\"createdAt\":1671216834196,\"filters\":[],\"queries\":[{\"query\":\"resource_type:gcp_compute_disk\",\"groupByFields\":[\"resource_type\",\"resource_id\"],\"aggregation\":\"count\",\"name\":\"a\",\"distinctFields\":[]}],\"isDeleted\":false,\"complianceSignalOptions\":{\"defaultActivationStatus\":null,\"userActivationStatus\":true,\"defaultGroupByFields\":null,\"userGroupByFields\":[\"@account_id\"]},\"cases\":[{\"status\":\"info\",\"notifications\":[\"channel\"],\"name\":\"\",\"condition\":\"a > 0\"}],\"id\":\"fat-bma-9yo\",\"isDefault\":false,\"name\":\"Test-Create_a_cloud_configuration_rule_returns_OK_response-1671216833_cloud\"}\n"
+            "size": 1102,
+            "text": "{\"id\":\"rmr-xkf-scr\",\"version\":1,\"name\":\"Test-Create_a_cloud_configuration_rule_returns_OK_response-1689856053_cloud\",\"createdAt\":1689856054469,\"creationAuthorId\":1445416,\"isDefault\":false,\"isEnabled\":false,\"isDeleted\":false,\"isDeprecated\":false,\"queries\":[{\"query\":\"resource_type:gcp_compute_disk\",\"groupByFields\":[\"resource_type\",\"resource_id\"],\"distinctFields\":[],\"aggregation\":\"count\",\"name\":\"a\"}],\"options\":{\"keepAlive\":21600,\"maxSignalDuration\":86400,\"detectionMethod\":\"threshold\",\"evaluationWindow\":7200,\"complianceRuleOptions\":{\"resourceType\":\"gcp_compute_disk\",\"regoRule\":{\"policy\":\"package datadog\\n\",\"resourceTypes\":[\"gcp_compute_disk\"]},\"complexRule\":false}},\"complianceSignalOptions\":{\"defaultActivationStatus\":null,\"defaultGroupByFields\":null,\"userActivationStatus\":true,\"userGroupByFields\":[\"@account_id\"]},\"cases\":[{\"condition\":\"a > 0\",\"name\":\"\",\"status\":\"info\",\"notifications\":[\"channel\"]}],\"message\":\"ddd\",\"tags\":[\"my:tag\"],\"hasExtendedTitle\":true,\"type\":\"cloud_configuration\",\"filters\":[{\"action\":\"require\",\"query\":\"resource_id:helo*\"},{\"action\":\"suppress\",\"query\":\"control:helo*\"}]}\n"
           },
           "cookies": [],
           "headers": [
@@ -51,17 +51,17 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 627,
+          "headersSize": 655,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2022-12-16T18:53:53.438Z",
-        "time": 798
+        "startedDateTime": "2023-07-20T12:27:34.378Z",
+        "time": 121
       },
       {
-        "_id": "578b95286605978cf0b83aad6a998b79",
+        "_id": "fcc1c54c47a8bc3f4da54d41c1afd208",
         "_order": 0,
         "cache": {},
         "request": {
@@ -74,11 +74,11 @@
               "value": "*/*"
             }
           ],
-          "headersSize": 536,
+          "headersSize": 535,
           "httpVersion": "HTTP/1.1",
           "method": "DELETE",
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v2/security_monitoring/rules/fat-bma-9yo"
+          "url": "https://api.datadoghq.com/api/v2/security_monitoring/rules/rmr-xkf-scr"
         },
         "response": {
           "bodySize": 0,
@@ -88,14 +88,14 @@
           },
           "cookies": [],
           "headers": [],
-          "headersSize": 574,
+          "headersSize": 601,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 204,
           "statusText": "No Content"
         },
-        "startedDateTime": "2022-12-16T18:53:54.268Z",
-        "time": 298
+        "startedDateTime": "2023-07-20T12:27:34.509Z",
+        "time": 129
       }
     ],
     "pages": [],
diff --git a/examples/v2/security-monitoring/CreateSecurityMonitoringRule_1092490364.ts b/examples/v2/security-monitoring/CreateSecurityMonitoringRule_1092490364.ts
@@ -35,6 +35,16 @@ const params: v2.SecurityMonitoringApiCreateSecurityMonitoringRuleRequest = {
       userActivationStatus: true,
       userGroupByFields: ["@account_id"],
     },
+    filters: [
+      {
+        action: "require",
+        query: "resource_id:helo*",
+      },
+      {
+        action: "suppress",
+        query: "control:helo*",
+      },
+    ],
   },
 };
 
diff --git a/features/v2/security_monitoring.feature b/features/v2/security_monitoring.feature
@@ -58,7 +58,7 @@ Feature: Security Monitoring
   @team:DataDog/k9-cloud-security-platform
   Scenario: Create a cloud_configuration rule returns "OK" response
     Given new "CreateSecurityMonitoringRule" request
-    And body with value {"type":"cloud_configuration","name":"{{ unique }}_cloud","isEnabled":false,"cases":[{"status":"info","notifications":["channel"]}],"options":{"complianceRuleOptions":{"resourceType":"gcp_compute_disk","complexRule": false,"regoRule":{"policy":"package datadog\n","resourceTypes":["gcp_compute_disk"]}}},"message":"ddd","tags":["my:tag"],"complianceSignalOptions":{"userActivationStatus":true,"userGroupByFields":["@account_id"]}}
+    And body with value {"type":"cloud_configuration","name":"{{ unique }}_cloud","isEnabled":false,"cases":[{"status":"info","notifications":["channel"]}],"options":{"complianceRuleOptions":{"resourceType":"gcp_compute_disk","complexRule": false,"regoRule":{"policy":"package datadog\n","resourceTypes":["gcp_compute_disk"]}}},"message":"ddd","tags":["my:tag"],"complianceSignalOptions":{"userActivationStatus":true,"userGroupByFields":["@account_id"]},"filters":[{"action":"require","query":"resource_id:helo*"},{"action":"suppress","query":"control:helo*"}]}
     When the request is sent
     Then the response status is 200 OK
     And the response "name" is equal to "{{ unique }}_cloud"
diff --git a/packages/datadog-api-client-v2/models/CloudConfigurationRuleCreatePayload.ts b/packages/datadog-api-client-v2/models/CloudConfigurationRuleCreatePayload.ts
@@ -7,6 +7,7 @@ import { CloudConfigurationRuleCaseCreate } from "./CloudConfigurationRuleCaseCr
 import { CloudConfigurationRuleComplianceSignalOptions } from "./CloudConfigurationRuleComplianceSignalOptions";
 import { CloudConfigurationRuleOptions } from "./CloudConfigurationRuleOptions";
 import { CloudConfigurationRuleType } from "./CloudConfigurationRuleType";
+import { SecurityMonitoringFilter } from "./SecurityMonitoringFilter";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
@@ -22,6 +23,10 @@ export class CloudConfigurationRuleCreatePayload {
    * How to generate compliance signals. Useful for cloud_configuration rules only.
    */
   "complianceSignalOptions": CloudConfigurationRuleComplianceSignalOptions;
+  /**
+   * Additional queries to filter matched events before they are processed.
+   */
+  "filters"?: Array<SecurityMonitoringFilter>;
   /**
    * Whether the rule is enabled.
    */
@@ -66,6 +71,10 @@ export class CloudConfigurationRuleCreatePayload {
       type: "CloudConfigurationRuleComplianceSignalOptions",
       required: true,
     },
+    filters: {
+      baseName: "filters",
+      type: "Array<SecurityMonitoringFilter>",
+    },
     isEnabled: {
       baseName: "isEnabled",
       type: "boolean",

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.5",`
`7`		`- "regenerated": "2023-07-19 18:05:03.090949",`
`8`		`- "spec_repo_commit": "e9066fe1"`
	`7`	`+ "regenerated": "2023-07-20 14:24:53.880350",`
	`8`	`+ "spec_repo_commit": "878f93fe"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.5",`
`12`		`- "regenerated": "2023-07-19 18:05:03.104671",`
`13`		`- "spec_repo_commit": "e9066fe1"`
	`12`	`+ "regenerated": "2023-07-20 14:24:53.902379",`
	`13`	`+ "spec_repo_commit": "878f93fe"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-"2022-12-16T18:53:53.418Z"`
	`1`	`+"2023-07-20T12:27:33.661Z"`