Struct PatternToken

#[non_exhaustive]
pub struct PatternToken {
    pub dynamic_token_position: i32,
    pub is_dynamic: Option<bool>,
    pub token_string: Option<String>,
    pub enumerations: Option<HashMap<String, i64>>,
    pub inferred_token_name: Option<String>,
}

A structure that contains information about one pattern token related to an anomaly.

For more information about patterns and tokens, see CreateLogAnomalyDetector.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dynamic_token_position: i32

For a dynamic token, this indicates where in the pattern that this token appears, related to other dynamic tokens. The dynamic token that appears first has a value of 1, the one that appears second is 2, and so on.

is_dynamic: Option<bool>

Specifies whether this is a dynamic token.

token_string: Option<String>

The string represented by this token. If this is a dynamic token, the value will be <*>

enumerations: Option<HashMap<String, i64>>

Contains the values found for a dynamic token, and the number of times each value was found.

inferred_token_name: Option<String>

A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of the inferredTokenName gives you a clearer idea of the content of this token. The number part of the inferredTokenName shows where in the pattern this token appears, compared to other dynamic tokens. CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.

For example, an inferred token name of IPAddress-3 means that the token represents an IP address, and this token is the third dynamic token in the pattern.

Implementations

impl PatternToken

pub fn dynamic_token_position(&self) -> i32

For a dynamic token, this indicates where in the pattern that this token appears, related to other dynamic tokens. The dynamic token that appears first has a value of 1, the one that appears second is 2, and so on.

pub fn is_dynamic(&self) -> Option<bool>

Specifies whether this is a dynamic token.

pub fn token_string(&self) -> Option<&str>

The string represented by this token. If this is a dynamic token, the value will be <*>

pub fn enumerations(&self) -> Option<&HashMap<String, i64>>

Contains the values found for a dynamic token, and the number of times each value was found.

pub fn inferred_token_name(&self) -> Option<&str>

A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of the inferredTokenName gives you a clearer idea of the content of this token. The number part of the inferredTokenName shows where in the pattern this token appears, compared to other dynamic tokens. CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.

For example, an inferred token name of IPAddress-3 means that the token represents an IP address, and this token is the third dynamic token in the pattern.

impl PatternToken

pub fn builder() -> PatternTokenBuilder

Creates a new builder-style object to manufacture PatternToken.

Trait Implementations

impl Clone for PatternToken

fn clone(&self) -> PatternToken

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PatternToken

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PatternToken

fn eq(&self, other: &PatternToken) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PatternToken