REST Resource: folders.eventThreatDetectionSettings.effectiveCustomModules

Resource: EffectiveEventThreatDetectionCustomModule

An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the enablementState property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of INHERITED. For example, if the module is enabled in a parent organization or folder, the effective enablementState for the module in all child folders or projects is also enabled. EffectiveEventThreatDetectionCustomModule is read-only.

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

string

Output only. The resource name of the effective ETD custom module.

Its format is:

  • organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
  • folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
  • projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{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.
cloudProvider

enum (CloudProvider)

The cloud provider of the custom module.

EnablementState

The enablement state of the module.

Enums
ENABLEMENT_STATE_UNSPECIFIED Unspecified enablement state.
ENABLED The module is enabled at the given level.
DISABLED The module is disabled at the given level.

CloudProvider

The cloud provider of the custom module.

Enums
CLOUD_PROVIDER_UNSPECIFIED Unspecified cloud provider.
GOOGLE_CLOUD_PLATFORM Google Cloud Platform.
AMAZON_WEB_SERVICES Amazon Web Services.
MICROSOFT_AZURE Microsoft Azure.

Methods

get

 Gets an effective Event Threat Detection custom module at the given level.

list

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