interface CsvProperty

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

The CSV processor parses comma-separated values (CSV) from the log events into columns.

For more information about this processor including examples, see csv 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 csvProperty: logs.CsvProperty = {
  columns: ['columns'],
  delimiter: logs.DelimiterCharacter.COMMA,
  quoteCharacter: logs.QuoteCharacter.DOUBLE_QUOTE,
  source: 'source',
};

Properties

Name	Type	Description
columns?	string[]	An array of names to use for the columns in the transformed log event.
delimiter?	DelimiterCharacter	Character used to separate each column in the original comma-separated value log event.
quoteCharacter?	QuoteCharacter	Character used as a text qualifier for a single column of data.
source?	string	The path to the field in the log event that has the comma separated values to be parsed.

---

columns?

Type: string[] (optional, default: Column names ([column_1, column_2 ...]) are used)

An array of names to use for the columns in the transformed log event.

---

delimiter?

Type: DelimiterCharacter (optional, default: DelimiterCharacter.COMMA)

Character used to separate each column in the original comma-separated value log event.

---

quoteCharacter?

Type: QuoteCharacter (optional, default: QuoteCharacter.DOUBLE_QUOTE)

Character used as a text qualifier for a single column of data.

---

source?

Type: string (optional, default: '@message')

The path to the field in the log event that has the comma separated values to be parsed.