Class: AWSCDK::Logs::CfnTransformer::GrokProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Logs::CfnTransformer::GrokProperty

Defined in:

logs/cfn_transformer.rb

Overview

This processor uses pattern matching to parse and structure unstructured data.

This processor can also extract fields from log messages.

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

See Also:

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

Instance Attribute Summary

• #match ⇒ String readonly

  The grok pattern to match against the log event.

• #source ⇒ String^? readonly

  The path to the field in the log event that you want to parse.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(match:, source: nil) ⇒ GrokProperty constructor

  A new instance of GrokProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(match:, source: nil) ⇒ GrokProperty

Returns a new instance of GrokProperty.

Parameters:

• match (String) —

  The grok pattern to match against the log event.

• source (String, nil) (defaults to: nil) —

  The path to the field in the log event that you want to parse.

# File 'logs/cfn_transformer.rb', line 917

def initialize(match:, source: nil)
  @match = match
  Jsii::Type.check_type(@match, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "match")
  @source = source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "source") unless @source.nil?
end

Instance Attribute Details

#match ⇒ String (readonly)

The grok pattern to match against the log event.

For a list of supported grok patterns, see Supported grok patterns .

Returns:

• (String)

See Also:

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

# File 'logs/cfn_transformer.rb', line 930

def match
  @match
end

#source ⇒ String^? (readonly)

The path to the field in the log event that you want to parse.

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

Returns:

• (String, nil)

See Also:

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

# File 'logs/cfn_transformer.rb', line 937

def source
  @source
end

Class Method Details

.jsii_properties ⇒ Object

# File 'logs/cfn_transformer.rb', line 939

def self.jsii_properties
  {
    :match => "match",
    :source => "source",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'logs/cfn_transformer.rb', line 946

def to_jsii
  result = {}
  result.merge!({
    "match" => @match,
    "source" => @source,
  })
  result.compact
end