@datadog/datadog-api-client/dist/packages/datadog-api-client-v2/models/SensitiveDataScannerRuleAttributes.d.ts

OpenAPI client for Datadog APIs

/**
 * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
 * This product includes software developed at Datadog (https://www.datadoghq.com/).
 * Copyright 2020-Present Datadog, Inc.
 */
import { SensitiveDataScannerIncludedKeywordConfiguration } from "./SensitiveDataScannerIncludedKeywordConfiguration";
import { SensitiveDataScannerTextReplacement } from "./SensitiveDataScannerTextReplacement";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
 * Attributes of the Sensitive Data Scanner rule.
 */
export declare class SensitiveDataScannerRuleAttributes {
    /**
     * Description of the rule.
     */
    "description"?: string;
    /**
     * Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.
     */
    "excludedNamespaces"?: Array<string>;
    /**
     * 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.
     */
    "includedKeywordConfiguration"?: SensitiveDataScannerIncludedKeywordConfiguration;
    /**
     * Whether or not the rule is enabled.
     */
    "isEnabled"?: boolean;
    /**
     * Name of the rule.
     */
    "name"?: 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.
     */
    "namespaces"?: Array<string>;
    /**
     * Not included if there is a relationship to a standard pattern.
     */
    "pattern"?: string;
    /**
     * Integer from 1 (high) to 5 (low) indicating rule issue severity.
     */
    "priority"?: number;
    /**
     * List of tags.
     */
    "tags"?: Array<string>;
    /**
     * Object describing how the scanned event will be replaced.
     */
    "textReplacement"?: SensitiveDataScannerTextReplacement;
    /**
     * A container for additional, undeclared properties.
     * This is a holder for any undeclared properties as specified with
     * the 'additionalProperties' keyword in the OAS document.
     */
    "additionalProperties"?: {
        [key: string]: any;
    };
    /**
     * @ignore
     */
    "_unparsed"?: boolean;
    /**
     * @ignore
     */
    static readonly attributeTypeMap: AttributeTypeMap;
    /**
     * @ignore
     */
    static getAttributeTypeMap(): AttributeTypeMap;
    constructor();
}