Class CloudConfigurationRulePayload

The payload of a cloud configuration rule.

Hierarchy

  • CloudConfigurationRulePayload

Constructors

constructor

Properties

additionalProperties? cases complianceSignalOptions customMessage? customName? filters? isEnabled message name options tags? type?

Constructors

constructor

Properties

Optional additionalProperties

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

cases

cases: CloudConfigurationRuleCaseCreate[]

Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item.

complianceSignalOptions

complianceSignalOptions: CloudConfigurationRuleComplianceSignalOptions

How to generate compliance signals. Useful for cloud_configuration rules only.

Optional customMessage

customMessage?: string

Custom/Overridden message for generated signals (used in case of Default rule update).

Optional customName

customName?: string

Custom/Overridden name of the rule (used in case of Default rule update).

Optional filters

filters?: SecurityMonitoringFilter[]

Additional queries to filter matched events before they are processed.

isEnabled

isEnabled: boolean

Whether the rule is enabled.

message

message: string

Message in markdown format for generated findings and signals.

name

name: string

The name of the rule.

options

options: CloudConfigurationRuleOptions

Options on cloud configuration rules.

Optional tags

tags?: string[]

Tags for generated findings and signals.

Optional type

type?: CloudConfigurationRuleType

The rule type.

Settings

Member Visibility

Theme

Generated using TypeDoc