Class CfnTransformerPropsMixin.CsvProperty

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

Inheritance

object

CfnTransformerPropsMixin.CsvProperty

Implements

CfnTransformerPropsMixin.ICsvProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Logs

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnTransformerPropsMixin.CsvProperty : CfnTransformerPropsMixin.ICsvProperty

Syntax (vb)

Public Class CfnTransformerPropsMixin.CsvProperty Implements CfnTransformerPropsMixin.ICsvProperty

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Logs;

             var csvProperty = new CsvProperty {
                 Columns = new [] { "columns" },
                 Delimiter = "delimiter",
                 QuoteCharacter = "quoteCharacter",
                 Source = "source"
             };

Synopsis

Constructors

CsvProperty()

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

Properties

Columns	An array of names to use for the columns in the transformed log event.
Delimiter	The character used to separate each column in the original comma-separated value log event.
QuoteCharacter	The character used used as a text qualifier for a single column of data.
Source	The path to the field in the log event that has the comma separated values to be parsed.

Constructors

CsvProperty()

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

public CsvProperty()

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Logs;

             var csvProperty = new CsvProperty {
                 Columns = new [] { "columns" },
                 Delimiter = "delimiter",
                 QuoteCharacter = "quoteCharacter",
                 Source = "source"
             };

Properties

Columns

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

public string[]? Columns { get; set; }

Property Value

string[]

Remarks

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

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

Delimiter

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

public string? Delimiter { get; set; }

Property Value

string

Remarks

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

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

QuoteCharacter

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

public string? QuoteCharacter { get; set; }

Property Value

string

Remarks

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

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

Source

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

public string? Source { get; set; }

Property Value

string

Remarks

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

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

Implements

CfnTransformerPropsMixin.ICsvProperty