Skip to content
v2.274.0

SubscriptionFilterProps Struct ​

Properties for a SubscriptionFilter.

Example ​

ts
import * as destinations from 'aws-cdk-lib/aws-logs-destinations';

declare const fn: lambda.Function;
declare const logGroup: logs.LogGroup;

new logs.SubscriptionFilter(this, 'Subscription', {
  logGroup,
  destination: new destinations.LambdaDestination(fn),
  filterPattern: logs.FilterPattern.allTerms("ERROR", "MainThread"),
  filterName: 'ErrorInMainThread',
});

Properties ​

The destination to send the filtered events to.

For example, a Kinesis stream or a Lambda function.

distributionoptionalDistributiondistributionoptionalDistributiondistributionoptionalDistributionDistributionoptionalDistributionDistributionoptionalDistribution= Distribution.BY_LOG_STREAM#
The method used to distribute log data to the destination.

This property can only be used with KinesisDestination.

filterNameoptionalstringfilter_nameoptionalstrfilterNameoptionalStringFilterNameoptionalstringFilterNameoptional*string#
The name of the subscription filter.

Default: Automatically generated

filterPatternIFilterPatternfilter_patternIFilterPatternfilterPatternIFilterPatternFilterPatternIFilterPatternFilterPatternIFilterPatternrequired#
Log events matching this pattern will be sent to the destination.
logGroupILogGroupReflog_groupILogGroupReflogGroupILogGroupRefLogGroupILogGroupRefLogGroupILogGroupRefrequired#
The log group to create the subscription on.