class SubscriptionFilter (construct)

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

Implements IConstruct, IDependable, IResource

A new Subscription on a CloudWatch log group.

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',
});

Initializer

new SubscriptionFilter(scope: Construct, id: string, props: SubscriptionFilterProps)

Parameters

• scope Construct
• id string
• props SubscriptionFilterProps

Construct Props

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.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.