Package software.amazon.awscdk.services.cloudwatch

Interface CfnAnomalyDetector.ConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnomalyDetector.ConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnAnomalyDetector

@Stability(Stable)
public static interface CfnAnomalyDetector.ConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.

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.*;
 ConfigurationProperty configurationProperty = ConfigurationProperty.builder()
         .excludedTimeRanges(List.of(RangeProperty.builder()
                 .endTime("endTime")
                 .startTime("startTime")
                 .build()))
         .metricTimeZone("metricTimeZone")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnomalyDetector.ConfigurationProperty.Builder	builder()
default Object	getExcludedTimeRanges()	Specifies an array of time ranges to exclude from use when the anomaly detection model is trained and updated.
default String	getMetricTimeZone()	The time zone to use for the metric.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExcludedTimeRanges

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

Specifies an array of time ranges to exclude from use when the anomaly detection model is trained and updated.

Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates or updates the model.

See Also:

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

getMetricTimeZone

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

The time zone to use for the metric.

This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database .

See Also:

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

builder

@Stability(Stable)
static CfnAnomalyDetector.ConfigurationProperty.Builder builder()

Returns:

a CfnAnomalyDetector.ConfigurationProperty.Builder of CfnAnomalyDetector.ConfigurationProperty