AWS::Logs::SubscriptionFilterCfnSubscriptionFilter
The `AWS::Logs::SubscriptionFilter` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are: - An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery. - A logical destination that belongs to a different account, for cross-account delivery. - An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery. - An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery. There can be as many as two subscription filters associated with a log group.
Import
import { CfnSubscriptionFilter } from 'aws-cdk-lib/aws-logs';Or use the module namespace:
import * as logs from 'aws-cdk-lib/aws-logs';
// logs.CfnSubscriptionFilterProperties
Configuration passed to the constructor as CfnSubscriptionFilterProps.
destinationArnRequiredstring | IStreamRef | IDeliveryStreamRef | IFunctionRefThe Amazon Resource Name (ARN) of the destination.
filterPatternRequiredstringThe filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .
logGroupNameRequiredstring | ILogGroupRefThe log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
applyOnTransformedLogsOptionalboolean | IResolvableThis parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html) . If this value is `true` , the subscription filter is applied on the transformed version of the log events instead of the original ingested log events.
distributionOptionalstringThe method used to distribute log data to the destination, which can be either random or grouped by log stream.
emitSystemFieldsOptionalstring[]The list of system fields that are included in the log events sent to the subscription destination. Returns the `emitSystemFields` value if it was specified when the subscription filter was created.
fieldSelectionCriteriaOptionalstringThe filter expression that specifies which log events are processed by this subscription filter based on system fields. Returns the `fieldSelectionCriteria` value if it was specified when the subscription filter was created.
filterNameOptionalstringThe name of the subscription filter.
roleArnOptionalstring | IRoleRefThe ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-logsAWS::Logs::SubscriptionFilter