2.233.0

interface CfnMetricFilterMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Logs.Mixins.CfnMetricFilterMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awslogs/mixins#CfnMetricFilterMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.logs.mixins.CfnMetricFilterMixinProps
Pythonaws_cdk.mixins_preview.aws_logs.mixins.CfnMetricFilterMixinProps
TypeScript @aws-cdk/mixins-preview » aws_logs » mixins » CfnMetricFilterMixinProps

Properties for CfnMetricFilterPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.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 cfnMetricFilterMixinProps: logs_mixins.CfnMetricFilterMixinProps = {
  applyOnTransformedLogs: false,
  emitSystemFieldDimensions: ['emitSystemFieldDimensions'],
  fieldSelectionCriteria: 'fieldSelectionCriteria',
  filterName: 'filterName',
  filterPattern: 'filterPattern',
  logGroupName: 'logGroupName',
  metricTransformations: [{
    defaultValue: 123,
    dimensions: [{
      key: 'key',
      value: 'value',
    }],
    metricName: 'metricName',
    metricNamespace: 'metricNamespace',
    metricValue: 'metricValue',
    unit: 'unit',
  }],
};

Properties

NameTypeDescription
applyOnTransformedLogs?boolean | IResolvableThis parameter is valid only for log groups that have an active log transformer.
emitSystemFieldDimensions?string[]The list of system fields that are emitted as additional dimensions in the generated metrics.
fieldSelectionCriteria?stringThe filter expression that specifies which log events are processed by this metric filter based on system fields.
filterName?stringThe name of the metric filter.
filterPattern?stringA filter pattern for extracting metric data out of ingested log events.
logGroupName?stringThe name of an existing log group that you want to associate with this metric filter.
metricTransformations?IResolvable | (IResolvable | MetricTransformationProperty)[]The metric transformations.

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 metric 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-metricfilter.html#cfn-logs-metricfilter-applyontransformedlogs

emitSystemFieldDimensions?

Type: string[] (optional)

The list of system fields that are emitted as additional dimensions in the generated metrics.

Returns the emitSystemFieldDimensions value if it was specified when the metric filter was created.

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

fieldSelectionCriteria?

Type: string (optional)

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

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

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

filterName?

Type: string (optional)

The name of the metric filter.

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

filterPattern?

Type: string (optional)

A filter pattern for extracting metric data out of ingested log events.

For more information, see Filter and Pattern Syntax .

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

logGroupName?

Type: string (optional)

The name of an existing log group that you want to associate with this metric filter.

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

metricTransformations?

Type: IResolvable | (IResolvable | MetricTransformationProperty)[] (optional)

The metric transformations.

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

← PreviousNext →