Class CfnMetricFilterMixinProps

Properties for CfnMetricFilterPropsMixin.

Inheritance

object

CfnMetricFilterMixinProps

Implements

ICfnMetricFilterMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Logs

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnMetricFilterMixinProps : ICfnMetricFilterMixinProps

Syntax (vb)

Public Class CfnMetricFilterMixinProps Implements ICfnMetricFilterMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Logs;

             var cfnMetricFilterMixinProps = new CfnMetricFilterMixinProps {
                 ApplyOnTransformedLogs = false,
                 EmitSystemFieldDimensions = new [] { "emitSystemFieldDimensions" },
                 FieldSelectionCriteria = "fieldSelectionCriteria",
                 FilterName = "filterName",
                 FilterPattern = "filterPattern",
                 LogGroupName = "logGroupName",
                 MetricTransformations = new [] { new MetricTransformationProperty {
                     DefaultValue = 123,
                     Dimensions = new [] { new DimensionProperty {
                         Key = "key",
                         Value = "value"
                     } },
                     MetricName = "metricName",
                     MetricNamespace = "metricNamespace",
                     MetricValue = "metricValue",
                     Unit = "unit"
                 } }
             };

Synopsis

Constructors

CfnMetricFilterMixinProps()

Properties for CfnMetricFilterPropsMixin.

Properties

ApplyOnTransformedLogs	This parameter is valid only for log groups that have an active log transformer.
EmitSystemFieldDimensions	The list of system fields that are emitted as additional dimensions in the generated metrics.
FieldSelectionCriteria	The filter expression that specifies which log events are processed by this metric filter based on system fields.
FilterName	The name of the metric filter.
FilterPattern	A filter pattern for extracting metric data out of ingested log events.
LogGroupName	The name of an existing log group that you want to associate with this metric filter.
MetricTransformations	The metric transformations.

Constructors

CfnMetricFilterMixinProps()

Properties for CfnMetricFilterPropsMixin.

public CfnMetricFilterMixinProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Logs;

             var cfnMetricFilterMixinProps = new CfnMetricFilterMixinProps {
                 ApplyOnTransformedLogs = false,
                 EmitSystemFieldDimensions = new [] { "emitSystemFieldDimensions" },
                 FieldSelectionCriteria = "fieldSelectionCriteria",
                 FilterName = "filterName",
                 FilterPattern = "filterPattern",
                 LogGroupName = "logGroupName",
                 MetricTransformations = new [] { new MetricTransformationProperty {
                     DefaultValue = 123,
                     Dimensions = new [] { new DimensionProperty {
                         Key = "key",
                         Value = "value"
                     } },
                     MetricName = "metricName",
                     MetricNamespace = "metricNamespace",
                     MetricValue = "metricValue",
                     Unit = "unit"
                 } }
             };

Properties

ApplyOnTransformedLogs

This parameter is valid only for log groups that have an active log transformer.

public object? ApplyOnTransformedLogs { get; set; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-applyontransformedlogs

Type union: either bool or IResolvable

EmitSystemFieldDimensions

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

public string[]? EmitSystemFieldDimensions { get; set; }

Property Value

string[]

Remarks

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

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

FieldSelectionCriteria

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

public string? FieldSelectionCriteria { get; set; }

Property Value

string

Remarks

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

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

FilterName

The name of the metric filter.

public string? FilterName { get; set; }

Property Value

string

Remarks

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

FilterPattern

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

public string? FilterPattern { get; set; }

Property Value

string

Remarks

For more information, see Filter and Pattern Syntax .

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

LogGroupName

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

public object? LogGroupName { get; set; }

Property Value

object

Remarks

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

Type union: either string or ILogGroupRef

MetricTransformations

The metric transformations.

public object? MetricTransformations { get; set; }