Class: Aws::CloudWatchLogs::Types::SubscriptionFilter

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::SubscriptionFilter

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

Represents a subscription filter.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #apply_on_transformed_logs ⇒ Boolean

  This parameter is valid only for log groups that have an active log transformer.

• #creation_time ⇒ Integer

  The creation time of the subscription filter, expressed as the number of milliseconds after ‘Jan 1, 1970 00:00:00 UTC`.

• #destination_arn ⇒ String

  The Amazon Resource Name (ARN) of the destination.

• #distribution ⇒ String

  The method used to distribute log data to the destination, which can be either random or grouped by log stream.

• #emit_system_fields ⇒ Array<String>

  The list of system fields that are included in the log events sent to the subscription destination.

• #field_selection_criteria ⇒ String

  The filter expression that specifies which log events are processed by this subscription filter based on system fields.

• #filter_name ⇒ String

  The name of the subscription filter.

• #filter_pattern ⇒ String

  A symbolic description of how CloudWatch Logs should interpret the data in each log event.

• #log_group_name ⇒ String

  The name of the log group.

• #role_arn ⇒ String

Instance Attribute Details

#apply_on_transformed_logs ⇒ Boolean

This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see [PutTransformer].

If this value is true, the subscription filter is applied on the transformed version of the log events instead of the original ingested log events.

[1]: docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html

Returns:

• (Boolean)

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

class SubscriptionFilter < Struct.new(
  :filter_name,
  :log_group_name,
  :filter_pattern,
  :destination_arn,
  :role_arn,
  :distribution,
  :apply_on_transformed_logs,
  :creation_time,
  :field_selection_criteria,
  :emit_system_fields)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Integer

The creation time of the subscription filter, expressed as the number of milliseconds after ‘Jan 1, 1970 00:00:00 UTC`.

Returns:

• (Integer)

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

class SubscriptionFilter < Struct.new(
  :filter_name,
  :log_group_name,
  :filter_pattern,
  :destination_arn,
  :role_arn,
  :distribution,
  :apply_on_transformed_logs,
  :creation_time,
  :field_selection_criteria,
  :emit_system_fields)
  SENSITIVE = []
  include Aws::Structure
end

#destination_arn ⇒ String

The Amazon Resource Name (ARN) of the destination.

Returns:

• (String)

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

class SubscriptionFilter < Struct.new(
  :filter_name,
  :log_group_name,
  :filter_pattern,
  :destination_arn,
  :role_arn,
  :distribution,
  :apply_on_transformed_logs,
  :creation_time,
  :field_selection_criteria,
  :emit_system_fields)
  SENSITIVE = []
  include Aws::Structure
end

#distribution ⇒ String

The method used to distribute log data to the destination, which can be either random or grouped by log stream.

Returns:

• (String)

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

class SubscriptionFilter < Struct.new(
  :filter_name,
  :log_group_name,
  :filter_pattern,
  :destination_arn,
  :role_arn,
  :distribution,
  :apply_on_transformed_logs,
  :creation_time,
  :field_selection_criteria,
  :emit_system_fields)
  SENSITIVE = []
  include Aws::Structure
end

#emit_system_fields ⇒ Array<String>

The list of system fields that are included in the log events sent to the subscription destination. Returns the emitSystemFields value if it was specified when the subscription filter was created.

Returns:

• (Array<String>)

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

class SubscriptionFilter < Struct.new(
  :filter_name,
  :log_group_name,
  :filter_pattern,
  :destination_arn,
  :role_arn,
  :distribution,
  :apply_on_transformed_logs,
  :creation_time,
  :field_selection_criteria,
  :emit_system_fields)
  SENSITIVE = []
  include Aws::Structure
end

#field_selection_criteria ⇒ String

The filter expression that specifies which log events are processed by this subscription filter based on system fields. Returns the fieldSelectionCriteria value if it was specified when the subscription filter was created.

Returns:

• (String)

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

class SubscriptionFilter < Struct.new(
  :filter_name,
  :log_group_name,
  :filter_pattern,
  :destination_arn,
  :role_arn,
  :distribution,
  :apply_on_transformed_logs,
  :creation_time,
  :field_selection_criteria,
  :emit_system_fields)
  SENSITIVE = []
  include Aws::Structure
end

#filter_name ⇒ String

The name of the subscription filter.

Returns:

• (String)

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

class SubscriptionFilter < Struct.new(
  :filter_name,
  :log_group_name,
  :filter_pattern,
  :destination_arn,
  :role_arn,
  :distribution,
  :apply_on_transformed_logs,
  :creation_time,
  :field_selection_criteria,
  :emit_system_fields)
  SENSITIVE = []
  include Aws::Structure
end

#filter_pattern ⇒ String

A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

Returns:

• (String)

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

class SubscriptionFilter < Struct.new(
  :filter_name,
  :log_group_name,
  :filter_pattern,
  :destination_arn,
  :role_arn,
  :distribution,
  :apply_on_transformed_logs,
  :creation_time,
  :field_selection_criteria,
  :emit_system_fields)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name ⇒ String

The name of the log group.

Returns:

• (String)

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

class SubscriptionFilter < Struct.new(
  :filter_name,
  :log_group_name,
  :filter_pattern,
  :destination_arn,
  :role_arn,
  :distribution,
  :apply_on_transformed_logs,
  :creation_time,
  :field_selection_criteria,
  :emit_system_fields)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

Returns:

• (String)

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

class SubscriptionFilter < Struct.new(
  :filter_name,
  :log_group_name,
  :filter_pattern,
  :destination_arn,
  :role_arn,
  :distribution,
  :apply_on_transformed_logs,
  :creation_time,
  :field_selection_criteria,
  :emit_system_fields)
  SENSITIVE = []
  include Aws::Structure
end