custom_modules

Creates, updates, deletes, gets or lists a custom_modules resource.

Overview

Name	custom_modules
Type	Resource
Id	google.securitycenter.custom_modules

Fields

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}.
description	string	The description for the 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.
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.
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	Output only. The time the module was last updated.

Methods

Name	Accessible by	Required Params	Description
folders_event_threat_detection_settings_custom_modules_get	SELECT	customModulesId, foldersId	Gets an Event Threat Detection custom module.
organizations_event_threat_detection_settings_custom_modules_get	SELECT	customModulesId, organizationsId	Gets an Event Threat Detection custom module.
projects_event_threat_detection_settings_custom_modules_get	SELECT	customModulesId, projectsId	Gets an Event Threat Detection custom module.
folders_event_threat_detection_settings_custom_modules_patch	UPDATE	customModulesId, foldersId	Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
folders_security_health_analytics_settings_custom_modules_patch	UPDATE	customModulesId, foldersId	Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
organizations_event_threat_detection_settings_custom_modules_patch	UPDATE	customModulesId, organizationsId	Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
organizations_security_health_analytics_settings_custom_modules_patch	UPDATE	customModulesId, organizationsId	Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
projects_event_threat_detection_settings_custom_modules_patch	UPDATE	customModulesId, projectsId	Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
projects_security_health_analytics_settings_custom_modules_patch	UPDATE	customModulesId, projectsId	Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
folders_security_health_analytics_settings_custom_modules_simulate	EXEC	foldersId	Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
organizations_security_health_analytics_settings_custom_modules_simulate	EXEC	organizationsId	Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
projects_security_health_analytics_settings_custom_modules_simulate	EXEC	projectsId	Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

SELECT examples

Gets an Event Threat Detection custom module.

SELECT
name,
description,
ancestorModule,
config,
displayName,
enablementState,
lastEditor,
type,
updateTime
FROM google.securitycenter.custom_modules
WHERE customModulesId = '{{ customModulesId }}'
AND foldersId = '{{ foldersId }}';

UPDATE example

Updates a custom_modules resource.

/*+ update */
UPDATE google.securitycenter.custom_modules
SET 
name = '{{ name }}',
config = '{{ config }}',
enablementState = '{{ enablementState }}',
type = '{{ type }}',
displayName = '{{ displayName }}',
description = '{{ description }}'
WHERE 
customModulesId = '{{ customModulesId }}'
AND foldersId = '{{ foldersId }}';