You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudWatchLogs::Types::PutSubscriptionFilterRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutSubscriptionFilterRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  log_group_name: "LogGroupName", # required
  filter_name: "FilterName", # required
  filter_pattern: "FilterPattern", # required
  destination_arn: "DestinationArn", # required
  role_arn: "RoleArn",
  distribution: "Random", # accepts Random, ByLogStream
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#destination_arn ⇒ String

The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

  • An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

Returns:

  • (String) —

    The ARN of the destination to deliver matching log events to.

#distribution ⇒ String

The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream.

Possible values:

  • Random
  • ByLogStream

Returns:

  • (String) —

    The method used to distribute log data to the destination.

#filter_name ⇒ String

A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.

Returns:

  • (String) —

    A name for the subscription filter.

#filter_pattern ⇒ String

A filter pattern for subscribing to a filtered stream of log events.

Returns:

  • (String) —

    A filter pattern for subscribing to a filtered stream of log events.

#log_group_name ⇒ String

The name of the log group.

Returns:

  • (String) —

    The name of the log group.

#role_arn ⇒ String

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don\'t need to provide the ARN when you are working with a logical destination for cross-account delivery.

Returns:

  • (String) —

    The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream.