Class SensitiveDataScannerRuleAttributes

Attributes of the Sensitive Data Scanner rule.

Hierarchy

  • SensitiveDataScannerRuleAttributes

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
description?: string

Description of the rule.

excludedNamespaces?: string[]

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

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.

isEnabled?: boolean

Whether or not the rule is enabled.

name?: string

Name of the rule.

namespaces?: string[]

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned.

pattern?: string

Not included if there is a relationship to a standard pattern.

priority?: number

Integer from 1 (high) to 5 (low) indicating rule issue severity.

Object describing suppressions for a rule, or the recommended suppression lists published by a standard pattern. There are three types of suppressions, starts_with, ends_with, and exact_match. Rules based on the Datadog library can use recommended or custom suppressions. Custom rules can only use custom suppressions. Suppressed matches are not obfuscated, counted in metrics, or displayed in the Findings page.

tags?: string[]

List of tags.

Object describing how the scanned event will be replaced.

Generated using TypeDoc