aws-cdk-lib.aws_securityhub.CfnAutomationRule.MapFilterProperty

interface MapFilterProperty

LanguageType name
.NETAmazon.CDK.AWS.SecurityHub.CfnAutomationRule.MapFilterProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssecurityhub#CfnAutomationRule_MapFilterProperty
Javasoftware.amazon.awscdk.services.securityhub.CfnAutomationRule.MapFilterProperty
Pythonaws_cdk.aws_securityhub.CfnAutomationRule.MapFilterProperty
TypeScript aws-cdk-lib » aws_securityhub » CfnAutomationRule » MapFilterProperty

A map filter for querying findings.

Each map filter provides the field to check, the value to look for, and the comparison operator.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_securityhub as securityhub } from 'aws-cdk-lib';
const mapFilterProperty: securityhub.CfnAutomationRule.MapFilterProperty = {
  comparison: 'comparison',
  key: 'key',
  value: 'value',
};

Properties

NameTypeDescription
comparisonstringThe condition to apply to the key value when querying for findings with a map filter.
keystringThe key of the map filter.
valuestringThe value for the key in the map filter.

comparison

Type: string

The condition to apply to the key value when querying for findings with a map filter.

To search for values that exactly match the filter value, use EQUALS . For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the tag Department .

To search for values other than the filter value, use NOT_EQUALS . For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that do not have the value Finance for the tag Department .

EQUALS filters on the same field are joined by OR . A finding matches if it matches any one of those filters.

NOT_EQUALS filters on the same field are joined by AND . A finding matches only if it matches all of those filters.

You cannot have both an EQUALS filter and a NOT_EQUALS filter on the same field.


key

Type: string

The key of the map filter.

For example, for ResourceTags , Key identifies the name of the tag. For UserDefinedFields , Key is the name of the field.


value

Type: string

The value for the key in the map filter.

Filter values are case sensitive. For example, one of the values for a tag called Department might be Security . If you provide security as the filter value, then there is no match.