class FilterRule

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.FilterRule
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslambda#FilterRule
Java	software.amazon.awscdk.services.lambda.FilterRule
Python	aws_cdk.aws_lambda.FilterRule
TypeScript (source)	aws-cdk-lib » aws_lambda » FilterRule

Filter rules for Lambda event filtering.

Example

import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import { DynamoEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';

declare const table: dynamodb.Table;

declare const fn: lambda.Function;
fn.addEventSource(new DynamoEventSource(table, {
  startingPosition: lambda.StartingPosition.LATEST,
  filters: [
    lambda.FilterCriteria.filter({
      eventName: lambda.FilterRule.isEqual('INSERT'),
      dynamodb: {
        NewImage: {
          id: { BOOL: lambda.FilterRule.isEqual(true) },
        },
      },
    }),
  ],
}));

Initializer

new FilterRule()

Methods

Name	Description
static beginsWith(elem)	Begins with comparison operator.
static between(first, second)	Numeric range comparison operator.
static empty()	Empty comparison operator.
static exists()	Exists comparison operator.
static isEqual(item)	Equals comparison operator.
static notEquals(elem)	Not equals comparison operator.
static notExists()	Not exists comparison operator.
static null()	Null comparison operator.
static or(...elem)	Or comparison operator.

---

static beginsWith(elem)

public static beginsWith(elem: string): { [string]: string }[]

Parameters

• elem string

Returns

• { [string]: string }[]

Begins with comparison operator.

---

static between(first, second)

public static between(first: number, second: number): { [string]: any[] }[]

Parameters

• first number
• second number

Returns

• { [string]: any[] }[]

Numeric range comparison operator.

---

static empty()

public static empty(): string[]

Returns

• string[]

Empty comparison operator.

---

static exists()

public static exists(): { [string]: boolean }[]

Returns

• { [string]: boolean }[]

Exists comparison operator.

---

static isEqual(item)

public static isEqual(item: string | number | boolean): any

Parameters

• item string | number | boolean

Returns

• any

Equals comparison operator.

---

static notEquals(elem)

public static notEquals(elem: string): { [string]: string[] }[]

Parameters

• elem string

Returns

• { [string]: string[] }[]

Not equals comparison operator.

---

static notExists()

public static notExists(): { [string]: boolean }[]

Returns

• { [string]: boolean }[]

Not exists comparison operator.

---

static null()

public static null(): any

Returns

• any

Null comparison operator.

---

static or(...elem)

public static or(...elem: string[]): string[]

Parameters

• elem string

Returns

• string[]

Or comparison operator.