Package software.amazon.awscdk.services.logs

Class MetricFilter

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.logs.MetricFilter
All Implemented Interfaces:
IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-21T06:34:10.802Z") @Stability(Stable) public class MetricFilter extends Resource
A filter that extracts information from CloudWatch Logs and emits to CloudWatch Metrics.

Example: 

 MetricFilter.Builder.create(this, "MetricFilter")
         .logGroup(logGroup)
         .metricNamespace("MyApp")
         .metricName("Latency")
         .filterPattern(FilterPattern.exists("$.latency"))
         .metricValue("$.latency")
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MetricFilter.Builder
    A fluent builder for MetricFilter.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    MetricFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    MetricFilter(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    MetricFilter(software.constructs.Construct scope, String id, MetricFilterProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Metric
    metric()
    Return the given named metric for this Metric Filter.
    Metric
    metric(MetricOptions props)
    Return the given named metric for this Metric Filter.

    Methods inherited from class software.amazon.awscdk.Resource

    applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • MetricFilter

      protected MetricFilter(software.amazon.jsii.JsiiObjectRef objRef)

    • MetricFilter

      protected MetricFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • MetricFilter

      @Stability(Stable) public MetricFilter(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull MetricFilterProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • metric

      @Stability(Stable) @NotNull public Metric metric(@Nullable MetricOptions props)
      Return the given named metric for this Metric Filter.

      Default: avg over 5 minutes

      Parameters:
      props -

    • metric

      @Stability(Stable) @NotNull public Metric metric()
      Return the given named metric for this Metric Filter.

      Default: avg over 5 minutes