effective_custom_modules

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

Overview

Name	effective_custom_modules
Type	Resource
Id	google.securitycenter.effective_custom_modules

Fields

The following fields are returned by SELECT queries:

folders_security_health_analytics_settings_effective_custom_modules_get

Successful response

Name	Datatype	Description
name	string	Output 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}"
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	Output only. The user-specified configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	Output 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.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.

folders_event_threat_detection_settings_effective_custom_modules_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the effective ETD custom module. Its format is: * organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
cloudProvider	string	The cloud provider of the custom module.
config	object	Output only. Config for the effective module.
description	string	Output only. The description for the module.
displayName	string	Output only. The human readable name to be displayed for the module.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.
type	string	Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.

projects_security_health_analytics_settings_effective_custom_modules_get

Successful response

Name	Datatype	Description
name	string	Output 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}"
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	Output only. The user-specified configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	Output 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.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.

projects_event_threat_detection_settings_effective_custom_modules_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the effective ETD custom module. Its format is: * organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
cloudProvider	string	The cloud provider of the custom module.
config	object	Output only. Config for the effective module.
description	string	Output only. The description for the module.
displayName	string	Output only. The human readable name to be displayed for the module.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.
type	string	Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.

organizations_security_health_analytics_settings_effective_custom_modules_get

Successful response

Name	Datatype	Description
name	string	Output 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}"
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	Output only. The user-specified configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	Output 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.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.

organizations_event_threat_detection_settings_effective_custom_modules_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the effective ETD custom module. Its format is: * organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
cloudProvider	string	The cloud provider of the custom module.
config	object	Output only. Config for the effective module.
description	string	Output only. The description for the module.
displayName	string	Output only. The human readable name to be displayed for the module.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.
type	string	Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.

folders_security_health_analytics_settings_effective_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Output 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}"
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	Output only. The user-specified configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	Output 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.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.

folders_event_threat_detection_settings_effective_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the effective ETD custom module. Its format is: * organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
cloudProvider	string	The cloud provider of the custom module.
config	object	Output only. Config for the effective module.
description	string	Output only. The description for the module.
displayName	string	Output only. The human readable name to be displayed for the module.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.
type	string	Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.

projects_security_health_analytics_settings_effective_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Output 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}"
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	Output only. The user-specified configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	Output 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.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.

projects_event_threat_detection_settings_effective_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the effective ETD custom module. Its format is: * organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
cloudProvider	string	The cloud provider of the custom module.
config	object	Output only. Config for the effective module.
description	string	Output only. The description for the module.
displayName	string	Output only. The human readable name to be displayed for the module.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.
type	string	Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.

organizations_security_health_analytics_settings_effective_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Output 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}"
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	Output only. The user-specified configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	Output 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.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.

organizations_event_threat_detection_settings_effective_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the effective ETD custom module. Its format is: * organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
cloudProvider	string	The cloud provider of the custom module.
config	object	Output only. Config for the effective module.
description	string	Output only. The description for the module.
displayName	string	Output only. The human readable name to be displayed for the module.
enablementState	string	Output only. The effective state of enablement for the module at the given level of the hierarchy.
type	string	Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
folders_security_health_analytics_settings_effective_custom_modules_get	select	foldersId, effectiveCustomModulesId		Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
folders_event_threat_detection_settings_effective_custom_modules_get	select	foldersId, effectiveCustomModulesId		Gets an effective Event Threat Detection custom module at the given level.
projects_security_health_analytics_settings_effective_custom_modules_get	select	projectsId, effectiveCustomModulesId		Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
projects_event_threat_detection_settings_effective_custom_modules_get	select	projectsId, effectiveCustomModulesId		Gets an effective Event Threat Detection custom module at the given level.
organizations_security_health_analytics_settings_effective_custom_modules_get	select	organizationsId, effectiveCustomModulesId		Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
organizations_event_threat_detection_settings_effective_custom_modules_get	select	organizationsId, effectiveCustomModulesId		Gets an effective Event Threat Detection custom module at the given level.
folders_security_health_analytics_settings_effective_custom_modules_list	select	foldersId	pageSize, pageToken	Returns 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.
folders_event_threat_detection_settings_effective_custom_modules_list	select	foldersId	pageToken, pageSize	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.
projects_security_health_analytics_settings_effective_custom_modules_list	select	projectsId	pageSize, pageToken	Returns 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_list	select	projectsId	pageToken, pageSize	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.
organizations_security_health_analytics_settings_effective_custom_modules_list	select	organizationsId	pageSize, pageToken	Returns 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_list	select	organizationsId	pageToken, pageSize	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.

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
effectiveCustomModulesId	string
foldersId	string
organizationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

