Add included_keyword_configuration field to SDS rule (#1824)

Co-authored-by: ci.datadog-api-spec <[email protected]> 903b743

_sources/datadog_api_client.v2.model.rst.txt

@@ -7554,6 +7554,13 @@ sensitive\_data\_scanner\_group\_update\_response
    :members:
    :show-inheritance:
 
+sensitive\_data\_scanner\_included\_keyword\_configuration
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration
+   :members:
+   :show-inheritance:
+
 sensitive\_data\_scanner\_meta
 ------------------------------
 

datadog_api_client.html

@@ -9430,6 +9430,10 @@ <h1 id="datadog-api-client--page-root">datadog_api_client<a class="headerlink" h
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_group_update_response.SensitiveDataScannerGroupUpdateResponse"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerGroupUpdateResponse</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration">sensitive_data_scanner_included_keyword_configuration</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration.SensitiveDataScannerIncludedKeywordConfiguration"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerIncludedKeywordConfiguration</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_meta">sensitive_data_scanner_meta</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_meta.SensitiveDataScannerMeta"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerMeta</span></code></a></li>
 </ul>

datadog_api_client.v2.html

@@ -5878,6 +5878,10 @@ <h1 id="datadog-api-client-v2--page-root">datadog_api_client.v2<a class="headerl
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_group_update_response.SensitiveDataScannerGroupUpdateResponse"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerGroupUpdateResponse</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration">sensitive_data_scanner_included_keyword_configuration</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration.SensitiveDataScannerIncludedKeywordConfiguration"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerIncludedKeywordConfiguration</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_meta">sensitive_data_scanner_meta</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_meta.SensitiveDataScannerMeta"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerMeta</span></code></a></li>
 </ul>

datadog_api_client.v2.model.html

@@ -6799,6 +6799,12 @@
         </li></ul>
             </nav>
         </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration" class="md-nav__link">sensitive_data_scanner_included_keyword_configuration</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration.SensitiveDataScannerIncludedKeywordConfiguration" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerIncludedKeywordConfiguration</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
         <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.sensitive_data_scanner_meta" class="md-nav__link">sensitive_data_scanner_meta</a><nav class="md-nav">
               <ul class="md-nav__list">
         <li class="md-nav__item"><a href="#datadog_api_client.v2.model.sensitive_data_scanner_meta.SensitiveDataScannerMeta" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerMeta</span></code></a>
@@ -15259,6 +15265,12 @@
         </li></ul>
             </nav>
         </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration" class="md-nav__link">sensitive_data_scanner_included_keyword_configuration</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration.SensitiveDataScannerIncludedKeywordConfiguration" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerIncludedKeywordConfiguration</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
         <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.sensitive_data_scanner_meta" class="md-nav__link">sensitive_data_scanner_meta</a><nav class="md-nav">
               <ul class="md-nav__list">
         <li class="md-nav__item"><a href="#datadog_api_client.v2.model.sensitive_data_scanner_meta.SensitiveDataScannerMeta" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerMeta</span></code></a>
@@ -37703,6 +37715,28 @@ <h1 id="datadog-api-client-v2-model--page-root">datadog_api_client.v2.model<a cl
 </dl>
 </dd></dl>
 </section>
+<section id="module-datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration">
+<span id="sensitive-data-scanner-included-keyword-configuration"></span><h2 id="module-datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration">sensitive_data_scanner_included_keyword_configuration<a class="headerlink" href="#module-datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration.SensitiveDataScannerIncludedKeywordConfiguration">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SensitiveDataScannerIncludedKeywordConfiguration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration.SensitiveDataScannerIncludedKeywordConfiguration" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
+<p>Object defining a set of keywords and a number of characters that help reduce noise.
+You can provide a list of keywords you would like to check within a defined proximity of the matching pattern.
+If any of the keywords are found within the proximity check, the match is kept.
+If none are found, the match is discarded.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>character_count</strong> (<em>int</em>) – The number of characters behind a match detected by Sensitive Data Scanner to look for the keywords defined.
+<code class="docutils literal notranslate"><span class="pre">character_count</span></code> should be greater than the maximum length of a keyword defined for a rule.</p></li>
+<li><p><strong>keywords</strong> (<em>[</em><em>str</em><em>]</em>) – Keyword list that will be checked during scanning in order to validate a match.
+The number of keywords in the list must be less than or equal to 20.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+</section>
 <section id="module-datadog_api_client.v2.model.sensitive_data_scanner_meta">
 <span id="sensitive-data-scanner-meta"></span><h2 id="module-datadog_api_client.v2.model.sensitive_data_scanner_meta">sensitive_data_scanner_meta<a class="headerlink" href="#module-datadog_api_client.v2.model.sensitive_data_scanner_meta" title="Link to this heading">¶</a></h2>
 <dl class="py class">
@@ -37826,6 +37860,10 @@ <h1 id="datadog-api-client-v2-model--page-root">datadog_api_client.v2.model<a cl
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>description</strong> (<em>str</em><em>, </em><em>optional</em>) – Description of the rule.</p></li>
 <li><p><strong>excluded_namespaces</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.</p></li>
+<li><p><strong>included_keyword_configuration</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration.SensitiveDataScannerIncludedKeywordConfiguration" title="datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration.SensitiveDataScannerIncludedKeywordConfiguration"><em>SensitiveDataScannerIncludedKeywordConfiguration</em></a><em>, </em><em>optional</em>) – Object defining a set of keywords and a number of characters that help reduce noise.
+You can provide a list of keywords you would like to check within a defined proximity of the matching pattern.
+If any of the keywords are found within the proximity check, the match is kept.
+If none are found, the match is discarded.</p></li>
 <li><p><strong>is_enabled</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether or not the rule is enabled.</p></li>
 <li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – Name of the rule.</p></li>
 <li><p><strong>namespaces</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.

genindex.html

@@ -10035,15 +10035,15 @@ <h2 id="D">D</h2>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.confluent_account_update_request_data">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     datadog_api_client.v2.model.confluent_accounts_response
 
       <ul>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.confluent_accounts_response">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     datadog_api_client.v2.model.confluent_resource_request
 
@@ -16048,6 +16048,13 @@ <h2 id="D">D</h2>
 
       <ul>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_group_update_response">module</a>
+</li>
+      </ul></li>
+      <li>
+    datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration
+
+      <ul>
+        <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration">module</a>
 </li>
       </ul></li>
       <li>
@@ -23990,6 +23997,8 @@ <h2 id="M">M</h2>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_group_update_request">datadog_api_client.v2.model.sensitive_data_scanner_group_update_request</a>
 </li>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_group_update_response">datadog_api_client.v2.model.sensitive_data_scanner_group_update_response</a>
+</li>
+        <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration">datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration</a>
 </li>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_meta">datadog_api_client.v2.model.sensitive_data_scanner_meta</a>
 </li>
@@ -25699,6 +25708,8 @@ <h2 id="S">S</h2>
       <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_group_update_request.SensitiveDataScannerGroupUpdateRequest">SensitiveDataScannerGroupUpdateRequest (class in datadog_api_client.v2.model.sensitive_data_scanner_group_update_request)</a>
 </li>
       <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_group_update_response.SensitiveDataScannerGroupUpdateResponse">SensitiveDataScannerGroupUpdateResponse (class in datadog_api_client.v2.model.sensitive_data_scanner_group_update_response)</a>
+</li>
+      <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration.SensitiveDataScannerIncludedKeywordConfiguration">SensitiveDataScannerIncludedKeywordConfiguration (class in datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration)</a>
 </li>
       <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_meta.SensitiveDataScannerMeta">SensitiveDataScannerMeta (class in datadog_api_client.v2.model.sensitive_data_scanner_meta)</a>
 </li>

py-modindex.html

@@ -10941,6 +10941,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_group_update_response"><code class="xref">datadog_api_client.v2.model.sensitive_data_scanner_group_update_response</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration"><code class="xref">datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;