SubscriptionFilter
Represents a subscription filter.
Contents
- applyOnTransformedLogs
-
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.Type: Boolean
Required: No
- creationTime
-
The creation time of the subscription filter, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC
.Type: Long
Valid Range: Minimum value of 0.
Required: No
- destinationArn
-
The Amazon Resource Name (ARN) of the destination.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- distribution
-
The method used to distribute log data to the destination, which can be either random or grouped by log stream.
Type: String
Valid Values:
Random | ByLogStream
Required: No
- filterName
-
The name of the subscription filter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[^:*]*
Required: No
- filterPattern
-
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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- logGroupName
-
The name of the log group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\.\-_/#A-Za-z0-9]+
Required: No
- roleArn
-
Type: String
Length Constraints: Minimum length of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: