software.amazon.awscdk.services.logs

Interface MetricFilterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, MetricFilterOptions

All Known Implementing Classes:

MetricFilterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.459Z")
 @Stability(value=Stable)
public interface MetricFilterProps
extends software.amazon.jsii.JsiiSerializable, MetricFilterOptions

Properties for a MetricFilter.

Example:

 LogGroup logGroup;
 MetricFilter mf = MetricFilter.Builder.create(this, "MetricFilter")
         .logGroup(logGroup)
         .metricNamespace("MyApp")
         .metricName("Latency")
         .filterPattern(FilterPattern.exists("$.latency"))
         .metricValue("$.latency")
         .build();
 //expose a metric from the metric filter
 Metric metric = mf.metric();
 //you can use the metric to create a new alarm
 //you can use the metric to create a new alarm
 Alarm.Builder.create(this, "alarm from metric filter")
         .metric(metric)
         .threshold(100)
         .evaluationPeriods(2)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static MetricFilterProps.Builder	builder()
ILogGroup	getLogGroup() The log group to create the filter on.

Methods inherited from interface software.amazon.awscdk.services.logs.MetricFilterOptions

getDefaultValue, getFilterPattern, getMetricName, getMetricNamespace, getMetricValue

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLogGroup

@Stability(value=Stable)
 @NotNull
ILogGroup getLogGroup()

The log group to create the filter on.

builder

@Stability(value=Stable)
static MetricFilterProps.Builder builder()

Specified by:

builder in interface MetricFilterOptions

Returns:

a MetricFilterProps.Builder of MetricFilterProps