Package software.amazon.awscdk.services.logs

Interface ParseKeyValueProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ParseKeyValueProperty.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:13.229Z")
@Stability(Stable)
public interface ParseKeyValueProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.logs.*;
 ParseKeyValueProperty parseKeyValueProperty = ParseKeyValueProperty.builder()
         .destination("destination")
         .fieldDelimiter(KeyValuePairDelimiter.AMPERSAND)
         .keyPrefix("keyPrefix")
         .keyValueDelimiter(KeyValueDelimiter.EQUAL)
         .nonMatchValue("nonMatchValue")
         .overwriteIfExists(false)
         .source("source")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ParseKeyValueProperty.Builder	A builder for ParseKeyValueProperty
static final class	ParseKeyValueProperty.Jsii$Proxy	An implementation for ParseKeyValueProperty

Method Summary

Modifier and Type	Method	Description
static ParseKeyValueProperty.Builder	builder()
default String	getDestination()	The destination field to put the extracted key-value pairs into.
default KeyValuePairDelimiter	getFieldDelimiter()	The field delimiter string that is used between key-value pairs in the original log events.
default String	getKeyPrefix()	If you want to add a prefix to all transformed keys, specify it here.
default KeyValueDelimiter	getKeyValueDelimiter()	The delimiter string to use between the key and value in each pair in the transformed log event.
default String	getNonMatchValue()	A value to insert into the value field in the result, when a key-value pair is not successfully split.
default Boolean	getOverwriteIfExists()	Specifies whether to overwrite the value if the destination key already exists.
default String	getSource()	Path to the field in the log event that will be parsed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestination

@Stability(Stable)
@Nullable
default String getDestination()

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

Default: - Places at the root of the JSON input.

getFieldDelimiter

@Stability(Stable)
@Nullable
default KeyValuePairDelimiter getFieldDelimiter()

The field delimiter string that is used between key-value pairs in the original log events.

Default: KeyValuePairDelimiter.AMPERSAND

getKeyPrefix

@Stability(Stable)
@Nullable
default String getKeyPrefix()

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

Default: - No prefix is added to the keys.

getKeyValueDelimiter

@Stability(Stable)
@Nullable
default KeyValueDelimiter getKeyValueDelimiter()

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

Default: KeyValueDelimiter.EQUAL

getNonMatchValue

@Stability(Stable)
@Nullable
default String getNonMatchValue()

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

Default: - No values is inserted when split is not successful.

getOverwriteIfExists

@Stability(Stable)
@Nullable
default Boolean getOverwriteIfExists()

Specifies whether to overwrite the value if the destination key already exists.

Default: false

getSource

@Stability(Stable)
@Nullable
default String getSource()

Path to the field in the log event that will be parsed.

Use dot notation to access child fields.

Default: '@message'

builder

@Stability(Stable)
static ParseKeyValueProperty.Builder builder()

Returns:

a ParseKeyValueProperty.Builder of ParseKeyValueProperty