event_threat_detection_modules

Creates, updates, deletes, gets or lists an event_threat_detection_modules resource.

Overview

Name	event_threat_detection_modules
Type	Resource
Id	google.securitycenter.event_threat_detection_modules

Fields

The following fields are returned by SELECT queries:

folders_event_threat_detection_settings_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the Event Threat Detection custom module. Its format is: * organizations/{organization}/eventThreatDetectionSettings/customModules/{module}. * folders/{folder}/eventThreatDetectionSettings/customModules/{module}. * projects/{project}/eventThreatDetectionSettings/customModules/{module}.
ancestorModule	string	Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
cloudProvider	string	The cloud provider of the custom module.
config	object	Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
description	string	The description for the module.
displayName	string	The human readable name to be displayed for the module.
enablementState	string	The state of enablement for the module at the given level of the hierarchy.
lastEditor	string	Output only. The editor the module was last updated by.
type	string	Type for the module. e.g. CONFIGURABLE_BAD_IP.
updateTime	string (google-datetime)	Output only. The time the module was last updated.

projects_event_threat_detection_settings_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the Event Threat Detection custom module. Its format is: * organizations/{organization}/eventThreatDetectionSettings/customModules/{module}. * folders/{folder}/eventThreatDetectionSettings/customModules/{module}. * projects/{project}/eventThreatDetectionSettings/customModules/{module}.
ancestorModule	string	Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
cloudProvider	string	The cloud provider of the custom module.
config	object	Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
description	string	The description for the module.
displayName	string	The human readable name to be displayed for the module.
enablementState	string	The state of enablement for the module at the given level of the hierarchy.
lastEditor	string	Output only. The editor the module was last updated by.
type	string	Type for the module. e.g. CONFIGURABLE_BAD_IP.
updateTime	string (google-datetime)	Output only. The time the module was last updated.

organizations_event_threat_detection_settings_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the Event Threat Detection custom module. Its format is: * organizations/{organization}/eventThreatDetectionSettings/customModules/{module}. * folders/{folder}/eventThreatDetectionSettings/customModules/{module}. * projects/{project}/eventThreatDetectionSettings/customModules/{module}.
ancestorModule	string	Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
cloudProvider	string	The cloud provider of the custom module.
config	object	Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
description	string	The description for the module.
displayName	string	The human readable name to be displayed for the module.
enablementState	string	The state of enablement for the module at the given level of the hierarchy.
lastEditor	string	Output only. The editor the module was last updated by.
type	string	Type for the module. e.g. CONFIGURABLE_BAD_IP.
updateTime	string (google-datetime)	Output only. The time the module was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
folders_event_threat_detection_settings_custom_modules_list	select	foldersId	pageToken, pageSize	Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
projects_event_threat_detection_settings_custom_modules_list	select	projectsId	pageToken, pageSize	Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
organizations_event_threat_detection_settings_custom_modules_list	select	organizationsId	pageToken, pageSize	Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
folders_event_threat_detection_settings_custom_modules_create	insert	foldersId		Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
projects_event_threat_detection_settings_custom_modules_create	insert	projectsId		Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
organizations_event_threat_detection_settings_custom_modules_create	insert	organizationsId		Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
folders_event_threat_detection_settings_custom_modules_delete	delete	foldersId, customModulesId		Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
projects_event_threat_detection_settings_custom_modules_delete	delete	projectsId, customModulesId		Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
organizations_event_threat_detection_settings_custom_modules_delete	delete	organizationsId, customModulesId		Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
customModulesId	string
foldersId	string
organizationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

folders_event_threat_detection_settings_custom_modules_list

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

SELECT
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime
FROM google.securitycenter.event_threat_detection_modules
WHERE foldersId = '{{ foldersId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

projects_event_threat_detection_settings_custom_modules_list

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

SELECT
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime
FROM google.securitycenter.event_threat_detection_modules
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

organizations_event_threat_detection_settings_custom_modules_list

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

SELECT
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime
FROM google.securitycenter.event_threat_detection_modules
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

INSERT examples

folders_event_threat_detection_settings_custom_modules_create

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

INSERT INTO google.securitycenter.event_threat_detection_modules (
data__name,
data__config,
data__enablementState,
data__type,
data__displayName,
data__description,
data__cloudProvider,
foldersId
)
SELECT 
'{{ name }}',
'{{ config }}',
'{{ enablementState }}',
'{{ type }}',
'{{ displayName }}',
'{{ description }}',
'{{ cloudProvider }}',
'{{ foldersId }}'
RETURNING
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime
;

projects_event_threat_detection_settings_custom_modules_create

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

INSERT INTO google.securitycenter.event_threat_detection_modules (
data__name,
data__config,
data__enablementState,
data__type,
data__displayName,
data__description,
data__cloudProvider,
projectsId
)
SELECT 
'{{ name }}',
'{{ config }}',
'{{ enablementState }}',
'{{ type }}',
'{{ displayName }}',
'{{ description }}',
'{{ cloudProvider }}',
'{{ projectsId }}'
RETURNING
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime
;

organizations_event_threat_detection_settings_custom_modules_create

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

INSERT INTO google.securitycenter.event_threat_detection_modules (
data__name,
data__config,
data__enablementState,
data__type,
data__displayName,
data__description,
data__cloudProvider,
organizationsId
)
SELECT 
'{{ name }}',
'{{ config }}',
'{{ enablementState }}',
'{{ type }}',
'{{ displayName }}',
'{{ description }}',
'{{ cloudProvider }}',
'{{ organizationsId }}'
RETURNING
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: event_threat_detection_modules
  props:
    - name: foldersId
      value: string
      description: Required parameter for the event_threat_detection_modules resource.
    - name: projectsId
      value: string
      description: Required parameter for the event_threat_detection_modules resource.
    - name: organizationsId
      value: string
      description: Required parameter for the event_threat_detection_modules resource.
    - name: name
      value: string
      description: >
        Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
        
    - name: config
      value: object
      description: >
        Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
        
    - name: enablementState
      value: string
      description: >
        The state of enablement for the module at the given level of the hierarchy.
        
      valid_values: ['ENABLEMENT_STATE_UNSPECIFIED', 'ENABLED', 'DISABLED', 'INHERITED']
    - name: type
      value: string
      description: >
        Type for the module. e.g. CONFIGURABLE_BAD_IP.
        
    - name: displayName
      value: string
      description: >
        The human readable name to be displayed for the module.
        
    - name: description
      value: string
      description: >
        The description for the module.
        
    - name: cloudProvider
      value: string
      description: >
        The cloud provider of the custom module.
        
      valid_values: ['CLOUD_PROVIDER_UNSPECIFIED', 'GOOGLE_CLOUD_PLATFORM', 'AMAZON_WEB_SERVICES', 'MICROSOFT_AZURE']

DELETE examples

folders_event_threat_detection_settings_custom_modules_delete

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

DELETE FROM google.securitycenter.event_threat_detection_modules
WHERE foldersId = '{{ foldersId }}' --required
AND customModulesId = '{{ customModulesId }}' --required;

projects_event_threat_detection_settings_custom_modules_delete

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

DELETE FROM google.securitycenter.event_threat_detection_modules
WHERE projectsId = '{{ projectsId }}' --required
AND customModulesId = '{{ customModulesId }}' --required;

organizations_event_threat_detection_settings_custom_modules_delete

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

DELETE FROM google.securitycenter.event_threat_detection_modules
WHERE organizationsId = '{{ organizationsId }}' --required
AND customModulesId = '{{ customModulesId }}' --required;