CsvProperty

class aws_cdk.aws_logs.CsvProperty(*, columns=None, delimiter=None, quote_character=None, source=None)

Bases: object

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.

Parameters:

  • columns (Optional[Sequence[str]]) – An array of names to use for the columns in the transformed log event. Default: - Column names ([column_1, column_2 …]) are used

  • delimiter (Optional[DelimiterCharacter]) – Character used to separate each column in the original comma-separated value log event. Default: DelimiterCharacter.COMMA

  • quote_character (Optional[QuoteCharacter]) – Character used as a text qualifier for a single column of data. Default: QuoteCharacter.DOUBLE_QUOTE

  • source (Optional[str]) – The path to the field in the log event that has the comma separated values to be parsed. Default: ‘@message’

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_logs as logs

csv_property = logs.CsvProperty(
    columns=["columns"],
    delimiter=logs.DelimiterCharacter.COMMA,
    quote_character=logs.QuoteCharacter.DOUBLE_QUOTE,
    source="source"
)

Attributes

columns

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

Default:

  • Column names ([column_1, column_2 …]) are used

delimiter

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

Default:

DelimiterCharacter.COMMA

quote_character

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

Default:

QuoteCharacter.DOUBLE_QUOTE

source

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

Default:

‘@message’