cloudwatchlogs_put_subscription_filter: Creates or updates a subscription filter and associates it...

In paws.management: 'Amazon Web Services' Management & Governance Services

Creates or updates a subscription filter and associates it with the specified log group

Description

Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through put_log_events and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_subscription_filter/ for full documentation.

Usage

cloudwatchlogs_put_subscription_filter(
  logGroupName,
  filterName,
  filterPattern,
  destinationArn,
  roleArn = NULL,
  distribution = NULL
)

Arguments

logGroupName	[required] The name of the log group.
filterName	[required] A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. To find the name of the filter currently associated with a log group, use describe_subscription_filters.
filterPattern	[required] A filter pattern for subscribing to a filtered stream of log events.
destinationArn	[required] 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. If you're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see put_destination_policy. A Kinesis Data Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery. A Lambda function belonging to the same account as the subscription filter, for same-account delivery.
roleArn	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.
distribution	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 data stream.

paws.management documentation built on Sept. 12, 2024, 6:19 a.m.