folders_security_health_analytics_settings_effective_custom_modules_get

Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.

SELECT
name,
cloudProvider,
customConfig,
displayName,
enablementState
FROM google.securitycenter.effective_custom_modules
WHERE foldersId = '{{ foldersId }}' -- required
AND effectiveCustomModulesId = '{{ effectiveCustomModulesId }}' -- required;

folders_event_threat_detection_settings_effective_custom_modules_get

Gets an effective Event Threat Detection custom module at the given level.

SELECT
name,
cloudProvider,
config,
description,
displayName,
enablementState,
type
FROM google.securitycenter.effective_custom_modules
WHERE foldersId = '{{ foldersId }}' -- required
AND effectiveCustomModulesId = '{{ effectiveCustomModulesId }}' -- required;

projects_security_health_analytics_settings_effective_custom_modules_get

Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.

SELECT
name,
cloudProvider,
customConfig,
displayName,
enablementState
FROM google.securitycenter.effective_custom_modules
WHERE projectsId = '{{ projectsId }}' -- required
AND effectiveCustomModulesId = '{{ effectiveCustomModulesId }}' -- required;

projects_event_threat_detection_settings_effective_custom_modules_get

Gets an effective Event Threat Detection custom module at the given level.

SELECT
name,
cloudProvider,
config,
description,
displayName,
enablementState,
type
FROM google.securitycenter.effective_custom_modules
WHERE projectsId = '{{ projectsId }}' -- required
AND effectiveCustomModulesId = '{{ effectiveCustomModulesId }}' -- required;

organizations_security_health_analytics_settings_effective_custom_modules_get

Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.

SELECT
name,
cloudProvider,
customConfig,
displayName,
enablementState
FROM google.securitycenter.effective_custom_modules
WHERE organizationsId = '{{ organizationsId }}' -- required
AND effectiveCustomModulesId = '{{ effectiveCustomModulesId }}' -- required;

organizations_event_threat_detection_settings_effective_custom_modules_get

Gets an effective Event Threat Detection custom module at the given level.

SELECT
name,
cloudProvider,
config,
description,
displayName,
enablementState,
type
FROM google.securitycenter.effective_custom_modules
WHERE organizationsId = '{{ organizationsId }}' -- required
AND effectiveCustomModulesId = '{{ effectiveCustomModulesId }}' -- required;

folders_security_health_analytics_settings_effective_custom_modules_list

Returns 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
name,
cloudProvider,
customConfig,
displayName,
enablementState
FROM google.securitycenter.effective_custom_modules
WHERE foldersId = '{{ foldersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

folders_event_threat_detection_settings_effective_custom_modules_list

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,
cloudProvider,
config,
description,
displayName,
enablementState,
type
FROM google.securitycenter.effective_custom_modules
WHERE foldersId = '{{ foldersId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

projects_security_health_analytics_settings_effective_custom_modules_list

Returns 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
name,
cloudProvider,
customConfig,
displayName,
enablementState
FROM google.securitycenter.effective_custom_modules
WHERE projectsId = '{{ projectsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_event_threat_detection_settings_effective_custom_modules_list

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,
cloudProvider,
config,
description,
displayName,
enablementState,
type
FROM google.securitycenter.effective_custom_modules
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

organizations_security_health_analytics_settings_effective_custom_modules_list

Returns 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
name,
cloudProvider,
customConfig,
displayName,
enablementState
FROM google.securitycenter.effective_custom_modules
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

organizations_event_threat_detection_settings_effective_custom_modules_list

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,
cloudProvider,
config,
description,
displayName,
enablementState,
type
FROM google.securitycenter.effective_custom_modules
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';