software.amazon.awscdk.services.cloudwatch

Enum Statistic

java.lang.Object

java.lang.Enum<Statistic>

software.amazon.awscdk.services.cloudwatch.Statistic

All Implemented Interfaces:

Serializable, Comparable<Statistic>

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:04.299Z")
 @Stability(value=Experimental)
public enum Statistic
extends Enum<Statistic>

(experimental) Statistic to use over the aggregation period.

Example:

 import software.amazon.awscdk.core.*;
 DeliveryStream deliveryStream;
 // Alarm that triggers when the per-second average of incoming bytes exceeds 90% of the current service limit
 MathExpression incomingBytesPercentOfLimit = MathExpression.Builder.create()
         .expression("incomingBytes / 300 / bytePerSecLimit")
         .usingMetrics(Map.of(
                 "incomingBytes", deliveryStream.metricIncomingBytes(MetricOptions.builder().statistic(Statistic.SUM).build()),
                 "bytePerSecLimit", deliveryStream.metric("BytesPerSecondLimit")))
         .build();
 Alarm.Builder.create(this, "Alarm")
         .metric(incomingBytesPercentOfLimit)
         .threshold(0.9)
         .evaluationPeriods(3)
         .build();
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE (experimental) The value of Sum / SampleCount during the specified period.
MAXIMUM (experimental) The highest value observed during the specified period.
MINIMUM (experimental) The lowest value observed during the specified period.
SAMPLE_COUNT (experimental) The count (number) of data points used for the statistical calculation.
SUM (experimental) All values submitted for the matching metric added together.

Method Summary

Modifier and Type	Method and Description
static Statistic	valueOf(String name) Returns the enum constant of this type with the specified name.
static Statistic[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SAMPLE_COUNT

@Stability(value=Experimental)
public static final Statistic SAMPLE_COUNT

(experimental) The count (number) of data points used for the statistical calculation.

AVERAGE

@Stability(value=Experimental)
public static final Statistic AVERAGE

(experimental) The value of Sum / SampleCount during the specified period.

SUM

@Stability(value=Experimental)
public static final Statistic SUM

(experimental) All values submitted for the matching metric added together.

This statistic can be useful for determining the total volume of a metric.

MINIMUM

@Stability(value=Experimental)
public static final Statistic MINIMUM

(experimental) The lowest value observed during the specified period.

You can use this value to determine low volumes of activity for your application.

MAXIMUM

@Stability(value=Experimental)
public static final Statistic MAXIMUM

(experimental) The highest value observed during the specified period.

You can use this value to determine high volumes of activity for your application.

Method Detail

values

public static Statistic[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Statistic c : Statistic.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Statistic valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null