LogSubscriptionFilterArgs class

The set of arguments for LogSubscriptionFilter. The set of arguments for LogSubscriptionFilter.

Constructors

LogSubscriptionFilterArgs({Input<bool?>? applyOnTransformedLogs, required Input<String> destinationArn, Input<String?>? distribution, Input<List<String>?>? emitSystemFields, required Input<String> filterPattern, required Input logGroup, Input<String?>? name, Input<String?>? region, Input<String?>? roleArn})
Creates a new LogSubscriptionFilterArgs. applyOnTransformedLogs Boolean to indicate whether to apply the subscription filter on the transformed version of the log events instead of the original ingested log events. Defaults to false. Valid only for log groups that have an active log transformer. destinationArn ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN. distribution 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. Valid values are "Random" and "ByLogStream". emitSystemFields List of system fields to include in the log events sent to the subscription destination. These fields provide source information for centralized log data in the forwarded payload. Valid values: "@aws.account", "@aws.region", "@source.log". To remove this argument after it has been set, specify an empty list [] explicitly to avoid perpetual differences. filterPattern Valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide. logGroup Name of the log group to associate the subscription filter with. name Name for the subscription filter. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. roleArn 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. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
const
LogSubscriptionFilterArgs.fromMap(Map<String, dynamic> map)
factory

Properties

applyOnTransformedLogs → Input<bool?>?
Boolean to indicate whether to apply the subscription filter on the transformed version of the log events instead of the original ingested log events. Defaults to false. Valid only for log groups that have an active log transformer.
final
destinationArn → Input<String>
ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
final
distribution → Input<String?>?
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. Valid values are "Random" and "ByLogStream".
final
emitSystemFields → Input<List<String>?>?
List of system fields to include in the log events sent to the subscription destination. These fields provide source information for centralized log data in the forwarded payload. Valid values: "@aws.account", "@aws.region", "@source.log". To remove this argument after it has been set, specify an empty list [] explicitly to avoid perpetual differences.
final
filterPattern → Input<String>
Valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
final
hashCode int
The hash code for this object.
no setterinherited
logGroup → Input
Name of the log group to associate the subscription filter with.
final
name → Input<String?>?
Name for the subscription filter.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
roleArn → Input<String?>?
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. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited