Add GuardDuty filter resource #14876

gdavison · 2020-08-27T19:20:15Z

Completes work done in #10676 by @graffzon and @suzuki-shunsuke to add GuardDuty filter resource

Community Note

Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Release note for CHANGELOG:

**New Resource:** `aws_guardduty_filter `

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccAWSGuardDuty_serial/Filter'

--- PASS: TestAccAWSGuardDuty_serial (212.02s)
    --- PASS: TestAccAWSGuardDuty_serial/Filter (212.02s)
        --- PASS: TestAccAWSGuardDuty_serial/Filter/update (52.53s)
        --- PASS: TestAccAWSGuardDuty_serial/Filter/tags (72.38s)
        --- PASS: TestAccAWSGuardDuty_serial/Filter/disappears (28.38s)
        --- PASS: TestAccAWSGuardDuty_serial/Filter/basic (58.73s)

Merging master into feature branch

…ndition

#10676 (comment)

# Conflicts: # aws/provider.go # website/aws.erb

bflad

Just some minor items to consider, otherwise looking good! 🚀

Output from acceptance testing:

    --- PASS: TestAccAWSGuardDuty_serial/Filter (102.51s)
        --- PASS: TestAccAWSGuardDuty_serial/Filter/update (26.72s)
        --- PASS: TestAccAWSGuardDuty_serial/Filter/tags (33.67s)
        --- PASS: TestAccAWSGuardDuty_serial/Filter/disappears (16.50s)
        --- PASS: TestAccAWSGuardDuty_serial/Filter/basic (25.62s)

bflad · 2020-09-01T00:13:58Z

aws/resource_aws_guardduty_filter.go

+	input := guardduty.UpdateFilterInput{
+		Action:      aws.String(d.Get("action").(string)),
+		Description: aws.String(d.Get("description").(string)),
+		DetectorId:  aws.String(d.Get("detector_id").(string)),
+		FilterName:  aws.String(d.Get("name").(string)),
+		Rank:        aws.Int64(int64(d.Get("rank").(int))),
+	}
+
+	var err error
+	input.FindingCriteria, err = expandFindingCriteria(d.Get("finding_criteria").([]interface{}))
+	if err != nil {
+		return err
+	}
+
+	log.Printf("[DEBUG] Updating GuardDuty Filter: %s", input)
+
+	_, err = conn.UpdateFilter(&input)
+	if err != nil {
+		return fmt.Errorf("error updating GuardDuty Filter %s: %w", d.Id(), err)
+	}


To prevent the UpdateFilter API call when only tags are updated, this logic should be wrapped with d.HasChanges():

Suggested change

input := guardduty.UpdateFilterInput{

Action: aws.String(d.Get("action").(string)),

Description: aws.String(d.Get("description").(string)),

DetectorId: aws.String(d.Get("detector_id").(string)),

FilterName: aws.String(d.Get("name").(string)),

Rank: aws.Int64(int64(d.Get("rank").(int))),

}

var err error

input.FindingCriteria, err = expandFindingCriteria(d.Get("finding_criteria").([]interface{}))

if err != nil {

return err

}

log.Printf("[DEBUG] Updating GuardDuty Filter: %s", input)

_, err = conn.UpdateFilter(&input)

if err != nil {

return fmt.Errorf("error updating GuardDuty Filter %s: %w", d.Id(), err)

}

if d.HasChanges("action", "description", "finding_criteria", "rank") {

input := guardduty.UpdateFilterInput{

Action: aws.String(d.Get("action").(string)),

Description: aws.String(d.Get("description").(string)),

DetectorId: aws.String(d.Get("detector_id").(string)),

FilterName: aws.String(d.Get("name").(string)),

Rank: aws.Int64(int64(d.Get("rank").(int))),

}

var err error

input.FindingCriteria, err = expandFindingCriteria(d.Get("finding_criteria").([]interface{}))

if err != nil {

return err

}

log.Printf("[DEBUG] Updating GuardDuty Filter: %s", input)

_, err = conn.UpdateFilter(&input)

if err != nil {

return fmt.Errorf("error updating GuardDuty Filter %s: %w", d.Id(), err)

}

}

bflad · 2020-09-01T00:17:08Z

aws/resource_aws_guardduty_filter.go

