suppressions_affecting_future_rule

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

Overview

Name	suppressions_affecting_future_rule
Type	Resource
Id	datadog.security.suppressions_affecting_future_rule

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_suppressions_affecting_future_rule	insert	region, data__name, data__isEnabled, data__queries, data__options, data__cases, data__message		Get the list of suppressions that would affect a 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
region	string	(default: datadoghq.com)

INSERT examples

get_suppressions_affecting_future_rule

Get the list of suppressions that would affect a rule.

INSERT INTO datadog.security.suppressions_affecting_future_rule (
data__calculatedFields,
data__cases,
data__filters,
data__groupSignalsBy,
data__hasExtendedTitle,
data__isEnabled,
data__message,
data__name,
data__options,
data__queries,
data__referenceTables,
data__schedulingOptions,
data__tags,
data__thirdPartyCases,
data__type,
region
)
SELECT 
'{{ calculatedFields }}',
'{{ cases }}' /* required */,
'{{ filters }}',
'{{ groupSignalsBy }}',
{{ hasExtendedTitle }},
{{ isEnabled }} /* required */,
'{{ message }}' /* required */,
'{{ name }}' /* required */,
'{{ options }}' /* required */,
'{{ queries }}' /* required */,
'{{ referenceTables }}',
'{{ schedulingOptions }}',
'{{ tags }}',
'{{ thirdPartyCases }}',
'{{ type }}',
'{{ region }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: suppressions_affecting_future_rule
  props:
    - name: region
      value: string
      description: Required parameter for the suppressions_affecting_future_rule resource.
    - name: calculatedFields
      value: array
      description: |
        Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
    - name: cases
      value: array
      description: |
        Cases for generating signals.
    - name: filters
      value: array
      description: |
        Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
    - name: groupSignalsBy
      value: array
      description: |
        Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
    - name: hasExtendedTitle
      value: boolean
      description: |
        Whether the notifications include the triggering group-by values in their title.
    - name: isEnabled
      value: boolean
      description: |
        Whether the rule is enabled.
    - name: message
      value: string
      description: |
        Message for generated signals.
    - name: name
      value: string
      description: |
        The name of the rule.
    - name: options
      value: object
      description: |
        Options.
    - name: queries
      value: array
      description: |
        Queries for selecting logs which are part of the rule.
    - name: referenceTables
      value: array
      description: |
        Reference tables for the rule.
    - name: schedulingOptions
      value: object
      description: |
        Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
    - name: tags
      value: array
      description: |
        Tags for generated signals.
    - name: thirdPartyCases
      value: array
      description: |
        Cases for generating signals from third-party rules. Only available for third-party rules.
    - name: type
      value: string
      description: |
        The rule type.
      valid_values: ['api_security', 'application_security', 'log_detection', 'workload_security']