software.amazon.awscdk.services.logs

Interface CfnMetricFilter.MetricTransformationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMetricFilter.MetricTransformationProperty.Jsii$Proxy

Enclosing class:

CfnMetricFilter

@Stability(value=Stable)
public static interface CfnMetricFilter.MetricTransformationProperty
extends software.amazon.jsii.JsiiSerializable

`MetricTransformation` is a property of the `AWS::Logs::MetricFilter` resource that describes how to transform log streams into a CloudWatch metric.

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.*;
 MetricTransformationProperty metricTransformationProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnMetricFilter.MetricTransformationProperty.Builder	builder()
default Number	getDefaultValue() (Optional) The value to emit when a filter pattern does not match a log event.
default Object	getDimensions() `CfnMetricFilter.MetricTransformationProperty.Dimensions`.
String	getMetricName() The name of the CloudWatch metric.
String	getMetricNamespace() A custom namespace to contain your metric in CloudWatch.
String	getMetricValue() The value that is published to the CloudWatch metric.
default String	getUnit() `CfnMetricFilter.MetricTransformationProperty.Unit`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMetricName

@Stability(value=Stable)
 @NotNull
String getMetricName()

The name of the CloudWatch metric.

getMetricNamespace

@Stability(value=Stable)
 @NotNull
String getMetricNamespace()

A custom namespace to contain your metric in CloudWatch.

Use namespaces to group together metrics that are similar. For more information, see Namespaces .

getMetricValue

@Stability(value=Stable)
 @NotNull
String getMetricValue()

The value that is published to the CloudWatch metric.

For example, if you're counting the occurrences of a particular term like Error , specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $ followed by the name of the field that you specified in the filter pattern, such as $.size .

getDefaultValue

@Stability(value=Stable)
 @Nullable
default Number getDefaultValue()

(Optional) The value to emit when a filter pattern does not match a log event.

This value can be null.

getDimensions

@Stability(value=Stable)
 @Nullable
default Object getDimensions()

`CfnMetricFilter.MetricTransformationProperty.Dimensions`.

getUnit

@Stability(value=Stable)
 @Nullable
default String getUnit()

`CfnMetricFilter.MetricTransformationProperty.Unit`.

builder

@Stability(value=Stable)
static CfnMetricFilter.MetricTransformationProperty.Builder builder()

Returns:

a CfnMetricFilter.MetricTransformationProperty.Builder of CfnMetricFilter.MetricTransformationProperty