+}
+
+func joinGuardDutyFilterID(detectorID, filterName string) string {
+	return detectorID + "_" + filterName


If we would like consistency with the other GuardDuty resources, they use the colon (:) separator. 👍 e.g.

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_ipset#import
https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_publishing_destination#import

bflad · 2020-09-01T00:26:00Z

aws/resource_aws_guardduty_filter_test.go

+func testAccGuardDutyFilterConfig_full(startDate, endDate string) string {
+	return fmt.Sprintf(`
+resource "aws_guardduty_filter" "test" {
+  detector_id = "${aws_guardduty_detector.test.id}"


Nit: Terraform 0.12 syntax

That's embarrassing…

ghost · 2020-09-03T19:26:49Z

This has been released in version 3.5.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!

ghost · 2020-10-03T17:11:02Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

kzonov and others added 30 commits July 7, 2020 09:43

Merge pull request #2 from terraform-providers/master

dd41a64

Merging master into feature branch

Added a partially copied, partially corrected resource file

af118c7

Fixed or workarounded syntax errors

70d99dd

Made Create action uncommented and not crashing

622fe20

Made Create action to make its way to the API request

8852d14

Added tags field for creation

6f7535a

Fixed tags assignment

17e3fb4

Made create request work for region only condition

7f22a94

Implemented DELETE action for filters

fc29555

Filled in finding criteria

031b0f1

Extracted buildFindingCriteria

e912469

Changed the format of guard_duty_filter criterion

7df19eb

Made different sort of conditions work

fb5db6f

Added the update action for the guardduty filter

c8b3284

Cleaned up the action default and unveiled the update action

4dfc52c

Added validations for generic cases

f990e1e

Implemented on-the-flight validation for the conditions

2fa228f

Cleaned up comments

bdba53c

Made Id of GD filter to be a compounded one

fd81374

Moved a function

34c8630

Added import function without the findingCriteria

08b50a8

Gofmt fixes

db2daeb

Gofmt with -s fixes

bc4ac65

Implemented a mock of flattening of the finding criteria

c241f37

Fixed map with possible conditions

d4b07c2

Made import work also for Finding Criteria

d6e6608

Dryed up the flattening functions

73a737e

Just moved things around

7432698

Fixed create/update case where one field can contain more than one co…

2821f87

…ndition

Implemented a better error output

de0c9b5

suzuki-shunsuke and others added 7 commits August 11, 2020 22:03

Use parseImportedId

672d35f

#10676 (comment)

Define the function to create the GuardDuty Filter's ID

88ea72d

#10676 (comment)

Use aws.StringValue instead of direct pointer manupulation

87638fe

#10676 (comment)

Add a variable detectorResourceName

e313e2b

#10676 (comment)

Merge branch 'master' into added-guardduty-filter-resource

c5486f8

# Conflicts: # aws/provider.go # website/aws.erb

Handle case when there are no tags set and add more complete tests

a001f20

Adds update and disappears tests

508424d

gdavison added 3 commits August 27, 2020 14:18

Adds tag update ability and ARN output

619c9e5

Updates Exists function to make API call and return API object

2213310

Updates filter criteria to match AWS API

bc43990

gdavison marked this pull request as ready for review August 28, 2020 23:19

gdavison requested a review from a team August 28, 2020 23:19

gdavison marked this pull request as draft August 31, 2020 20:35

Uses RFC 3339 dates for "updatedAt" field

54ab4ff

gdavison marked this pull request as ready for review August 31, 2020 23:02

bflad approved these changes Sep 1, 2020

View reviewed changes

bflad added the new-resource Introduces a new resource. label Sep 1, 2020

Updates from code review

9c8eaf2

gdavison merged commit 42185e6 into master Sep 2, 2020

gdavison deleted the added-guardduty-filter-resource branch September 2, 2020 21:58

gdavison added this to the v3.5.0 milestone Sep 2, 2020

gdavison added a commit that referenced this pull request Sep 2, 2020

Update CHANGELOG for #14876

e758137

ghost locked as resolved and limited conversation to collaborators Oct 3, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GuardDuty filter resource #14876

Add GuardDuty filter resource #14876

gdavison commented Aug 27, 2020 •

edited

Loading

bflad left a comment

bflad Sep 1, 2020

bflad Sep 1, 2020

bflad Sep 1, 2020

gdavison Sep 2, 2020

ghost commented Sep 3, 2020

ghost commented Oct 3, 2020

Add GuardDuty filter resource #14876

Add GuardDuty filter resource #14876

Conversation

gdavison commented Aug 27, 2020 • edited Loading

Community Note

bflad left a comment

Choose a reason for hiding this comment

bflad Sep 1, 2020

Choose a reason for hiding this comment

bflad Sep 1, 2020

Choose a reason for hiding this comment

bflad Sep 1, 2020

Choose a reason for hiding this comment

gdavison Sep 2, 2020

Choose a reason for hiding this comment

ghost commented Sep 3, 2020

ghost commented Oct 3, 2020

gdavison commented Aug 27, 2020 •

edited

Loading