Interface ICfnAnomalyDetectorProps

Properties for defining a CfnAnomalyDetector.

Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnAnomalyDetectorProps
Syntax (vb)
Public Interface ICfnAnomalyDetectorProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html

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.AWS.CloudWatch;

var cfnAnomalyDetectorProps = new CfnAnomalyDetectorProps {
    Configuration = new ConfigurationProperty {
        ExcludedTimeRanges = new [] { new RangeProperty {
            EndTime = "endTime",
            StartTime = "startTime"
        } },
        MetricTimeZone = "metricTimeZone"
    },
    Dimensions = new [] { new DimensionProperty {
        Name = "name",
        Value = "value"
    } },
    MetricCharacteristics = new MetricCharacteristicsProperty {
        PeriodicSpikes = false
    },
    MetricMathAnomalyDetector = new MetricMathAnomalyDetectorProperty {
        MetricDataQueries = new [] { new MetricDataQueryProperty {
            Id = "id",

            // the properties below are optional
            AccountId = "accountId",
            Expression = "expression",
            Label = "label",
            MetricStat = new MetricStatProperty {
                Metric = new MetricProperty {
                    MetricName = "metricName",
                    Namespace = "namespace",

                    // the properties below are optional
                    Dimensions = new [] { new DimensionProperty {
                        Name = "name",
                        Value = "value"
                    } }
                },
                Period = 123,
                Stat = "stat",

                // the properties below are optional
                Unit = "unit"
            },
            Period = 123,
            ReturnData = false
        } }
    },
    MetricName = "metricName",
    Namespace = "namespace",
    SingleMetricAnomalyDetector = new SingleMetricAnomalyDetectorProperty {
        AccountId = "accountId",
        Dimensions = new [] { new DimensionProperty {
            Name = "name",
            Value = "value"
        } },
        MetricName = "metricName",
        Namespace = "namespace",
        Stat = "stat"
    },
    Stat = "stat"
};

Synopsis

Properties

Configuration

Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model.
Dimensions

The dimensions of the metric associated with the anomaly detection band.
MetricCharacteristics

Use this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models.
MetricMathAnomalyDetector

The CloudWatch metric math expression for this anomaly detector.
MetricName

The name of the metric associated with the anomaly detection band.
Namespace

The namespace of the metric associated with the anomaly detection band.
SingleMetricAnomalyDetector

The CloudWatch metric and statistic for this anomaly detector.
Stat

The statistic of the metric associated with the anomaly detection band.

Properties

Configuration

Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model.

virtual object Configuration { get; }
Property Value

System.Object

Remarks

The configuration can also include the time zone to use for the metric.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-configuration

Dimensions

The dimensions of the metric associated with the anomaly detection band.

virtual object Dimensions { get; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-dimensions

MetricCharacteristics

Use this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models.

virtual object MetricCharacteristics { get; }
Property Value

System.Object

Remarks

Currently, it includes the PeriodicSpikes parameter.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metriccharacteristics

MetricMathAnomalyDetector

The CloudWatch metric math expression for this anomaly detector.

virtual object MetricMathAnomalyDetector { get; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricmathanomalydetector

MetricName

The name of the metric associated with the anomaly detection band.

virtual string MetricName { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricname

Namespace

The namespace of the metric associated with the anomaly detection band.

virtual string Namespace { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-namespace

SingleMetricAnomalyDetector

The CloudWatch metric and statistic for this anomaly detector.

virtual object SingleMetricAnomalyDetector { get; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector

Stat

The statistic of the metric associated with the anomaly detection band.

virtual string Stat { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-stat