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

Name	Datatype	Description
name	string
ancestorModule	string
cloudProvider	string	(CLOUD_PROVIDER_UNSPECIFIED, GOOGLE_CLOUD_PLATFORM, AMAZON_WEB_SERVICES, MICROSOFT_AZURE)
customConfig	object	(id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string
enablementState	string	(ENABLEMENT_STATE_UNSPECIFIED, ENABLED, DISABLED, INHERITED)
lastEditor	string
updateTime	string (google-datetime)

organizations_security_health_analytics_settings_custom_modules_get

Name	Datatype	Description
name	string
ancestorModule	string
cloudProvider	string	(CLOUD_PROVIDER_UNSPECIFIED, GOOGLE_CLOUD_PLATFORM, AMAZON_WEB_SERVICES, MICROSOFT_AZURE)
customConfig	object	(id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string
enablementState	string	(ENABLEMENT_STATE_UNSPECIFIED, ENABLED, DISABLED, INHERITED)
lastEditor	string
updateTime	string (google-datetime)

projects_security_health_analytics_settings_custom_modules_get

Name	Datatype	Description
name	string
ancestorModule	string
cloudProvider	string	(CLOUD_PROVIDER_UNSPECIFIED, GOOGLE_CLOUD_PLATFORM, AMAZON_WEB_SERVICES, MICROSOFT_AZURE)
customConfig	object	(id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string
enablementState	string	(ENABLEMENT_STATE_UNSPECIFIED, ENABLED, DISABLED, INHERITED)
lastEditor	string
updateTime	string (google-datetime)

folders_security_health_analytics_settings_custom_modules_list

Name	Datatype	Description
name	string
ancestorModule	string
cloudProvider	string	(CLOUD_PROVIDER_UNSPECIFIED, GOOGLE_CLOUD_PLATFORM, AMAZON_WEB_SERVICES, MICROSOFT_AZURE)
customConfig	object	(id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string
enablementState	string	(ENABLEMENT_STATE_UNSPECIFIED, ENABLED, DISABLED, INHERITED)
lastEditor	string
updateTime	string (google-datetime)

organizations_security_health_analytics_settings_custom_modules_list

Name	Datatype	Description
name	string
ancestorModule	string
cloudProvider	string	(CLOUD_PROVIDER_UNSPECIFIED, GOOGLE_CLOUD_PLATFORM, AMAZON_WEB_SERVICES, MICROSOFT_AZURE)
customConfig	object	(id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string
enablementState	string	(ENABLEMENT_STATE_UNSPECIFIED, ENABLED, DISABLED, INHERITED)
lastEditor	string
updateTime	string (google-datetime)

projects_security_health_analytics_settings_custom_modules_list

Name	Datatype	Description
name	string
ancestorModule	string
cloudProvider	string	(CLOUD_PROVIDER_UNSPECIFIED, GOOGLE_CLOUD_PLATFORM, AMAZON_WEB_SERVICES, MICROSOFT_AZURE)
customConfig	object	(id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string
enablementState	string	(ENABLEMENT_STATE_UNSPECIFIED, ENABLED, DISABLED, INHERITED)
lastEditor	string
updateTime	string (google-datetime)

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
organizations_security_health_analytics_settings_custom_modules_get	select	organizationsId, customModulesId
projects_security_health_analytics_settings_custom_modules_get	select	projectsId, customModulesId
folders_security_health_analytics_settings_custom_modules_list	select	foldersId	pageSize, pageToken
organizations_security_health_analytics_settings_custom_modules_list	select	organizationsId	pageSize, pageToken
projects_security_health_analytics_settings_custom_modules_list	select	projectsId	pageSize, pageToken
folders_security_health_analytics_settings_custom_modules_create	insert	foldersId
organizations_security_health_analytics_settings_custom_modules_create	insert	organizationsId
projects_security_health_analytics_settings_custom_modules_create	insert	projectsId
folders_security_health_analytics_settings_custom_modules_delete	delete	foldersId, customModulesId
organizations_security_health_analytics_settings_custom_modules_delete	delete	organizationsId, customModulesId
projects_security_health_analytics_settings_custom_modules_delete	delete	projectsId, customModulesId

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

Successful response

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

organizations_security_health_analytics_settings_custom_modules_get

Successful response

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

projects_security_health_analytics_settings_custom_modules_get

Successful response

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

folders_security_health_analytics_settings_custom_modules_list

Successful response

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 }}'
;

organizations_security_health_analytics_settings_custom_modules_list

Successful response

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 }}'
;

projects_security_health_analytics_settings_custom_modules_list

Successful response

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 }}'
;

INSERT examples

folders_security_health_analytics_settings_custom_modules_create

No description available.

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

organizations_security_health_analytics_settings_custom_modules_create

No description available.

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

projects_security_health_analytics_settings_custom_modules_create

No description available.

INSERT INTO google.securitycenter.security_health_analytics_modules (
data__cloudProvider,
data__customConfig,
data__displayName,
data__enablementState,
data__name,
projectsId
)
SELECT 
'{{ cloudProvider }}',
'{{ customConfig }}',
'{{ displayName }}',
'{{ enablementState }}',
'{{ name }}',
'{{ projectsId }}'
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: "{{ foldersId }}"
    description: Required parameter for the security_health_analytics_modules resource.
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the security_health_analytics_modules resource.
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the security_health_analytics_modules resource.
  - name: cloudProvider
    value: "{{ cloudProvider }}"
    valid_values: ['CLOUD_PROVIDER_UNSPECIFIED', 'GOOGLE_CLOUD_PLATFORM', 'AMAZON_WEB_SERVICES', 'MICROSOFT_AZURE']
  - name: customConfig
    value:
      customOutput:
        properties:
          - name: "{{ name }}"
            valueExpression:
              description: "{{ description }}"
              expression: "{{ expression }}"
              location: "{{ location }}"
              title: "{{ title }}"
      description: "{{ description }}"
      predicate:
        description: "{{ description }}"
        expression: "{{ expression }}"
        location: "{{ location }}"
        title: "{{ title }}"
      recommendation: "{{ recommendation }}"
      resourceSelector:
        resourceTypes:
          - "{{ resourceTypes }}"
      severity: "{{ severity }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: enablementState
    value: "{{ enablementState }}"
    valid_values: ['ENABLEMENT_STATE_UNSPECIFIED', 'ENABLED', 'DISABLED', 'INHERITED']
  - name: name
    value: "{{ name }}"

DELETE examples

folders_security_health_analytics_settings_custom_modules_delete

No description available.

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

organizations_security_health_analytics_settings_custom_modules_delete

No description available.

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

projects_security_health_analytics_settings_custom_modules_delete

No description available.

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