aws-cdk-lib.aws_logs.ListToMapProperty

ListToMapProperty Struct

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.

Source

aws-logs/lib/transformer.ts

Type last changed

v2.207.0 · 24 Jul 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from 'aws-cdk-lib';
const listToMapProperty: logs.ListToMapProperty = {
  key: 'key',
  source: 'source',

  // the properties below are optional
  flatten: false,
  flattenedElement: 'flattenedElement',
  target: 'target',
  valueKey: 'valueKey',
};

Properties

flattenbooleanflattenboolflattenBooleanFlattenboolFlatten*bool= false#

A Boolean value to indicate whether the list will be flattened into single items.

flattenedElementstringflattened_elementstrflattenedElementStringFlattenedElementstringFlattenedElement*string= Must be specified if flatten is …#

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

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

keystringkeystrkeyStringKeystringKey*stringrequired#

The key of the field to be extracted as keys in the generated map.

sourcestringsourcestrsourceStringSourcestringSource*stringrequired#

The key in the log event that has a list of objects that will be converted to a map.

targetstringtargetstrtargetStringTargetstringTarget*string= Stored at the root of the log ev…#

The key of the field that will hold the generated map.

default

Default: Stored at the root of the log event

valueKeystringvalue_keystrvalueKeyStringValueKeystringValueKey*string= Original objects in the source l…#

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

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