interface CfnSubscriptionFilterProps

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

Properties for defining a CfnSubscriptionFilter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html

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';
const cfnSubscriptionFilterProps: logs.CfnSubscriptionFilterProps = {
  destinationArn: 'destinationArn',
  filterPattern: 'filterPattern',
  logGroupName: 'logGroupName',

  // the properties below are optional
  applyOnTransformedLogs: false,
  distribution: 'distribution',
  emitSystemFields: ['emitSystemFields'],
  fieldSelectionCriteria: 'fieldSelectionCriteria',
  filterName: 'filterName',
  roleArn: 'roleArn',
};

Properties

Name	Type	Description
destinationArn	string | IDeliveryStreamRef | IStreamRef | IFunctionRef	The Amazon Resource Name (ARN) of the destination.
filterPattern	string	The filtering expressions that restrict what gets delivered to the destination AWS resource.
logGroupName	string | ILogGroupRef	The log group to associate with the subscription filter.
applyOnTransformedLogs?	boolean | IResolvable	This parameter is valid only for log groups that have an active log transformer.
distribution?	string	The method used to distribute log data to the destination, which can be either random or grouped by log stream.
emitSystemFields?	string[]	The list of system fields that are included in the log events sent to the subscription destination.
fieldSelectionCriteria?	string	The filter expression that specifies which log events are processed by this subscription filter based on system fields.
filterName?	string	The name of the subscription filter.
roleArn?	string | IRoleRef	The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream.

---

destinationArn

Type: string | IDeliveryStreamRef | IStreamRef | IFunctionRef

The Amazon Resource Name (ARN) of the destination.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-destinationarn

---

filterPattern

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filterpattern

---

logGroupName

Type: string | ILogGroupRef

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-loggroupname

---

applyOnTransformedLogs?

Type: boolean | IResolvable (optional)

This parameter is valid only for log groups that have an active log transformer.

For more information about log transformers, see PutTransformer .

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-applyontransformedlogs

---

distribution?

Type: string (optional)

The method used to distribute log data to the destination, which can be either random or grouped by log stream.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-distribution

---

emitSystemFields?

Type: string[] (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-emitsystemfields

---

fieldSelectionCriteria?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-fieldselectioncriteria

---

filterName?

Type: string (optional)

The name of the subscription filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filtername

---

roleArn?

Type: string | IRoleRef (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-rolearn