interface ListToMapProperty

Language	Type name
.NET	Amazon.CDK.AWS.Logs.ListToMapProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslogs#ListToMapProperty
Java	software.amazon.awscdk.services.logs.ListToMapProperty
Python	aws_cdk.aws_logs.ListToMapProperty
TypeScript (source)	aws-cdk-lib » aws_logs » ListToMapProperty

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 { 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

Name	Type	Description
key	string	The key of the field to be extracted as keys in the generated map.
source	string	The key in the log event that has a list of objects that will be converted to a map.
flatten?	boolean	A Boolean value to indicate whether the list will be flattened into single items.
flattenedElement?	string	If you set flatten to true, use flattenedElement to specify which element, first or last, to keep.
target?	string	The key of the field that will hold the generated map.
valueKey?	string	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.

---

key

Type: string

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

---

source

Type: string

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

---

flatten?

Type: boolean (optional, default: false)

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

---

flattenedElement?

Type: string (optional, default: Must be specified if flatten is true and if flatten is false, has no effect)

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.

---

target?

Type: string (optional, default: Stored at the root of the log event)

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

---

valueKey?

Type: string (optional, default: Original objects in the source list will be put into the values of the generated map)

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.