aws-cdk-lib.aws_guardduty.CfnFilterProps

interface CfnFilterProps

LanguageType name
.NETAmazon.CDK.AWS.GuardDuty.CfnFilterProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsguardduty#CfnFilterProps
Javasoftware.amazon.awscdk.services.guardduty.CfnFilterProps
Pythonaws_cdk.aws_guardduty.CfnFilterProps
TypeScript aws-cdk-lib » aws_guardduty » CfnFilterProps

Properties for defining a CfnFilter.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_guardduty as guardduty } from 'aws-cdk-lib';

declare const criterion: any;
const cfnFilterProps: guardduty.CfnFilterProps = {
  action: 'action',
  description: 'description',
  detectorId: 'detectorId',
  findingCriteria: {
    criterion: criterion,
    itemType: {
      eq: ['eq'],
      equalTo: ['equalTo'],
      greaterThan: 123,
      greaterThanOrEqual: 123,
      gt: 123,
      gte: 123,
      lessThan: 123,
      lessThanOrEqual: 123,
      lt: 123,
      lte: 123,
      neq: ['neq'],
      notEquals: ['notEquals'],
    },
  },
  name: 'name',
  rank: 123,

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
actionstringSpecifies the action that is to be applied to the findings that match the filter.
descriptionstringThe description of the filter.
detectorIdstringThe ID of the detector belonging to the GuardDuty account that you want to create a filter for.
findingCriteriaIResolvable | FindingCriteriaPropertyRepresents the criteria to be used in the filter for querying findings.
namestringThe name of the filter.
ranknumberSpecifies the position of the filter in the list of current filters.
tags?CfnTag[]The tags to be added to a new filter resource.

action

Type: string

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


description

Type: string

The description of the filter.

Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses ( { } , [ ] , and ( ) ), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.


detectorId

Type: string

The ID of the detector belonging to the GuardDuty account that you want to create a filter for.


findingCriteria

Type: IResolvable | FindingCriteriaProperty

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


name

Type: string

The name of the filter.

Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.


rank

Type: number

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. The minimum value for this property is 1 and the maximum is 100.

By default, filters may not be created in the same order as they are ranked. To ensure that the filters are created in the expected order, you can use an optional attribute, DependsOn , with the following syntax: "DependsOn":[ "ObjectName" ] .


tags?

Type: CfnTag[] (optional)

The tags to be added to a new filter resource.

Each tag consists of a key and an optional value, both of which you define.

For more information, see Tag .