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 structure describes one log event field that is used as an index in at least one index policy in this account.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatchLogs.Model.FieldIndex

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

Syntax

C#
public class FieldIndex

The FieldIndex type exposes the following members

Constructors

NameDescription
Public Method FieldIndex()

Properties

NameTypeDescription
Public Property FieldIndexName System.String

Gets and sets the property FieldIndexName.

The string that this field index matches.

Public Property FirstEventTime System.Nullable<System.Int64>

Gets and sets the property FirstEventTime.

The time and date of the earliest log event that matches this field index, after the index policy that contains it was created.

Public Property IndexCategory Amazon.CloudWatchLogs.IndexCategory

Gets and sets the property IndexCategory.

The category of the field index:

  • DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

  • CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

  • AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

  • INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

For more information about automatically indexed fields, see Automatically indexed fields.

Public Property LastEventTime System.Nullable<System.Int64>

Gets and sets the property LastEventTime.

The time and date of the most recent log event that matches this field index.

Public Property LastScanTime System.Nullable<System.Int64>

Gets and sets the property LastScanTime.

The most recent time that CloudWatch Logs scanned ingested log events to search for this field index to improve the speed of future CloudWatch Logs Insights queries that search for this field index.

Public Property LogGroupIdentifier System.String

Gets and sets the property LogGroupIdentifier.

If this field index appears in an index policy that applies only to a single log group, the ARN of that log group is displayed here.

Public Property Type Amazon.CloudWatchLogs.IndexType

Gets and sets the property Type.

The type of index. Specify FACET for facet-based indexing or FIELD_INDEX for field-based indexing. This determines how the field is indexed and can be queried.

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