security_health_analytics_modules

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

Overview

Name	security_health_analytics_modules
Type	Resource
Id	google.securitycenter.security_health_analytics_modules

Fields

The following fields are returned by SELECT queries:

folders_security_health_analytics_settings_custom_modules_get

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
ancestorModule	string	Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	The user specified custom configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementState	string	The enablement state of the custom module.
lastEditor	string	Output only. The editor that last updated the custom module.
updateTime	string (google-datetime)	Output only. The time at which the custom module was last updated.

projects_security_health_analytics_settings_custom_modules_get

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
ancestorModule	string	Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	The user specified custom configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementState	string	The enablement state of the custom module.
lastEditor	string	Output only. The editor that last updated the custom module.
updateTime	string (google-datetime)	Output only. The time at which the custom module was last updated.

organizations_security_health_analytics_settings_custom_modules_get

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
ancestorModule	string	Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	The user specified custom configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementState	string	The enablement state of the custom module.
lastEditor	string	Output only. The editor that last updated the custom module.
updateTime	string (google-datetime)	Output only. The time at which the custom module was last updated.

folders_security_health_analytics_settings_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
ancestorModule	string	Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	The user specified custom configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementState	string	The enablement state of the custom module.
lastEditor	string	Output only. The editor that last updated the custom module.
updateTime	string (google-datetime)	Output only. The time at which the custom module was last updated.

projects_security_health_analytics_settings_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
ancestorModule	string	Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	The user specified custom configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementState	string	The enablement state of the custom module.
lastEditor	string	Output only. The editor that last updated the custom module.
updateTime	string (google-datetime)	Output only. The time at which the custom module was last updated.

organizations_security_health_analytics_settings_custom_modules_list

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
ancestorModule	string	Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	The user specified custom configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementState	string	The enablement state of the custom module.
lastEditor	string	Output only. The editor that last updated the custom module.
updateTime	string (google-datetime)	Output only. The time at which the custom module was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
folders_security_health_analytics_settings_custom_modules_get	select	foldersId, customModulesId		Retrieves a SecurityHealthAnalyticsCustomModule.
projects_security_health_analytics_settings_custom_modules_get	select	projectsId, customModulesId		Retrieves a SecurityHealthAnalyticsCustomModule.
organizations_security_health_analytics_settings_custom_modules_get	select	organizationsId, customModulesId		Retrieves a SecurityHealthAnalyticsCustomModule.
folders_security_health_analytics_settings_custom_modules_list	select	foldersId	pageSize, pageToken	Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
projects_security_health_analytics_settings_custom_modules_list	select	projectsId	pageSize, pageToken	Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
organizations_security_health_analytics_settings_custom_modules_list	select	organizationsId	pageSize, pageToken	Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
folders_security_health_analytics_settings_custom_modules_create	insert	foldersId		Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
projects_security_health_analytics_settings_custom_modules_create	insert	projectsId		Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
organizations_security_health_analytics_settings_custom_modules_create	insert	organizationsId		Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
folders_security_health_analytics_settings_custom_modules_delete	delete	foldersId, customModulesId		Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
projects_security_health_analytics_settings_custom_modules_delete	delete	projectsId, customModulesId		Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
organizations_security_health_analytics_settings_custom_modules_delete	delete	organizationsId, customModulesId		Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

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
pageSize	integer (int32)
pageToken	string

SELECT examples

folders_security_health_analytics_settings_custom_modules_get

Retrieves a SecurityHealthAnalyticsCustomModule.

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

projects_security_health_analytics_settings_custom_modules_get

Retrieves a SecurityHealthAnalyticsCustomModule.

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

organizations_security_health_analytics_settings_custom_modules_get

Retrieves a SecurityHealthAnalyticsCustomModule.

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

folders_security_health_analytics_settings_custom_modules_list

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

SELECT
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime
FROM google.securitycenter.security_health_analytics_modules
WHERE foldersId = '{{ foldersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_security_health_analytics_settings_custom_modules_list

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

SELECT
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime
FROM google.securitycenter.security_health_analytics_modules
WHERE projectsId = '{{ projectsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

organizations_security_health_analytics_settings_custom_modules_list

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

SELECT
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime
FROM google.securitycenter.security_health_analytics_modules
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

folders_security_health_analytics_settings_custom_modules_create

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.

INSERT INTO google.securitycenter.security_health_analytics_modules (
data__name,
data__displayName,
data__enablementState,
data__customConfig,
data__cloudProvider,
foldersId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ enablementState }}',
'{{ customConfig }}',
'{{ cloudProvider }}',
'{{ foldersId }}'
RETURNING
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime
;

projects_security_health_analytics_settings_custom_modules_create

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.

INSERT INTO google.securitycenter.security_health_analytics_modules (
data__name,
data__displayName,
data__enablementState,
data__customConfig,
data__cloudProvider,
projectsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ enablementState }}',
'{{ customConfig }}',
'{{ cloudProvider }}',
'{{ projectsId }}'
RETURNING
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime
;

organizations_security_health_analytics_settings_custom_modules_create

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.

INSERT INTO google.securitycenter.security_health_analytics_modules (
data__name,
data__displayName,
data__enablementState,
data__customConfig,
data__cloudProvider,
organizationsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ enablementState }}',
'{{ customConfig }}',
'{{ cloudProvider }}',
'{{ organizationsId }}'
RETURNING
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: security_health_analytics_modules
  props:
    - name: foldersId
      value: string
      description: Required parameter for the security_health_analytics_modules resource.
    - name: projectsId
      value: string
      description: Required parameter for the security_health_analytics_modules resource.
    - name: organizationsId
      value: string
      description: Required parameter for the security_health_analytics_modules resource.
    - name: name
      value: string
      description: >
        Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
        
    - name: displayName
      value: string
      description: >
        The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
        
    - name: enablementState
      value: string
      description: >
        The enablement state of the custom module.
        
      valid_values: ['ENABLEMENT_STATE_UNSPECIFIED', 'ENABLED', 'DISABLED', 'INHERITED']
    - name: customConfig
      value: object
      description: >
        The user specified custom configuration for the module.
        
    - name: cloudProvider
      value: string
      description: >
        The cloud provider of the custom module.
        
      valid_values: ['CLOUD_PROVIDER_UNSPECIFIED', 'GOOGLE_CLOUD_PLATFORM', 'AMAZON_WEB_SERVICES', 'MICROSOFT_AZURE']

DELETE examples

folders_security_health_analytics_settings_custom_modules_delete

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

DELETE FROM google.securitycenter.security_health_analytics_modules
WHERE foldersId = '{{ foldersId }}' --required
AND customModulesId = '{{ customModulesId }}' --required;

projects_security_health_analytics_settings_custom_modules_delete

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

DELETE FROM google.securitycenter.security_health_analytics_modules
WHERE projectsId = '{{ projectsId }}' --required
AND customModulesId = '{{ customModulesId }}' --required;

organizations_security_health_analytics_settings_custom_modules_delete

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

DELETE FROM google.securitycenter.security_health_analytics_modules
WHERE organizationsId = '{{ organizationsId }}' --required
AND customModulesId = '{{ customModulesId }}' --required;