Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

2.181.1

interface ParseKeyValueProperty

LanguageType name
.NETAmazon.CDK.AWS.Logs.CfnTransformer.ParseKeyValueProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslogs#CfnTransformer_ParseKeyValueProperty
Javasoftware.amazon.awscdk.services.logs.CfnTransformer.ParseKeyValueProperty
Pythonaws_cdk.aws_logs.CfnTransformer.ParseKeyValueProperty
TypeScript aws-cdk-lib » aws_logs » CfnTransformer » ParseKeyValueProperty

This processor parses a specified field in the original log event into key-value pairs.

For more information about this processor including examples, see parseKeyValue in the CloudWatch Logs User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsekeyvalue.html

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 parseKeyValueProperty: logs.CfnTransformer.ParseKeyValueProperty = {
  destination: 'destination',
  fieldDelimiter: 'fieldDelimiter',
  keyPrefix: 'keyPrefix',
  keyValueDelimiter: 'keyValueDelimiter',
  nonMatchValue: 'nonMatchValue',
  overwriteIfExists: false,
  source: 'source',
};

Properties

NameTypeDescription
destination?stringThe destination field to put the extracted key-value pairs into.
fieldDelimiter?stringThe field delimiter string that is used between key-value pairs in the original log events.
keyPrefix?stringIf you want to add a prefix to all transformed keys, specify it here.
keyValueDelimiter?stringThe delimiter string to use between the key and value in each pair in the transformed log event.
nonMatchValue?stringA value to insert into the value field in the result, when a key-value pair is not successfully split.
overwriteIfExists?boolean | IResolvableSpecifies whether to overwrite the value if the destination key already exists.
source?stringPath to the field in the log event that will be parsed.

destination?

Type: string (optional)

The destination field to put the extracted key-value pairs into.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsekeyvalue.html#cfn-logs-transformer-parsekeyvalue-destination

fieldDelimiter?

Type: string (optional)

The field delimiter string that is used between key-value pairs in the original log events.

If you omit this, the ampersand & character is used.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsekeyvalue.html#cfn-logs-transformer-parsekeyvalue-fielddelimiter

keyPrefix?

Type: string (optional)

If you want to add a prefix to all transformed keys, specify it here.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsekeyvalue.html#cfn-logs-transformer-parsekeyvalue-keyprefix

keyValueDelimiter?

Type: string (optional)

The delimiter string to use between the key and value in each pair in the transformed log event.

If you omit this, the equal = character is used.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsekeyvalue.html#cfn-logs-transformer-parsekeyvalue-keyvaluedelimiter

nonMatchValue?

Type: string (optional)

A value to insert into the value field in the result, when a key-value pair is not successfully split.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsekeyvalue.html#cfn-logs-transformer-parsekeyvalue-nonmatchvalue

overwriteIfExists?

Type: boolean | IResolvable (optional)

Specifies whether to overwrite the value if the destination key already exists.

If you omit this, the default is false .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsekeyvalue.html#cfn-logs-transformer-parsekeyvalue-overwriteifexists

source?

Type: string (optional)

Path to the field in the log event that will be parsed.

Use dot notation to access child fields. For example, store.book

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsekeyvalue.html#cfn-logs-transformer-parsekeyvalue-source

← PreviousNext →