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:

organizations_event_threat_detection_settings_custom_modules_get

Name	Datatype	Description
name	string
ancestorModule	string
cloudProvider	string	(CLOUD_PROVIDER_UNSPECIFIED, GOOGLE_CLOUD_PLATFORM, AMAZON_WEB_SERVICES, MICROSOFT_AZURE)
config	object
description	string
displayName	string
enablementState	string	(ENABLEMENT_STATE_UNSPECIFIED, ENABLED, DISABLED, INHERITED)
lastEditor	string
type	string
updateTime	string (google-datetime)

projects_event_threat_detection_settings_custom_modules_get

Name	Datatype	Description
name	string
ancestorModule	string
cloudProvider	string	(CLOUD_PROVIDER_UNSPECIFIED, GOOGLE_CLOUD_PLATFORM, AMAZON_WEB_SERVICES, MICROSOFT_AZURE)
config	object
description	string
displayName	string
enablementState	string	(ENABLEMENT_STATE_UNSPECIFIED, ENABLED, DISABLED, INHERITED)
lastEditor	string
type	string
updateTime	string (google-datetime)

folders_event_threat_detection_settings_custom_modules_get

Name	Datatype	Description
name	string
ancestorModule	string
cloudProvider	string	(CLOUD_PROVIDER_UNSPECIFIED, GOOGLE_CLOUD_PLATFORM, AMAZON_WEB_SERVICES, MICROSOFT_AZURE)
config	object
description	string
displayName	string
enablementState	string	(ENABLEMENT_STATE_UNSPECIFIED, ENABLED, DISABLED, INHERITED)
lastEditor	string
type	string
updateTime	string (google-datetime)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_event_threat_detection_settings_custom_modules_get	select	organizationsId, customModulesId
projects_event_threat_detection_settings_custom_modules_get	select	projectsId, customModulesId
folders_event_threat_detection_settings_custom_modules_get	select	foldersId, customModulesId
organizations_event_threat_detection_settings_custom_modules_patch	update	organizationsId, customModulesId	updateMask
organizations_security_health_analytics_settings_custom_modules_patch	update	organizationsId, customModulesId	updateMask
projects_security_health_analytics_settings_custom_modules_patch	update	projectsId, customModulesId	updateMask
projects_event_threat_detection_settings_custom_modules_patch	update	projectsId, customModulesId	updateMask
folders_security_health_analytics_settings_custom_modules_patch	update	foldersId, customModulesId	updateMask
folders_event_threat_detection_settings_custom_modules_patch	update	foldersId, customModulesId	updateMask
organizations_security_health_analytics_settings_custom_modules_simulate	exec	organizationsId
projects_security_health_analytics_settings_custom_modules_simulate	exec	projectsId
folders_security_health_analytics_settings_custom_modules_simulate	exec	foldersId

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

organizations_event_threat_detection_settings_custom_modules_get

Successful response

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

projects_event_threat_detection_settings_custom_modules_get

Successful response

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

folders_event_threat_detection_settings_custom_modules_get

Successful response

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

UPDATE examples

organizations_event_threat_detection_settings_custom_modules_patch

No description available.

UPDATE google.securitycenter.custom_modules
SET 
data__name = '{{ name }}',
data__config = '{{ config }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__type = '{{ type }}',
data__cloudProvider = '{{ cloudProvider }}',
data__enablementState = '{{ enablementState }}'
WHERE 
organizationsId = '{{ organizationsId }}' --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

No description available.

UPDATE google.securitycenter.custom_modules
SET 
data__displayName = '{{ displayName }}',
data__enablementState = '{{ enablementState }}',
data__name = '{{ name }}',
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;

projects_security_health_analytics_settings_custom_modules_patch

No description available.

UPDATE google.securitycenter.custom_modules
SET 
data__displayName = '{{ displayName }}',
data__enablementState = '{{ enablementState }}',
data__name = '{{ name }}',
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

No description available.

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

folders_security_health_analytics_settings_custom_modules_patch

No description available.

UPDATE google.securitycenter.custom_modules
SET 
data__displayName = '{{ displayName }}',
data__enablementState = '{{ enablementState }}',
data__name = '{{ name }}',
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

No description available.

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

Lifecycle Methods

organizations_security_health_analytics_settings_custom_modules_simulate

Successful response

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

projects_security_health_analytics_settings_custom_modules_simulate

Successful response

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

folders_security_health_analytics_settings_custom_modules_simulate

Successful response

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