software.amazon.awscdk.services.cloudwatch

Class CfnAnomalyDetector

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cloudwatch.CfnAnomalyDetector

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.220Z")
 @Stability(value=Stable)
public class CfnAnomalyDetector
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudWatch::AnomalyDetector`.

The AWS::CloudWatch::AnomalyDetector type specifies an anomaly detection band for a certain metric and statistic. The band represents the expected "normal" range for the metric values. Anomaly detection bands can be used for visualization of a metric's expected values, and for alarms.

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.*;
 CfnAnomalyDetector cfnAnomalyDetector = CfnAnomalyDetector.Builder.create(this, "MyCfnAnomalyDetector")
         .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()))
         .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()
                 .dimensions(List.of(DimensionProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .metricName("metricName")
                 .namespace("namespace")
                 .stat("stat")
                 .build())
         .stat("stat")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAnomalyDetector.Builder A fluent builder for CfnAnomalyDetector.
static interface	CfnAnomalyDetector.ConfigurationProperty Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model.
static interface	CfnAnomalyDetector.DimensionProperty A dimension is a name/value pair that is part of the identity of a metric.
static interface	CfnAnomalyDetector.MetricDataQueryProperty This structure is used in both `GetMetricData` and `PutMetricAlarm` .
static interface	CfnAnomalyDetector.MetricMathAnomalyDetectorProperty Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input.
static interface	CfnAnomalyDetector.MetricProperty Represents a specific metric.
static interface	CfnAnomalyDetector.MetricStatProperty This structure defines the metric to be returned, along with the statistics, period, and units.
static interface	CfnAnomalyDetector.RangeProperty Each `Range` specifies one range of days or times to exclude from use for training or updating an anomaly detection model.
static interface	CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAnomalyDetector(Construct scope, String id) Create a new `AWS::CloudWatch::AnomalyDetector`.
	CfnAnomalyDetector(Construct scope, String id, CfnAnomalyDetectorProps props) Create a new `AWS::CloudWatch::AnomalyDetector`.
protected	CfnAnomalyDetector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAnomalyDetector(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
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.
Object	getDimensions() The dimensions of the metric associated with the anomaly detection band.
Object	getMetricMathAnomalyDetector() The CloudWatch metric math expression for this anomaly detector.
String	getMetricName() The name of the metric associated with the anomaly detection band.
String	getNamespace() The namespace of the metric associated with the anomaly detection band.
Object	getSingleMetricAnomalyDetector() The CloudWatch metric and statistic for this anomaly detector.
String	getStat() The statistic of the metric associated with the anomaly detection band.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConfiguration(CfnAnomalyDetector.ConfigurationProperty value) Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model.
void	setConfiguration(IResolvable value) Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model.
void	setDimensions(IResolvable value) The dimensions of the metric associated with the anomaly detection band.
void	setDimensions(List<Object> value) The dimensions of the metric associated with the anomaly detection band.
void	setMetricMathAnomalyDetector(CfnAnomalyDetector.MetricMathAnomalyDetectorProperty value) The CloudWatch metric math expression for this anomaly detector.
void	setMetricMathAnomalyDetector(IResolvable value) The CloudWatch metric math expression for this anomaly detector.
void	setMetricName(String value) The name of the metric associated with the anomaly detection band.
void	setNamespace(String value) The namespace of the metric associated with the anomaly detection band.
void	setSingleMetricAnomalyDetector(CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty value) The CloudWatch metric and statistic for this anomaly detector.
void	setSingleMetricAnomalyDetector(IResolvable value) The CloudWatch metric and statistic for this anomaly detector.
void	setStat(String value) The statistic of the metric associated with the anomaly detection band.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAnomalyDetector

protected CfnAnomalyDetector(software.amazon.jsii.JsiiObjectRef objRef)

CfnAnomalyDetector

protected CfnAnomalyDetector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAnomalyDetector

@Stability(value=Stable)
public CfnAnomalyDetector(@NotNull
                                                   Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @Nullable
                                                   CfnAnomalyDetectorProps props)

Create a new `AWS::CloudWatch::AnomalyDetector`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnAnomalyDetector

@Stability(value=Stable)
public CfnAnomalyDetector(@NotNull
                                                   Construct scope,
                                                   @NotNull
                                                   String id)

Create a new `AWS::CloudWatch::AnomalyDetector`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfiguration

@Stability(value=Stable)
 @Nullable
public 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.

setConfiguration

@Stability(value=Stable)
public void setConfiguration(@Nullable
                                                      IResolvable value)

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.

setConfiguration

@Stability(value=Stable)
public void setConfiguration(@Nullable
                                                      CfnAnomalyDetector.ConfigurationProperty value)

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.

getDimensions

@Stability(value=Stable)
 @Nullable
public Object getDimensions()

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

setDimensions

@Stability(value=Stable)
public void setDimensions(@Nullable
                                                   IResolvable value)

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

setDimensions

@Stability(value=Stable)
public void setDimensions(@Nullable
                                                   List<Object> value)

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

getMetricMathAnomalyDetector

@Stability(value=Stable)
 @Nullable
public Object getMetricMathAnomalyDetector()

The CloudWatch metric math expression for this anomaly detector.

setMetricMathAnomalyDetector

@Stability(value=Stable)
public void setMetricMathAnomalyDetector(@Nullable
                                                                  IResolvable value)

The CloudWatch metric math expression for this anomaly detector.

setMetricMathAnomalyDetector

@Stability(value=Stable)
public void setMetricMathAnomalyDetector(@Nullable
                                                                  CfnAnomalyDetector.MetricMathAnomalyDetectorProperty value)

The CloudWatch metric math expression for this anomaly detector.

getMetricName

@Stability(value=Stable)
 @Nullable
public String getMetricName()

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

setMetricName

@Stability(value=Stable)
public void setMetricName(@Nullable
                                                   String value)

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

getNamespace

@Stability(value=Stable)
 @Nullable
public String getNamespace()

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

setNamespace

@Stability(value=Stable)
public void setNamespace(@Nullable
                                                  String value)

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

getSingleMetricAnomalyDetector

@Stability(value=Stable)
 @Nullable
public Object getSingleMetricAnomalyDetector()

The CloudWatch metric and statistic for this anomaly detector.

setSingleMetricAnomalyDetector

@Stability(value=Stable)
public void setSingleMetricAnomalyDetector(@Nullable
                                                                    IResolvable value)

The CloudWatch metric and statistic for this anomaly detector.

setSingleMetricAnomalyDetector

@Stability(value=Stable)
public void setSingleMetricAnomalyDetector(@Nullable
                                                                    CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty value)

The CloudWatch metric and statistic for this anomaly detector.

getStat

@Stability(value=Stable)
 @Nullable
public String getStat()

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

setStat

@Stability(value=Stable)
public void setStat(@Nullable
                                             String value)

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