From b60b55d1072331793252af9ae018e8bf01e24e50 Mon Sep 17 00:00:00 2001 From: Pietro Dellino Date: Wed, 17 Jan 2024 13:28:19 +0100 Subject: [PATCH] Generate documentation --- .../security_monitoring_suppressions.md | 34 +++++++++++++++++++ .../security_monitoring_suppression.md | 32 +++++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 docs/data-sources/security_monitoring_suppressions.md create mode 100644 docs/resources/security_monitoring_suppression.md diff --git a/docs/data-sources/security_monitoring_suppressions.md b/docs/data-sources/security_monitoring_suppressions.md new file mode 100644 index 0000000000..df77358a42 --- /dev/null +++ b/docs/data-sources/security_monitoring_suppressions.md @@ -0,0 +1,34 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "datadog_security_monitoring_suppressions Data Source - terraform-provider-datadog" +subcategory: "" +description: |- + Use this data source to retrieve information about existing suppression rules, and use them in other resources. +--- + +# datadog_security_monitoring_suppressions (Data Source) + +Use this data source to retrieve information about existing suppression rules, and use them in other resources. + + + + +## Schema + +### Read-Only + +- `id` (String) The ID of this resource. +- `suppression_ids` (List of String) List of IDs of suppressions +- `suppressions` (List of Object) List of suppressions (see [below for nested schema](#nestedatt--suppressions)) + + +### Nested Schema for `suppressions` + +Read-Only: + +- `description` (String) +- `enabled` (Boolean) +- `expiration_date` (String) +- `name` (String) +- `rule_query` (String) +- `suppression_query` (String) diff --git a/docs/resources/security_monitoring_suppression.md b/docs/resources/security_monitoring_suppression.md new file mode 100644 index 0000000000..895326d915 --- /dev/null +++ b/docs/resources/security_monitoring_suppression.md @@ -0,0 +1,32 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "datadog_security_monitoring_suppression Resource - terraform-provider-datadog" +subcategory: "" +description: |- + Provides a Datadog Security Monitoring Suppression API resource. It can be used to create and manage Datadog security monitoring suppression rules. +--- + +# datadog_security_monitoring_suppression (Resource) + +Provides a Datadog Security Monitoring Suppression API resource. It can be used to create and manage Datadog security monitoring suppression rules. + + + + +## Schema + +### Required + +- `enabled` (Boolean) Whether the suppression rule is enabled. +- `name` (String) The name of the suppression rule. +- `rule_query` (String) The rule query of the suppression rule, with the same syntax as the search bar for detection rules. +- `suppression_query` (String) The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. Same syntax as the queries to search signals in the signal explorer. + +### Optional + +- `description` (String) A description for the suppression rule. +- `expiration_date` (String) A RFC3339 timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore. + +### Read-Only + +- `id` (String) The ID of this resource.