interface CfnSubscriptionFilterMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Logs.Mixins.CfnSubscriptionFilterMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awslogs/mixins#CfnSubscriptionFilterMixinProps
Java	software.amazon.awscdk.mixins.preview.services.logs.mixins.CfnSubscriptionFilterMixinProps
Python	aws_cdk.mixins_preview.aws_logs.mixins.CfnSubscriptionFilterMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_logs » mixins » CfnSubscriptionFilterMixinProps

Properties for CfnSubscriptionFilterPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as logs_mixins } from '@aws-cdk/mixins-preview/aws-logs';
const cfnSubscriptionFilterMixinProps: logs_mixins.CfnSubscriptionFilterMixinProps = {
  applyOnTransformedLogs: false,
  destinationArn: 'destinationArn',
  distribution: 'distribution',
  emitSystemFields: ['emitSystemFields'],
  fieldSelectionCriteria: 'fieldSelectionCriteria',
  filterName: 'filterName',
  filterPattern: 'filterPattern',
  logGroupName: 'logGroupName',
  roleArn: 'roleArn',
};

Properties

Name	Type	Description
applyOnTransformedLogs?	boolean | IResolvable	This parameter is valid only for log groups that have an active log transformer.
destinationArn?	string	The Amazon Resource Name (ARN) of the destination.
distribution?	string	The method used to distribute log data to the destination, which can be either random or grouped by log stream.
emitSystemFields?	string[]	The list of system fields that are included in the log events sent to the subscription destination.
fieldSelectionCriteria?	string	The filter expression that specifies which log events are processed by this subscription filter based on system fields.
filterName?	string	The name of the subscription filter.
filterPattern?	string	The filtering expressions that restrict what gets delivered to the destination AWS resource.
logGroupName?	string	The log group to associate with the subscription filter.
roleArn?	string	The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream.

---

applyOnTransformedLogs?

Type: boolean | IResolvable (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-applyontransformedlogs

---

destinationArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the destination.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-destinationarn

---

distribution?

Type: string (optional)

The method used to distribute log data to the destination, which can be either random or grouped by log stream.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-distribution

---

emitSystemFields?

Type: string[] (optional)

The list of system fields that are included in the log events sent to the subscription destination.

Returns the emitSystemFields value if it was specified when the subscription filter was created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-emitsystemfields

---

fieldSelectionCriteria?

Type: string (optional)

The filter expression that specifies which log events are processed by this subscription filter based on system fields.

Returns the fieldSelectionCriteria value if it was specified when the subscription filter was created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-fieldselectioncriteria

---

filterName?

Type: string (optional)

The name of the subscription filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filtername

---

filterPattern?

Type: string (optional)

The filtering expressions that restrict what gets delivered to the destination AWS resource.

For more information about the filter pattern syntax, see Filter and Pattern Syntax .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filterpattern

---

logGroupName?

Type: string (optional)

The log group to associate with the subscription filter.

All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-loggroupname

---

roleArn?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-rolearn