software.amazon.awscdk.services.cloudwatch

Interface MetricExpressionConfig

All Known Implementing Classes:

MetricExpressionConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:28.658Z")
public interface MetricExpressionConfig

Properties for a concrete 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.cloudwatch.*;
 Metric metric;
 MetricExpressionConfig metricExpressionConfig = MetricExpressionConfig.builder()
         .expression("expression")
         .period(123)
         .usingMetrics(Map.of(
                 "usingMetricsKey", metric))
         // the properties below are optional
         .searchAccount("searchAccount")
         .searchRegion("searchRegion")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static MetricExpressionConfig.Builder	builder()
java.lang.String	getExpression() Math expression for the metric.
java.lang.Number	getPeriod() How many seconds to aggregate over.
default java.lang.String	getSearchAccount() Account to evaluate search expressions within.
default java.lang.String	getSearchRegion() Region to evaluate search expressions within.
java.util.Map<java.lang.String,IMetric>	getUsingMetrics() Metrics used in the math expression.

Method Detail

getExpression

java.lang.String getExpression()

Math expression for the metric.

getPeriod

java.lang.Number getPeriod()

How many seconds to aggregate over.

getUsingMetrics

java.util.Map<java.lang.String,IMetric> getUsingMetrics()

Metrics used in the math expression.

getSearchAccount

default java.lang.String getSearchAccount()

Account to evaluate search expressions within.

Default: - Deployment account.

getSearchRegion

default java.lang.String getSearchRegion()

Region to evaluate search expressions within.

Default: - Deployment region.

builder

static MetricExpressionConfig.Builder builder()

Returns:

a MetricExpressionConfig.Builder of MetricExpressionConfig