Show / Hide Table of Contents

Interface IAnomalyDetectionMetricOptions

Properties needed to make an anomaly detection alarm from a metric.

Inherited Members
IMathExpressionOptions.Color
IMathExpressionOptions.Label
IMathExpressionOptions.Period
IMathExpressionOptions.SearchAccount
IMathExpressionOptions.SearchRegion
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IAnomalyDetectionMetricOptions : IMathExpressionOptions
Syntax (vb)
Public Interface IAnomalyDetectionMetricOptions Inherits IMathExpressionOptions
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.CloudWatch;

            Metric metric;

            var anomalyDetectionMetricOptions = new AnomalyDetectionMetricOptions {
                Metric = metric,

                // the properties below are optional
                Color = "color",
                Label = "label",
                Period = Duration.Minutes(30),
                SearchAccount = "searchAccount",
                SearchRegion = "searchRegion",
                StdDevs = 123
            };

Synopsis

Properties

Metric

The metric to add the alarm on.

StdDevs

The number of standard deviations to use for the anomaly detection band.

Properties

Metric

The metric to add the alarm on.

IMetric Metric { get; }
Property Value

IMetric

Remarks

Metric objects can be obtained from most resources, or you can construct custom Metric objects by instantiating one.

StdDevs

The number of standard deviations to use for the anomaly detection band.

double? StdDevs { get; }
Property Value

double?

Remarks

The higher the value, the wider the band.

    Default: 2

    Back to top Generated by DocFX