Package software.amazon.awscdk.services.cloudwatch

Interface CfnAnomalyDetectorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnomalyDetectorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:40.172Z")
@Stability(Stable)
public interface CfnAnomalyDetectorProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAnomalyDetector.

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.*;
 CfnAnomalyDetectorProps cfnAnomalyDetectorProps = CfnAnomalyDetectorProps.builder()
         .configuration(ConfigurationProperty.builder()
                 .excludedTimeRanges(List.of(RangeProperty.builder()
                         .endTime("endTime")
                         .startTime("startTime")
                         .build()))
                 .metricTimeZone("metricTimeZone")
                 .build())
         .dimensions(List.of(DimensionProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .metricCharacteristics(MetricCharacteristicsProperty.builder()
                 .periodicSpikes(false)
                 .build())
         .metricMathAnomalyDetector(MetricMathAnomalyDetectorProperty.builder()
                 .metricDataQueries(List.of(MetricDataQueryProperty.builder()
                         .id("id")
                         // the properties below are optional
                         .accountId("accountId")
                         .expression("expression")
                         .label("label")
                         .metricStat(MetricStatProperty.builder()
                                 .metric(MetricProperty.builder()
                                         .metricName("metricName")
                                         .namespace("namespace")
                                         // the properties below are optional
                                         .dimensions(List.of(DimensionProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .period(123)
                                 .stat("stat")
                                 // the properties below are optional
                                 .unit("unit")
                                 .build())
                         .period(123)
                         .returnData(false)
                         .build()))
                 .build())
         .metricName("metricName")
         .namespace("namespace")
         .singleMetricAnomalyDetector(SingleMetricAnomalyDetectorProperty.builder()
                 .accountId("accountId")
                 .dimensions(List.of(DimensionProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .metricName("metricName")
                 .namespace("namespace")
                 .stat("stat")
                 .build())
         .stat("stat")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnomalyDetectorProps.Builder	builder()
default Object	getConfiguration()	Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model.
default Object	getDimensions()	The dimensions of the metric associated with the anomaly detection band.
default Object	getMetricCharacteristics()	Use this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models.
default Object	getMetricMathAnomalyDetector()	The CloudWatch metric math expression for this anomaly detector.
default String	getMetricName()	The name of the metric associated with the anomaly detection band.
default String	getNamespace()	The namespace of the metric associated with the anomaly detection band.
default Object	getSingleMetricAnomalyDetector()	The CloudWatch metric and statistic for this anomaly detector.
default String	getStat()	The statistic of the metric associated with the anomaly detection band.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfiguration

@Stability(Stable)
@Nullable
default Object getConfiguration()

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

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

See Also:

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

getDimensions

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

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

See Also:

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

getMetricCharacteristics

@Stability(Stable)
@Nullable
default Object getMetricCharacteristics()

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

Currently, it includes the PeriodicSpikes parameter.

See Also:

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

getMetricMathAnomalyDetector

@Stability(Stable)
@Nullable
default Object getMetricMathAnomalyDetector()

The CloudWatch metric math expression for this anomaly detector.

See Also:

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

getMetricName

@Stability(Stable)
@Nullable
default String getMetricName()

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

See Also:

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

getNamespace

@Stability(Stable)
@Nullable
default String getNamespace()

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

See Also:

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

getSingleMetricAnomalyDetector

@Stability(Stable)
@Nullable
default Object getSingleMetricAnomalyDetector()

The CloudWatch metric and statistic for this anomaly detector.

See Also:

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

getStat

@Stability(Stable)
@Nullable
default String getStat()

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

See Also:

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

builder

@Stability(Stable)
static CfnAnomalyDetectorProps.Builder builder()

Returns:

a CfnAnomalyDetectorProps.Builder of CfnAnomalyDetectorProps