AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the PutSubscriptionFilter operation. 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 PutLogEvents 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.
The following destinations are supported for subscription filters:
An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.
An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you
are updating an existing filter, you must specify the correct name in filterName
.
To perform a PutSubscriptionFilter
operation for any destination except a Lambda
function, you must also have the iam:PassRole
permission.
Namespace: Amazon.CloudWatchLogs.Model
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z
public class PutSubscriptionFilterRequest : AmazonCloudWatchLogsRequest IAmazonWebServiceRequest
The PutSubscriptionFilterRequest type exposes the following members
Name | Description | |
---|---|---|
PutSubscriptionFilterRequest() |
Name | Type | Description | |
---|---|---|---|
DestinationArn | System.String |
Gets and sets the property DestinationArn. The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:
|
|
Distribution | Amazon.CloudWatchLogs.Distribution |
Gets and sets the property 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. |
|
FilterName | System.String |
Gets and sets the property FilterName.
A name for the subscription filter. If you are updating an existing filter, you must
specify the correct name in |
|
FilterPattern | System.String |
Gets and sets the property FilterPattern. A filter pattern for subscribing to a filtered stream of log events. |
|
LogGroupName | System.String |
Gets and sets the property LogGroupName. The name of the log group. |
|
RoleArn | System.String |
Gets and sets the property 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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5