Package software.amazon.awscdk.services.logs

Interface GrokProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
GrokProperty.Jsii$Proxy
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:13.216Z") @Stability(Stable) public interface GrokProperty extends software.amazon.jsii.JsiiSerializable
This processor uses pattern matching to parse and structure unstructured data.

This processor can also extract fields from log messages. For more information about this processor including examples, see grok 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.*;
 GrokProperty grokProperty = GrokProperty.builder()
         .match("match")
         // the properties below are optional
         .source("source")
         .build();

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static GrokProperty.Builder
    builder()
     
    String
    getMatch()
    The grok pattern to match against the log event.
    default String
    getSource()
    The path to the field in the log event that you want to parse.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getMatch

      @Stability(Stable) @NotNull String getMatch()
      The grok pattern to match against the log event.

      For a list of supported grok patterns, see Supported grok patterns in the CloudWatch Logs User Guide.

    • getSource

      @Stability(Stable) @Nullable default String getSource()
      The path to the field in the log event that you want to parse.

      Default: '@message'

    • builder

      @Stability(Stable) static GrokProperty.Builder builder()
      Returns:
      a GrokProperty.Builder of GrokProperty