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

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.
customConfig	object	Defines 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.
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	Output only. The time at which the custom module was last updated.

Methods

Name	Accessible by	Required Params	Description
folders_security_health_analytics_settings_custom_modules_get	SELECT	customModulesId, foldersId	Retrieves a SecurityHealthAnalyticsCustomModule.
folders_security_health_analytics_settings_custom_modules_list	SELECT	foldersId	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_get	SELECT	customModulesId, organizationsId	Retrieves a SecurityHealthAnalyticsCustomModule.
organizations_security_health_analytics_settings_custom_modules_list	SELECT	organizationsId	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_get	SELECT	customModulesId, projectsId	Retrieves a SecurityHealthAnalyticsCustomModule.
projects_security_health_analytics_settings_custom_modules_list	SELECT	projectsId	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.
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.
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.
folders_security_health_analytics_settings_custom_modules_delete	DELETE	customModulesId, foldersId	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	customModulesId, organizationsId	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	customModulesId, projectsId	Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

SELECT examples

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,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime
FROM google.securitycenter.security_health_analytics_modules
WHERE foldersId = '{{ foldersId }}';

INSERT example

Use the following StackQL query and manifest file to create a new security_health_analytics_modules resource.

All Properties

/*+ create */
INSERT INTO google.securitycenter.security_health_analytics_modules (
foldersId,
name,
displayName,
enablementState,
customConfig
)
SELECT 
'{{ foldersId }}',
'{{ name }}',
'{{ displayName }}',
'{{ enablementState }}',
'{{ customConfig }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: enablementState
      value: string
    - name: updateTime
      value: string
    - name: lastEditor
      value: string
    - name: ancestorModule
      value: string
    - name: customConfig
      value:
        - name: predicate
          value:
            - name: expression
              value: string
            - name: title
              value: string
            - name: description
              value: string
            - name: location
              value: string
        - name: customOutput
          value:
            - name: properties
              value:
                - - name: name
                    value: string
        - name: resourceSelector
          value:
            - name: resourceTypes
              value:
                - string
        - name: severity
          value: string
        - name: description
          value: string
        - name: recommendation
          value: string

DELETE example

Deletes the specified security_health_analytics_modules resource.

/*+ delete */
DELETE FROM google.securitycenter.security_health_analytics_modules
WHERE customModulesId = '{{ customModulesId }}'
AND foldersId = '{{ foldersId }}';