Package software.amazon.awscdk.services.cloudwatch

Interface CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty.Jsii$Proxy

Enclosing class:

CfnAnomalyDetector

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

Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input.

If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account.

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.*;
 SingleMetricAnomalyDetectorProperty singleMetricAnomalyDetectorProperty = SingleMetricAnomalyDetectorProperty.builder()
         .accountId("accountId")
         .dimensions(List.of(DimensionProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .metricName("metricName")
         .namespace("namespace")
         .stat("stat")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty.Builder	builder()
default String	getAccountId()	If the CloudWatch metric that provides the time series that the anomaly detector uses as input is in another account, specify that account ID here.
default Object	getDimensions()	The metric dimensions to create the anomaly detection model for.
default String	getMetricName()	The name of the metric to create the anomaly detection model for.
default String	getNamespace()	The namespace of the metric to create the anomaly detection model for.
default String	getStat()	The statistic to use for the metric and anomaly detection model.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccountId

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

If the CloudWatch metric that provides the time series that the anomaly detector uses as input is in another account, specify that account ID here.

If you omit this parameter, the current account is used.

See Also:

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

getDimensions

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

The metric dimensions to create the anomaly detection model for.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAnomalyDetector.DimensionProperty>

See Also:

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

getMetricName

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

The name of the metric to create the anomaly detection model for.

See Also:

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

getNamespace

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

The namespace of the metric to create the anomaly detection model for.

See Also:

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

getStat

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

The statistic to use for the metric and anomaly detection model.

See Also:

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

builder

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

Returns:

a CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty.Builder of CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty