Struct ParseKeyValue

#[non_exhaustive]
pub struct ParseKeyValue {
    pub source: Option<String>,
    pub destination: Option<String>,
    pub field_delimiter: Option<String>,
    pub key_value_delimiter: Option<String>,
    pub key_prefix: Option<String>,
    pub non_match_value: Option<String>,
    pub overwrite_if_exists: bool,
}

This processor parses a specified field in the original log event into key-value pairs.

For more information about this processor including examples, see parseKeyValue in the CloudWatch Logs User Guide.

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.

source: Option<String>

Path to the field in the log event that will be parsed. Use dot notation to access child fields. For example, store.book

destination: Option<String>

The destination field to put the extracted key-value pairs into

field_delimiter: Option<String>

The field delimiter string that is used between key-value pairs in the original log events. If you omit this, the ampersand & character is used.

key_value_delimiter: Option<String>

The delimiter string to use between the key and value in each pair in the transformed log event.

If you omit this, the equal = character is used.

key_prefix: Option<String>

If you want to add a prefix to all transformed keys, specify it here.

non_match_value: Option<String>

A value to insert into the value field in the result, when a key-value pair is not successfully split.

overwrite_if_exists: bool

Specifies whether to overwrite the value if the destination key already exists. If you omit this, the default is false.

Implementations

impl ParseKeyValue

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

Path to the field in the log event that will be parsed. Use dot notation to access child fields. For example, store.book

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

The destination field to put the extracted key-value pairs into

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

The field delimiter string that is used between key-value pairs in the original log events. If you omit this, the ampersand & character is used.

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

The delimiter string to use between the key and value in each pair in the transformed log event.

If you omit this, the equal = character is used.

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

If you want to add a prefix to all transformed keys, specify it here.

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

A value to insert into the value field in the result, when a key-value pair is not successfully split.

pub fn overwrite_if_exists(&self) -> bool

Specifies whether to overwrite the value if the destination key already exists. If you omit this, the default is false.

impl ParseKeyValue

pub fn builder() -> ParseKeyValueBuilder

Creates a new builder-style object to manufacture ParseKeyValue.

Trait Implementations

impl Clone for ParseKeyValue

fn clone(&self) -> ParseKeyValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParseKeyValue

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

Formats the value using the given formatter.

impl PartialEq for ParseKeyValue

fn eq(&self, other: &ParseKeyValue) -> 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 ParseKeyValue