Package software.amazon.awscdk.services.logs

Interface ListToMapProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ListToMapProperty.Jsii$Proxy
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-07-29T17:51:03.394Z") @Stability(Stable) public interface ListToMapProperty extends software.amazon.jsii.JsiiSerializable
This processor takes a list of objects that contain key fields, and converts them into a map of target keys.

For more information about this processor including examples, see listToMap 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.*;
 ListToMapProperty listToMapProperty = ListToMapProperty.builder()
         .key("key")
         .source("source")
         // the properties below are optional
         .flatten(false)
         .flattenedElement("flattenedElement")
         .target("target")
         .valueKey("valueKey")
         .build();

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static ListToMapProperty.Builder
    builder()
     
    default Boolean
    getFlatten()
    A Boolean value to indicate whether the list will be flattened into single items.
    default String
    getFlattenedElement()
    If you set flatten to true, use flattenedElement to specify which element, first or last, to keep.
    String
    getKey()
    The key of the field to be extracted as keys in the generated map.
    String
    getSource()
    The key in the log event that has a list of objects that will be converted to a map.
    default String
    getTarget()
    The key of the field that will hold the generated map.
    default String
    getValueKey()
    If this is specified, the values that you specify in this parameter will be extracted from the source objects and put into the values of the generated map.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getKey

      @Stability(Stable) @NotNull String getKey()
      The key of the field to be extracted as keys in the generated map.

    • getSource

      @Stability(Stable) @NotNull String getSource()
      The key in the log event that has a list of objects that will be converted to a map.

    • getFlatten

      @Stability(Stable) @Nullable default Boolean getFlatten()
      A Boolean value to indicate whether the list will be flattened into single items.

      Default: false

    • getFlattenedElement

      @Stability(Stable) @Nullable default String getFlattenedElement()
      If you set flatten to true, use flattenedElement to specify which element, first or last, to keep.

      You must specify this parameter if flatten is true.

      Default: - Must be specified if flatten is true and if flatten is false, has no effect

    • getTarget

      @Stability(Stable) @Nullable default String getTarget()
      The key of the field that will hold the generated map.

      Default: - Stored at the root of the log event

    • getValueKey

      @Stability(Stable) @Nullable default String getValueKey()
      If this is specified, the values that you specify in this parameter will be extracted from the source objects and put into the values of the generated map.

      Default: - Original objects in the source list will be put into the values of the generated map

    • builder

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