interface SubscriptionFilterOptions

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

Properties for a new SubscriptionFilter created from a LogGroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from 'aws-cdk-lib';

declare const filterPattern: logs.IFilterPattern;
declare const logSubscriptionDestination: logs.ILogSubscriptionDestination;
const subscriptionFilterOptions: logs.SubscriptionFilterOptions = {
  destination: logSubscriptionDestination,
  filterPattern: filterPattern,

  // the properties below are optional
  distribution: logs.Distribution.BY_LOG_STREAM,
  filterName: 'filterName',
};

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.
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.

---

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.