Package software.amazon.awscdk.services.logs

Interface CfnMetricFilterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMetricFilterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.580Z")
@Stability(Stable)
public interface CfnMetricFilterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMetricFilter.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.logs.*;
 CfnMetricFilterProps cfnMetricFilterProps = CfnMetricFilterProps.builder()
         .filterPattern("filterPattern")
         .logGroupName("logGroupName")
         .metricTransformations(List.of(MetricTransformationProperty.builder()
                 .metricName("metricName")
                 .metricNamespace("metricNamespace")
                 .metricValue("metricValue")
                 // the properties below are optional
                 .defaultValue(123)
                 .dimensions(List.of(DimensionProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .unit("unit")
                 .build()))
         // the properties below are optional
         .filterName("filterName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMetricFilterProps.Builder	A builder for CfnMetricFilterProps
static final class	CfnMetricFilterProps.Jsii$Proxy	An implementation for CfnMetricFilterProps

Method Summary

Modifier and Type	Method	Description
static CfnMetricFilterProps.Builder	builder()
default String	getFilterName()	The name of the metric filter.
String	getFilterPattern()	A filter pattern for extracting metric data out of ingested log events.
String	getLogGroupName()	The name of an existing log group that you want to associate with this metric filter.
Object	getMetricTransformations()	The metric transformations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFilterPattern

@Stability(Stable)
@NotNull
String getFilterPattern()

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

getLogGroupName

@Stability(Stable)
@NotNull
String getLogGroupName()

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

getMetricTransformations

@Stability(Stable)
@NotNull
Object getMetricTransformations()

The metric transformations.

See Also:

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

getFilterName

@Stability(Stable)
@Nullable
default String getFilterName()

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

builder

@Stability(Stable)
static CfnMetricFilterProps.Builder builder()

Returns:

a CfnMetricFilterProps.Builder of CfnMetricFilterProps