mute_configs

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

Overview

Name	mute_configs
Type	Resource
Id	google.securitycenter.mute_configs

Fields

Name	Datatype	Description
name	string	This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{mute_config} folders/{folder}/muteConfigs/{mute_config} projects/{project}/muteConfigs/{mute_config} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}
description	string	A description of the mute config.
createTime	string	Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
displayName	string	The human readable name to be displayed for the mute config.
expiryTime	string	Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
filter	string	Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: severity: =, : category: =, : resource.name: =, : resource.project_name: =, : resource.project_display_name: =, : resource.folders.resource_folder: =, : resource.parent_name: =, : resource.parent_display_name: =, : resource.type: =, : finding_class: =, : indicator.ip_addresses: =, : indicator.domains: =, :
mostRecentEditor	string	Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
type	string	Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
updateTime	string	Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.

Methods

Name	Accessible by	Required Params	Description
folders_locations_mute_configs_get	SELECT	foldersId, locationsId, muteConfigsId	Gets a mute config.
folders_locations_mute_configs_list	SELECT	foldersId, locationsId	Lists mute configs.
folders_mute_configs_get	SELECT	foldersId, muteConfigsId	Gets a mute config.
folders_mute_configs_list	SELECT	foldersId	Lists mute configs.
organizations_locations_mute_configs_get	SELECT	locationsId, muteConfigsId, organizationsId	Gets a mute config.
organizations_locations_mute_configs_list	SELECT	locationsId, organizationsId	Lists mute configs.
organizations_mute_configs_get	SELECT	muteConfigsId, organizationsId	Gets a mute config.
organizations_mute_configs_list	SELECT	organizationsId	Lists mute configs.
projects_locations_mute_configs_get	SELECT	locationsId, muteConfigsId, projectsId	Gets a mute config.
projects_locations_mute_configs_list	SELECT	locationsId, projectsId	Lists mute configs.
projects_mute_configs_get	SELECT	muteConfigsId, projectsId	Gets a mute config.
projects_mute_configs_list	SELECT	projectsId	Lists mute configs.
folders_locations_mute_configs_create	INSERT	foldersId, locationsId	Creates a mute config.
folders_mute_configs_create	INSERT	foldersId	Creates a mute config.
organizations_locations_mute_configs_create	INSERT	locationsId, organizationsId	Creates a mute config.
organizations_mute_configs_create	INSERT	organizationsId	Creates a mute config.
projects_locations_mute_configs_create	INSERT	locationsId, projectsId	Creates a mute config.
projects_mute_configs_create	INSERT	projectsId	Creates a mute config.
folders_locations_mute_configs_delete	DELETE	foldersId, locationsId, muteConfigsId	Deletes an existing mute config.
folders_mute_configs_delete	DELETE	foldersId, muteConfigsId	Deletes an existing mute config.
organizations_locations_mute_configs_delete	DELETE	locationsId, muteConfigsId, organizationsId	Deletes an existing mute config.
organizations_mute_configs_delete	DELETE	muteConfigsId, organizationsId	Deletes an existing mute config.
projects_locations_mute_configs_delete	DELETE	locationsId, muteConfigsId, projectsId	Deletes an existing mute config.
projects_mute_configs_delete	DELETE	muteConfigsId, projectsId	Deletes an existing mute config.
folders_locations_mute_configs_patch	UPDATE	foldersId, locationsId, muteConfigsId	Updates a mute config.
folders_mute_configs_patch	UPDATE	foldersId, muteConfigsId	Updates a mute config.
organizations_locations_mute_configs_patch	UPDATE	locationsId, muteConfigsId, organizationsId	Updates a mute config.
organizations_mute_configs_patch	UPDATE	muteConfigsId, organizationsId	Updates a mute config.
projects_locations_mute_configs_patch	UPDATE	locationsId, muteConfigsId, projectsId	Updates a mute config.
projects_mute_configs_patch	UPDATE	muteConfigsId, projectsId	Updates a mute config.

SELECT examples

Lists mute configs.

SELECT
name,
description,
createTime,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
FROM google.securitycenter.mute_configs
WHERE foldersId = '{{ foldersId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.securitycenter.mute_configs (
foldersId,
name,
displayName,
description,
filter,
type,
expiryTime
)
SELECT 
'{{ foldersId }}',
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ filter }}',
'{{ type }}',
'{{ expiryTime }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: description
      value: string
    - name: filter
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: mostRecentEditor
      value: string
    - name: type
      value: string
    - name: expiryTime
      value: string

UPDATE example

Updates a mute_configs resource.

/*+ update */
UPDATE google.securitycenter.mute_configs
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
filter = '{{ filter }}',
type = '{{ type }}',
expiryTime = '{{ expiryTime }}'
WHERE 
foldersId = '{{ foldersId }}'
AND muteConfigsId = '{{ muteConfigsId }}';

DELETE example

Deletes the specified mute_configs resource.

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