AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Represents a subscription filter.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatchLogs.Model.SubscriptionFilter

Namespace: Amazon.CloudWatchLogs.Model
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z

Syntax

C#
public class SubscriptionFilter

The SubscriptionFilter type exposes the following members

Constructors

NameDescription
Public Method SubscriptionFilter()

Properties

NameTypeDescription
Public Property ApplyOnTransformedLogs System.Nullable<System.Boolean>

Gets and sets the property ApplyOnTransformedLogs.

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.

Public Property CreationTime System.Nullable<System.Int64>

Gets and sets the property CreationTime.

The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Public Property DestinationArn System.String

Gets and sets the property DestinationArn.

The Amazon Resource Name (ARN) of the destination.

Public Property Distribution Amazon.CloudWatchLogs.Distribution

Gets and sets the property Distribution.

Public Property EmitSystemFields System.Collections.Generic.List<System.String>

Gets and sets the property EmitSystemFields.

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.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property FieldSelectionCriteria System.String

Gets and sets the property FieldSelectionCriteria.

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.

Public Property FilterName System.String

Gets and sets the property FilterName.

The name of the subscription filter.

Public Property FilterPattern System.String

Gets and sets the property FilterPattern.

Public Property LogGroupName System.String

Gets and sets the property LogGroupName.

The name of the log group.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer