Class: Aws::CloudWatchLogs::Types::ListToMap

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::ListToMap

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

This processor takes a list of objects that contain key fields, and converts them into a map of target keys.

For more information about this processor including examples, see [ listToMap] in the *CloudWatch Logs User Guide*.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-listToMap

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #flatten ⇒ Boolean

  A Boolean value to indicate whether the list will be flattened into single items.

• #flattened_element ⇒ String

  If you set flatten to true, use flattenedElement to specify which element, first or last, to keep.

• #key ⇒ String

  The key of the field to be extracted as keys in the generated map.

• #source ⇒ String

  The key in the log event that has a list of objects that will be converted to a map.

• #target ⇒ String

  The key of the field that will hold the generated map.

• #value_key ⇒ String

  If this is specified, the values that you specify in this parameter will be extracted from the source objects and put into the values of the generated map.

Instance Attribute Details

#flatten ⇒ Boolean

A Boolean value to indicate whether the list will be flattened into single items. Specify true to flatten the list. The default is false

Returns:

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 5232

class ListToMap < Struct.new(
  :source,
  :key,
  :value_key,
  :target,
  :flatten,
  :flattened_element)
  SENSITIVE = []
  include Aws::Structure
end

#flattened_element ⇒ String

If you set flatten to true, use flattenedElement to specify which element, first or last, to keep.

You must specify this parameter if flatten is true

Returns:

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 5232

class ListToMap < Struct.new(
  :source,
  :key,
  :value_key,
  :target,
  :flatten,
  :flattened_element)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ String

The key of the field to be extracted as keys in the generated map

Returns:

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 5232

class ListToMap < Struct.new(
  :source,
  :key,
  :value_key,
  :target,
  :flatten,
  :flattened_element)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ String

The key in the log event that has a list of objects that will be converted to a map.

Returns:

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 5232

class ListToMap < Struct.new(
  :source,
  :key,
  :value_key,
  :target,
  :flatten,
  :flattened_element)
  SENSITIVE = []
  include Aws::Structure
end

#target ⇒ String

The key of the field that will hold the generated map

Returns:

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 5232

class ListToMap < Struct.new(
  :source,
  :key,
  :value_key,
  :target,
  :flatten,
  :flattened_element)
  SENSITIVE = []
  include Aws::Structure
end

#value_key ⇒ String

If this is specified, the values that you specify in this parameter will be extracted from the source objects and put into the values of the generated map. Otherwise, original objects in the source list will be put into the values of the generated map.

Returns:

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 5232

class ListToMap < Struct.new(
  :source,
  :key,
  :value_key,
  :target,
  :flatten,
  :flattened_element)
  SENSITIVE = []
  include Aws::Structure
end