custom_modules

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

Overview

Name	custom_modules
Type	Resource
Id	google.securitycenter.custom_modules

Fields

The following fields are returned by SELECT queries:

folders_event_threat_detection_settings_custom_modules_get

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_get

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_get

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_get	select	foldersId, customModulesId		Gets an Event Threat Detection custom module.
projects_event_threat_detection_settings_custom_modules_get	select	projectsId, customModulesId		Gets an Event Threat Detection custom module.
organizations_event_threat_detection_settings_custom_modules_get	select	organizationsId, customModulesId		Gets an Event Threat Detection custom module.
folders_security_health_analytics_settings_custom_modules_patch	update	foldersId, customModulesId	updateMask	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_event_threat_detection_settings_custom_modules_patch	update	foldersId, customModulesId	updateMask	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	projectsId, customModulesId	updateMask	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	projectsId, customModulesId	updateMask	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	organizationsId, customModulesId	updateMask	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	organizationsId, customModulesId	updateMask	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_simulate	exec	foldersId		Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
projects_security_health_analytics_settings_custom_modules_simulate	exec	projectsId		Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
organizations_security_health_analytics_settings_custom_modules_simulate	exec	organizationsId		Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

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
updateMask	string (google-fieldmask)

SELECT examples

folders_event_threat_detection_settings_custom_modules_get

Gets an Event Threat Detection custom module.

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

projects_event_threat_detection_settings_custom_modules_get

Gets an Event Threat Detection custom module.

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

organizations_event_threat_detection_settings_custom_modules_get

Gets an Event Threat Detection custom module.

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

UPDATE examples

folders_security_health_analytics_settings_custom_modules_patch

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.

UPDATE google.securitycenter.custom_modules
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__enablementState = '{{ enablementState }}',
data__customConfig = '{{ customConfig }}',
data__cloudProvider = '{{ cloudProvider }}'
WHERE 
foldersId = '{{ foldersId }}' --required
AND customModulesId = '{{ customModulesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime;

folders_event_threat_detection_settings_custom_modules_patch

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.

UPDATE google.securitycenter.custom_modules
SET 
data__name = '{{ name }}',
data__config = '{{ config }}',
data__enablementState = '{{ enablementState }}',
data__type = '{{ type }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__cloudProvider = '{{ cloudProvider }}'
WHERE 
foldersId = '{{ foldersId }}' --required
AND customModulesId = '{{ customModulesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime;

projects_security_health_analytics_settings_custom_modules_patch

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.

UPDATE google.securitycenter.custom_modules
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__enablementState = '{{ enablementState }}',
data__customConfig = '{{ customConfig }}',
data__cloudProvider = '{{ cloudProvider }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND customModulesId = '{{ customModulesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime;

projects_event_threat_detection_settings_custom_modules_patch

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.

UPDATE google.securitycenter.custom_modules
SET 
data__name = '{{ name }}',
data__config = '{{ config }}',
data__enablementState = '{{ enablementState }}',
data__type = '{{ type }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__cloudProvider = '{{ cloudProvider }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND customModulesId = '{{ customModulesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime;

organizations_security_health_analytics_settings_custom_modules_patch

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.

UPDATE google.securitycenter.custom_modules
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__enablementState = '{{ enablementState }}',
data__customConfig = '{{ customConfig }}',
data__cloudProvider = '{{ cloudProvider }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND customModulesId = '{{ customModulesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime;

organizations_event_threat_detection_settings_custom_modules_patch

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.

UPDATE google.securitycenter.custom_modules
SET 
data__name = '{{ name }}',
data__config = '{{ config }}',
data__enablementState = '{{ enablementState }}',
data__type = '{{ type }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__cloudProvider = '{{ cloudProvider }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND customModulesId = '{{ customModulesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime;

Lifecycle Methods

folders_security_health_analytics_settings_custom_modules_simulate

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

EXEC google.securitycenter.custom_modules.folders_security_health_analytics_settings_custom_modules_simulate 
@foldersId='{{ foldersId }}' --required 
@@json=
'{
"customConfig": "{{ customConfig }}", 
"resource": "{{ resource }}"
}';

projects_security_health_analytics_settings_custom_modules_simulate

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

EXEC google.securitycenter.custom_modules.projects_security_health_analytics_settings_custom_modules_simulate 
@projectsId='{{ projectsId }}' --required 
@@json=
'{
"customConfig": "{{ customConfig }}", 
"resource": "{{ resource }}"
}';

organizations_security_health_analytics_settings_custom_modules_simulate

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

EXEC google.securitycenter.custom_modules.organizations_security_health_analytics_settings_custom_modules_simulate 
@organizationsId='{{ organizationsId }}' --required 
@@json=
'{
"customConfig": "{{ customConfig }}", 
"resource": "{{ resource }}"
}';