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.

This object contains information about this Live Tail session, including the log groups included and the log stream filters, if any.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatchLogs.Model.LiveTailSessionStart

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

Syntax

C# 
public class LiveTailSessionStart
         IEventStreamEvent

The LiveTailSessionStart type exposes the following members

Constructors

NameDescription
Public Method LiveTailSessionStart()

Properties

NameTypeDescription
Public Property LogEventFilterPattern System.String

Gets and sets the property LogEventFilterPattern.

An optional pattern to filter the results to include only log events that match the pattern. For example, a filter pattern of error 404 displays only log events that include both error and 404.

For more information about filter pattern syntax, see Filter and Pattern Syntax.

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

Gets and sets the property LogGroupIdentifiers.

An array of the names and ARNs of the log groups included in this Live Tail session.

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 LogStreamNamePrefixes System.Collections.Generic.List<System.String>

Gets and sets the property LogStreamNamePrefixes.

If your StartLiveTail operation request included a logStreamNamePrefixes parameter that filtered the session to only include log streams that have names that start with certain prefixes, these prefixes are listed here.

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 LogStreamNames System.Collections.Generic.List<System.String>

Gets and sets the property LogStreamNames.

If your StartLiveTail operation request included a logStreamNames parameter that filtered the session to only include certain log streams, these streams are listed here.

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 RequestId System.String

Gets and sets the property RequestId.

The unique ID generated by CloudWatch Logs to identify this Live Tail session request.

Public Property SessionId System.String

Gets and sets the property SessionId.

The unique ID generated by CloudWatch Logs to identify this Live Tail session.

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