Skip to content

Commit 8741cef

Browse files
Add rule type conversion limitations for Security Monitoring (#2949)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 27f9b78
1 parent 31df1df commit 8741cef

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

datadog_api_client.v2.api.html

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11892,8 +11892,14 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1189211892
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.convert_existing_security_monitoring_rule">
1189311893
<span class="sig-name descname"><span class="pre">convert_existing_security_monitoring_rule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rule_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_convert_response.SecurityMonitoringRuleConvertResponse" title="datadog_api_client.v2.model.security_monitoring_rule_convert_response.SecurityMonitoringRuleConvertResponse"><span class="pre">SecurityMonitoringRuleConvertResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.convert_existing_security_monitoring_rule" title="Link to this definition">¶</a></dt>
1189411894
<dd><p>Convert an existing rule from JSON to Terraform.</p>
11895-
<p>Convert an existing rule from JSON to Terraform for datadog provider
11896-
resource datadog_security_monitoring_rule.</p>
11895+
<p>Convert an existing rule from JSON to Terraform for Datadog provider
11896+
resource <code class="docutils literal notranslate"><span class="pre">datadog_security_monitoring_rule</span></code>. You can do so for the following rule types:</p>
11897+
<ul class="simple">
11898+
<li><p>App and API Protection</p></li>
11899+
<li><p>Cloud SIEM (log detection and signal correlation)</p></li>
11900+
<li><p>Workload Protection</p></li>
11901+
</ul>
11902+
<p>You can convert Cloud Security configuration rules using Terraform’s <a class="reference external" href="https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule">Datadog Cloud Configuration Rule resource</a>.</p>
1189711903
<dl class="field-list simple">
1189811904
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
1189911905
<dd class="field-odd"><p><strong>rule_id</strong> (<em>str</em>) – The ID of the rule.</p>
@@ -11918,8 +11924,14 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1191811924
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.convert_security_monitoring_rule_from_json_to_terraform">
1191911925
<span class="sig-name descname"><span class="pre">convert_security_monitoring_rule_from_json_to_terraform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_convert_payload.SecurityMonitoringRuleConvertPayload" title="datadog_api_client.v2.model.security_monitoring_rule_convert_payload.SecurityMonitoringRuleConvertPayload"><span class="pre">SecurityMonitoringRuleConvertPayload</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_standard_rule_payload.SecurityMonitoringStandardRulePayload" title="datadog_api_client.v2.model.security_monitoring_standard_rule_payload.SecurityMonitoringStandardRulePayload"><span class="pre">SecurityMonitoringStandardRulePayload</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_signal_rule_payload.SecurityMonitoringSignalRulePayload" title="datadog_api_client.v2.model.security_monitoring_signal_rule_payload.SecurityMonitoringSignalRulePayload"><span class="pre">SecurityMonitoringSignalRulePayload</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_convert_response.SecurityMonitoringRuleConvertResponse" title="datadog_api_client.v2.model.security_monitoring_rule_convert_response.SecurityMonitoringRuleConvertResponse"><span class="pre">SecurityMonitoringRuleConvertResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.convert_security_monitoring_rule_from_json_to_terraform" title="Link to this definition">¶</a></dt>
1192011926
<dd><p>Convert a rule from JSON to Terraform.</p>
11921-
<p>Convert a rule that doesn’t (yet) exist from JSON to Terraform for datadog provider
11922-
resource datadog_security_monitoring_rule.</p>
11927+
<p>Convert a rule that doesn’t (yet) exist from JSON to Terraform for Datadog provider
11928+
resource <code class="docutils literal notranslate"><span class="pre">datadog_security_monitoring_rule</span></code>. You can do so for the following rule types:</p>
11929+
<ul class="simple">
11930+
<li><p>App and API Protection</p></li>
11931+
<li><p>Cloud SIEM (log detection and signal correlation)</p></li>
11932+
<li><p>Workload Protection</p></li>
11933+
</ul>
11934+
<p>You can convert Cloud Security configuration rules using Terraform’s <a class="reference external" href="https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule">Datadog Cloud Configuration Rule resource</a>.</p>
1192311935
<dl class="field-list simple">
1192411936
<dt class="field-odd">Return type<span class="colon">:</span></dt>
1192511937
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_convert_response.SecurityMonitoringRuleConvertResponse" title="datadog_api_client.v2.model.security_monitoring_rule_convert_response.SecurityMonitoringRuleConvertResponse">SecurityMonitoringRuleConvertResponse</a></p>

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)