interface SubscriptionFilterProps

Language	Type name
.NET	`Amazon.CDK.AWS.Logs.SubscriptionFilterProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslogs#SubscriptionFilterProps`
Java	`software.amazon.awscdk.services.logs.SubscriptionFilterProps`
Python	`aws_cdk.aws_logs.SubscriptionFilterProps`
TypeScript (source)	`aws-cdk-lib` » `aws_logs` » `SubscriptionFilterProps`

Properties for a SubscriptionFilter.

Example

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

Name	Type	Description
destination	`ILogSubscriptionDestination`	The destination to send the filtered events to.
filterPattern	`IFilterPattern`	Log events matching this pattern will be sent to the destination.
logGroup	`ILogGroup`	The log group to create the subscription on.
distribution?	`Distribution`	The method used to distribute log data to the destination.
filterName?	`string`	The name of the subscription filter.

destination

Type: ILogSubscriptionDestination

The destination to send the filtered events to.

For example, a Kinesis stream or a Lambda function.

filterPattern

Type: IFilterPattern

Log events matching this pattern will be sent to the destination.

logGroup

Type: ILogGroup

The log group to create the subscription on.

distribution?

Type: Distribution (optional, default: Distribution.BY_LOG_STREAM)

The method used to distribute log data to the destination.

This property can only be used with KinesisDestination.

filterName?

Type: string (optional, default: Automatically generated)

The name of the subscription filter.