aws_guardduty_detectors Resource

[edit on GitHub]

Use the aws_guardduty_detectors InSpec audit resource to test properties of some or all AWS GuardDuty Detectors.

For additional information, including details on parameters and properties, see the Actions, Resources, and Condition Keys for Amazon GuardDuty.

For additional information, including details on parameters and properties, see the AWS documentation on GuardDuty Detectors.

Requirements

Train AWS version 0.1.18 or newer is required for this resource.

Installation

This resource is available in the Chef InSpec AWS resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your AWS environment for InSpec and creating an InSpec profile that uses the InSpec AWS resource pack.

Syntax

Ensure you have exactly 3 Detectors available to you.

describe aws_guardduty_detectors do
  its('detector_ids.count') { should cmp 3 }
end

Parameters

This resource does not require any parameters.

Properties

detector_ids

A list of detector IDs.

Examples

Ensure GuardDuty Detector ID exists.

describe aws_guardduty_detectors do
  its('detector_ids') { should include ['detector-id-43542'] }
end

Use the InSpec resource to request the IDs of all Detectors, then test in-depth using aws_guardduty_detector to ensure all detectors have a six hour publishing frequency.

aws_guardduty_detectors.detector_ids.first.each do |detector_id|
  describe aws_guardduty_detector(detector_id: detector_id) do
    it { should exist }
    its('finding_publishing_frequency') { should eq "SIX_HOURS" }
  end
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exist

The control will pass if the describe returns at least one result.

Use should_not to test the entity should not exist.

describe aws_guardduty_detectors do
  it { should exist }
end

describe aws_guardduty_detectors do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the GuardDuty:Client:GetDetectorResponse action with Effect set to Allow.