Skip to content
v2.278.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',
});
python
import aws_cdk.aws_logs_destinations as destinations

# fn: lambda.Function
# log_group: logs.LogGroup


logs.SubscriptionFilter(self, "Subscription",
    log_group=log_group,
    destination=destinations.LambdaDestination(fn),
    filter_pattern=logs.FilterPattern.all_terms("ERROR", "MainThread"),
    filter_name="ErrorInMainThread"
)
java
import software.amazon.awscdk.services.logs.destinations.*;

Function fn;
LogGroup logGroup;


SubscriptionFilter.Builder.create(this, "Subscription")
        .logGroup(logGroup)
        .destination(new LambdaDestination(fn))
        .filterPattern(FilterPattern.allTerms("ERROR", "MainThread"))
        .filterName("ErrorInMainThread")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Logs.Destinations;

Function fn;
LogGroup logGroup;


new SubscriptionFilter(this, "Subscription", new SubscriptionFilterProps {
    LogGroup = logGroup,
    Destination = new LambdaDestination(fn),
    FilterPattern = FilterPattern.AllTerms("ERROR", "MainThread"),
    FilterName = "ErrorInMainThread"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import destinations "github.com/aws/aws-cdk-go/awscdk"

var fn Function
var logGroup LogGroup


logs.NewSubscriptionFilter(this, jsii.String("Subscription"), &SubscriptionFilterProps{
	LogGroup: LogGroup,
	Destination: destinations.NewLambdaDestination(fn),
	FilterPattern: logs.FilterPattern_AllTerms(jsii.String("ERROR"), jsii.String("MainThread")),
	FilterName: jsii.String("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_patternIFilterPatternfilterPatternIFilterPatternFilterPatternIFilterPatternFilterPatternIFilterPattern required #
Log events matching this pattern will be sent to the destination.
logGroupILogGroupReflog_groupILogGroupReflogGroupILogGroupRefLogGroupILogGroupRefLogGroupILogGroupRef required #
The log group to create the subscription on.