You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GuardDuty::Types::CreateFilterRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb

Overview

Note:

When making an API call, you may pass CreateFilterRequest data as a hash:

{
  detector_id: "DetectorId", # required
  name: "FilterName", # required
  description: "FilterDescription",
  action: "NOOP", # accepts NOOP, ARCHIVE
  rank: 1,
  finding_criteria: { # required
    criterion: {
      "String" => {
        eq: ["String"],
        neq: ["String"],
        gt: 1,
        gte: 1,
        lt: 1,
        lte: 1,
        equals: ["String"],
        not_equals: ["String"],
        greater_than: 1,
        greater_than_or_equal: 1,
        less_than: 1,
        less_than_or_equal: 1,
      },
    },
  },
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

Specifies the action that is to be applied to the findings that match the filter.

Returns:

  • (String)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 475

class CreateFilterRequest < Struct.new(
  :detector_id,
  :name,
  :description,
  :action,
  :rank,
  :finding_criteria,
  :client_token,
  :tags)
  include Aws::Structure
end

#client_tokenString

The idempotency token for the create request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 475

class CreateFilterRequest < Struct.new(
  :detector_id,
  :name,
  :description,
  :action,
  :rank,
  :finding_criteria,
  :client_token,
  :tags)
  include Aws::Structure
end

#descriptionString

The description of the filter.

Returns:

  • (String)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 475

class CreateFilterRequest < Struct.new(
  :detector_id,
  :name,
  :description,
  :action,
  :rank,
  :finding_criteria,
  :client_token,
  :tags)
  include Aws::Structure
end

#detector_idString

The unique ID of the detector of the GuardDuty account for which you want to create a filter.

Returns:

  • (String)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 475

class CreateFilterRequest < Struct.new(
  :detector_id,
  :name,
  :description,
  :action,
  :rank,
  :finding_criteria,
  :client_token,
  :tags)
  include Aws::Structure
end

#finding_criteriaTypes::FindingCriteria

Represents the criteria to be used in the filter for querying findings.



475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 475

class CreateFilterRequest < Struct.new(
  :detector_id,
  :name,
  :description,
  :action,
  :rank,
  :finding_criteria,
  :client_token,
  :tags)
  include Aws::Structure
end

#nameString

The name of the filter.

Returns:

  • (String)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 475

class CreateFilterRequest < Struct.new(
  :detector_id,
  :name,
  :description,
  :action,
  :rank,
  :finding_criteria,
  :client_token,
  :tags)
  include Aws::Structure
end

#rankInteger

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

Returns:

  • (Integer)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 475

class CreateFilterRequest < Struct.new(
  :detector_id,
  :name,
  :description,
  :action,
  :rank,
  :finding_criteria,
  :client_token,
  :tags)
  include Aws::Structure
end

#tagsHash<String,String>

The tags to be added to a new filter resource.

Returns:

  • (Hash<String,String>)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 475

class CreateFilterRequest < Struct.new(
  :detector_id,
  :name,
  :description,
  :action,
  :rank,
  :finding_criteria,
  :client_token,
  :tags)
  include Aws::Structure
end