Skip to main content

effective_custom_modules

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

Overview

Nameeffective_custom_modules
TypeResource
Idgoogle.securitycenter.effective_custom_modules

Fields

NameDatatypeDescription
namestringOutput only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"
customConfigobjectDefines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.
displayNamestringOutput only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementStatestringOutput only. The effective state of enablement for the module at the given level of the hierarchy.

Methods

NameAccessible byRequired ParamsDescription
folders_event_threat_detection_settings_effective_custom_modules_getSELECTeffectiveCustomModulesId, foldersIdGets an effective Event Threat Detection custom module at the given level.
folders_event_threat_detection_settings_effective_custom_modules_listSELECTfoldersIdLists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
folders_security_health_analytics_settings_effective_custom_modules_getSELECTeffectiveCustomModulesId, foldersIdRetrieves an EffectiveSecurityHealthAnalyticsCustomModule.
folders_security_health_analytics_settings_effective_custom_modules_listSELECTfoldersIdReturns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
organizations_event_threat_detection_settings_effective_custom_modules_getSELECTeffectiveCustomModulesId, organizationsIdGets an effective Event Threat Detection custom module at the given level.
organizations_event_threat_detection_settings_effective_custom_modules_listSELECTorganizationsIdLists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
organizations_security_health_analytics_settings_effective_custom_modules_getSELECTeffectiveCustomModulesId, organizationsIdRetrieves an EffectiveSecurityHealthAnalyticsCustomModule.
organizations_security_health_analytics_settings_effective_custom_modules_listSELECTorganizationsIdReturns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
projects_event_threat_detection_settings_effective_custom_modules_getSELECTeffectiveCustomModulesId, projectsIdGets an effective Event Threat Detection custom module at the given level.
projects_event_threat_detection_settings_effective_custom_modules_listSELECTprojectsIdLists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
projects_security_health_analytics_settings_effective_custom_modules_getSELECTeffectiveCustomModulesId, projectsIdRetrieves an EffectiveSecurityHealthAnalyticsCustomModule.
projects_security_health_analytics_settings_effective_custom_modules_listSELECTprojectsIdReturns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

SELECT examples

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

SELECT
name,
customConfig,
displayName,
enablementState
FROM google.securitycenter.effective_custom_modules
WHERE foldersId = '{{ foldersId }}';