Package software.amazon.awscdk.services.logs

Interface CsvProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CsvProperty.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:13.196Z")
@Stability(Stable)
public interface CsvProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.logs.*;
 CsvProperty csvProperty = CsvProperty.builder()
         .columns(List.of("columns"))
         .delimiter(DelimiterCharacter.COMMA)
         .quoteCharacter(QuoteCharacter.DOUBLE_QUOTE)
         .source("source")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CsvProperty.Builder	builder()
default List<String>	getColumns()	An array of names to use for the columns in the transformed log event.
default DelimiterCharacter	getDelimiter()	Character used to separate each column in the original comma-separated value log event.
default QuoteCharacter	getQuoteCharacter()	Character used as a text qualifier for a single column of data.
default String	getSource()	The path to the field in the log event that has the comma separated values to be parsed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumns

@Stability(Stable)
@Nullable
default List<String> getColumns()

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

Default: - Column names ([column_1, column_2 ...]) are used

getDelimiter

@Stability(Stable)
@Nullable
default DelimiterCharacter getDelimiter()

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

Default: DelimiterCharacter.COMMA

getQuoteCharacter

@Stability(Stable)
@Nullable
default QuoteCharacter getQuoteCharacter()

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

Default: QuoteCharacter.DOUBLE_QUOTE

getSource

@Stability(Stable)
@Nullable
default String getSource()

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

Default: '@message'

builder

@Stability(Stable)
static CsvProperty.Builder builder()

Returns:

a CsvProperty.Builder of CsvProperty