aws-cdk-lib.aws_logs.CfnSubscriptionFilterProps

CfnSubscriptionFilterProps Struct

Properties for defining a CfnSubscriptionFilter.

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

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

applyOnTransformedLogsboolean | IResolvableapply_on_transformed_logstyping.Union[bool, IResolvable]applyOnTransformedLogsBooleanApplyOnTransformedLogsboolApplyOnTransformedLogsinterface{}#

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

notes

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.

destinationArnstring | IStreamRef | IDeliveryStreamRef | IFunctionRefdestination_arntyping.Union[str, IStreamRef, IDeliveryStreamRef, IFunctionRef]destinationArnStringDestinationArnstringDestinationArninterface{}required#

The Amazon Resource Name (ARN) of the destination.

distributionstringdistributionstrdistributionStringDistributionstringDistribution*string#

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

emitSystemFieldsstring[]emit_system_fieldstyping.List[str]emitSystemFieldsList<String>EmitSystemFieldsstring[]EmitSystemFields*[]*string#

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.

fieldSelectionCriteriastringfield_selection_criteriastrfieldSelectionCriteriaStringFieldSelectionCriteriastringFieldSelectionCriteria*string#

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.

filterNamestringfilter_namestrfilterNameStringFilterNamestringFilterName*string#

The name of the subscription filter.

filterPatternstringfilter_patternstrfilterPatternStringFilterPatternstringFilterPattern*stringrequired#

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 .

logGroupNamestring | ILogGroupReflog_group_nametyping.Union[str, ILogGroupRef]logGroupNameStringLogGroupNamestringLogGroupNameinterface{}required#

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.

roleArnstring | IRoleRefrole_arntyping.Union[str, IRoleRef]roleArnStringRoleArnstringRoleArninterface{}#

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.

Used as props by

• CfnSubscriptionFilter