class Amazonite::CloudWatchLogs::FieldIndex

Overview

This structure describes one log event field that is used as an index in at least one index policy in this account.

Included Modules

Defined in:

cloudwatch_logs/field_index.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(log_group_identifier : String | Nil = nil, field_index_name : String | Nil = nil, last_scan_time : Int64 | Nil = nil, first_event_time : Int64 | Nil = nil, last_event_time : Int64 | Nil = nil, type : IndexType | Nil = nil, index_category : IndexCategory | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def field_index_name : String | Nil #

The string that this field index matches.


[View source]
def field_index_name=(field_index_name : String | Nil) #

The string that this field index matches.


[View source]
def first_event_time : Int64 | Nil #

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


[View source]
def first_event_time=(first_event_time : Int64 | Nil) #

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


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def index_category : IndexCategory | Nil #

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.


[View source]
def index_category=(index_category : IndexCategory | Nil) #

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.


[View source]
def last_event_time : Int64 | Nil #

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


[View source]
def last_event_time=(last_event_time : Int64 | Nil) #

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


[View source]
def last_scan_time : Int64 | Nil #

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.


[View source]
def last_scan_time=(last_scan_time : Int64 | Nil) #

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.


[View source]
def log_group_identifier : String | Nil #

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.


[View source]
def log_group_identifier=(log_group_identifier : String | Nil) #

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.


[View source]
def type : IndexType | Nil #

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.


[View source]
def type=(type : IndexType | Nil) #

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.


[View source]
def validate! : Nil #

[View source]