Interface ISubscriptionFilterOptions

Properties for a new SubscriptionFilter created from a LogGroup.

Namespace: Amazon.CDK.AWS.Logs

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ISubscriptionFilterOptions

Syntax (vb)

Public Interface ISubscriptionFilterOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.Logs;

            IFilterPattern filterPattern;
            ILogSubscriptionDestination logSubscriptionDestination;

            var subscriptionFilterOptions = new SubscriptionFilterOptions {
                Destination = logSubscriptionDestination,
                FilterPattern = filterPattern,

                // the properties below are optional
                Distribution = Distribution.BY_LOG_STREAM,
                FilterName = "filterName"
            };

Synopsis

Properties

Destination	The destination to send the filtered events to.
Distribution	The method used to distribute log data to the destination.
FilterName	The name of the subscription filter.
FilterPattern	Log events matching this pattern will be sent to the destination.

Properties

Destination

The destination to send the filtered events to.

ILogSubscriptionDestination Destination { get; }

Property Value

ILogSubscriptionDestination

Remarks

For example, a Kinesis stream or a Lambda function.

Distribution

The method used to distribute log data to the destination.

Distribution? Distribution { get; }

Property Value

Distribution?

Remarks

This property can only be used with KinesisDestination.

Default: Distribution.BY_LOG_STREAM

FilterName

The name of the subscription filter.

string? FilterName { get; }

Property Value

string

Remarks

Default: Automatically generated

FilterPattern

Log events matching this pattern will be sent to the destination.

IFilterPattern FilterPattern { get; }

Property Value

IFilterPattern

Remarks

ExampleMetadata: fixture=_generated