malware_scan_settings

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

Overview

Name	malware_scan_settings
Type	Resource
Id	aws.guardduty.malware_scan_settings

Fields

The following fields are returned by SELECT queries:

get_malware_scan_settings

Name	Datatype	Description
ebs_snapshot_preservation	string	An enum value representing possible snapshot preservation settings. (NO_RETENTION, RETENTION_WITH_FINDING)
scan_resource_criteria	object	Represents the criteria to be used in the filter for scanning resources.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_malware_scan_settings	select	detector_id, region		Returns the details of the malware scan settings. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
update_malware_scan_settings	update	detector_id, region		Updates the malware scan settings. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

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
detector_id	string	The unique ID of the detector that specifies the GuardDuty service where you want to update scan settings. To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
region	string	AWS region (default: us-east-1)

SELECT examples

get_malware_scan_settings

Returns the details of the malware scan settings. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

SELECT
ebs_snapshot_preservation,
scan_resource_criteria
FROM aws.guardduty.malware_scan_settings
WHERE detector_id = '{{ detector_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_malware_scan_settings

Updates the malware scan settings. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

UPDATE aws.guardduty.malware_scan_settings
SET 
ScanResourceCriteria = '{{ ScanResourceCriteria }}',
EbsSnapshotPreservation = '{{ EbsSnapshotPreservation }}'
WHERE 
detector_id = '{{ detector_id }}' --required
AND region = '{{ region }}' --required;