REST Resource: organizations.locations.effectiveEventThreatDetectionCustomModules

Resource: EffectiveEventThreatDetectionCustomModule

An EffectiveEventThreatDetectionCustomModule is the representation of EventThreatDetectionCustomModule at a given level taking hierarchy into account and resolving various fields accordingly. e.g. if the module is enabled at the ancestor level, effective modules at all descendant levels will have enablementState set to ENABLED. Similarly, if module.inherited is set, then effective module's config will contain the ancestor's config details. EffectiveEventThreatDetectionCustomModule is read-only.

JSON representation 
{
  "name": string,
  "config": {
    object
  },
  "enablementState": enum (EnablementState),
  "type": string,
  "displayName": string,
  "description": string
}
Fields
name

string

Immutable. The resource name of the ETD custom module.

Its format is:

  • "organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}".
  • "folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}".
  • "projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}".
config

object (Struct format)

Output only. Config for the effective module.
enablementState

enum (EnablementState)

Output only. The effective state of enablement for the module at the given level of the hierarchy.
type

string

Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
displayName

string

Output only. The human readable name to be displayed for the module.
description

string

Output only. The description for the module.

Methods

get

 Gets an effective ETD custom module.

list

 Lists all effective Event Threat Detection custom modules for the given parent.