Package software.amazon.awscdk.services.logs

Interface ParseJSONProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ParseJSONProperty.Jsii$Proxy
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-07-29T17:51:03.403Z") @Stability(Stable) public interface ParseJSONProperty extends software.amazon.jsii.JsiiSerializable
This processor parses log events that are in JSON format.

It can extract JSON key-value pairs and place them under a destination that you specify. Additionally, because you must have at least one parse-type processor in a transformer, you can use ParseJSON as that processor for JSON-format logs, so that you can also apply other processors, such as mutate processors, to these logs. For more information about this processor including examples, see parseJSON 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.*;
 ParseJSONProperty parseJSONProperty = ParseJSONProperty.builder()
         .destination("destination")
         .source("source")
         .build();

  • Method Details

    • getDestination

      @Stability(Stable) @Nullable default String getDestination()
      The location to put the parsed key value pair into.

      Default: - Placed under root of log event

    • 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 ParseJSONProperty.Builder builder()
      Returns:
      a ParseJSONProperty.Builder of ParseJSONProperty