Package software.amazon.awscdk.services.logs

Interface SubscriptionFilterOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SubscriptionFilterProps

All Known Implementing Classes:

SubscriptionFilterOptions.Jsii$Proxy, SubscriptionFilterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:45.951Z")
@Stability(Stable)
public interface SubscriptionFilterOptions
extends software.amazon.jsii.JsiiSerializable

Properties for a new SubscriptionFilter created from a LogGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.logs.*;
 IFilterPattern filterPattern;
 ILogSubscriptionDestination logSubscriptionDestination;
 SubscriptionFilterOptions subscriptionFilterOptions = SubscriptionFilterOptions.builder()
         .destination(logSubscriptionDestination)
         .filterPattern(filterPattern)
         // the properties below are optional
         .distribution(Distribution.BY_LOG_STREAM)
         .filterName("filterName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SubscriptionFilterOptions.Builder	A builder for SubscriptionFilterOptions
static final class	SubscriptionFilterOptions.Jsii$Proxy	An implementation for SubscriptionFilterOptions

Method Summary

Modifier and Type	Method	Description
static SubscriptionFilterOptions.Builder	builder()
ILogSubscriptionDestination	getDestination()	The destination to send the filtered events to.
default Distribution	getDistribution()	The method used to distribute log data to the destination.
default String	getFilterName()	The name of the subscription filter.
IFilterPattern	getFilterPattern()	Log events matching this pattern will be sent to the destination.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestination

@Stability(Stable)
@NotNull
ILogSubscriptionDestination getDestination()

The destination to send the filtered events to.

For example, a Kinesis stream or a Lambda function.

getFilterPattern

@Stability(Stable)
@NotNull
IFilterPattern getFilterPattern()

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

getDistribution

@Stability(Stable)
@Nullable
default Distribution getDistribution()

The method used to distribute log data to the destination.

This property can only be used with KinesisDestination.

Default: Distribution.BY_LOG_STREAM

getFilterName

@Stability(Stable)
@Nullable
default String getFilterName()

The name of the subscription filter.

Default: Automatically generated

builder

@Stability(Stable)
static SubscriptionFilterOptions.Builder builder()

Returns:

a SubscriptionFilterOptions.Builder of SubscriptionFilterOptions