Package software.amazon.awscdk.services.logs

Interface CfnTransformer.CsvProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTransformer.CsvProperty.Jsii$Proxy

Enclosing class:

CfnTransformer

@Stability(Stable)
public static interface CfnTransformer.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("delimiter")
         .quoteCharacter("quoteCharacter")
         .source("source")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-csv.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTransformer.CsvProperty.Builder	builder()
default List<String>	getColumns()	An array of names to use for the columns in the transformed log event.
default String	getDelimiter()	The character used to separate each column in the original comma-separated value log event.
default String	getQuoteCharacter()	The character used 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.

If you omit this, default column names ( [column_1, column_2 ...] ) are used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-csv.html#cfn-logs-transformer-csv-columns

getDelimiter

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

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

If you omit this, the processor looks for the comma , character as the delimiter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-csv.html#cfn-logs-transformer-csv-delimiter

getQuoteCharacter

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

The character used used as a text qualifier for a single column of data.

If you omit this, the double quotation mark " character is used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-csv.html#cfn-logs-transformer-csv-quotecharacter

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.

If you omit this value, the whole log message is processed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-csv.html#cfn-logs-transformer-csv-source

builder

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

Returns:

a CfnTransformer.CsvProperty.Builder of CfnTransformer.CsvProperty