Skip to content

ParseKeyValue

Source code in docs_src/capo_cloudwatch_logs/types/parse_key_value.py
class ParseKeyValue(TypedDict, closed=True):
    source: NotRequired["capo_cloudwatch_logs.types.source.Source"]
    """<p>Path to the field in the log event that will be parsed. Use dot notation to access child fields. For example, <code>store.book</code> </p>"""
    destination: NotRequired[
        "capo_cloudwatch_logs.types.destination_field.DestinationField"
    ]
    """<p>The destination field to put the extracted key-value pairs into</p>"""
    field_delimiter: NotRequired[
        "capo_cloudwatch_logs.types.parser_field_delimiter.ParserFieldDelimiter"
    ]
    """<p>The field delimiter string that is used between key-value pairs in the original log events. If you omit this, the ampersand <code>&</code> character is used.</p>"""
    key_value_delimiter: NotRequired[
        "capo_cloudwatch_logs.types.key_value_delimiter.KeyValueDelimiter"
    ]
    """<p>The delimiter string to use between the key and value in each pair in the transformed log event.</p> <p> If you omit this, the equal <code>=</code> character is used.</p>"""
    key_prefix: NotRequired["capo_cloudwatch_logs.types.key_prefix.KeyPrefix"]
    """<p>If you want to add a prefix to all transformed keys, specify it here.</p>"""
    non_match_value: NotRequired[
        "capo_cloudwatch_logs.types.non_match_value.NonMatchValue"
    ]
    """<p>A value to insert into the value field in the result, when a key-value pair is not successfully split.</p>"""
    overwrite_if_exists: (
        "capo_cloudwatch_logs.types.overwrite_if_exists.OverwriteIfExists"
    )
    """<p>Specifies whether to overwrite the value if the destination key already exists. If you omit this, the default is <code>false</code>.</p>"""

destination instance-attribute

destination: NotRequired[DestinationField]

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

field_delimiter instance-attribute

field_delimiter: NotRequired[ParserFieldDelimiter]

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_prefix instance-attribute

key_prefix: NotRequired[KeyPrefix]

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

key_value_delimiter instance-attribute

key_value_delimiter: NotRequired[KeyValueDelimiter]

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.

non_match_value instance-attribute

non_match_value: NotRequired[NonMatchValue]

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

overwrite_if_exists instance-attribute

overwrite_if_exists: OverwriteIfExists

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

source instance-attribute

source: NotRequired[Source]

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