Package software.amazon.awscdk.services.aps

Interface CfnAnomalyDetectorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnomalyDetectorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:29.055Z")
@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.aps.*;
 CfnAnomalyDetectorProps cfnAnomalyDetectorProps = CfnAnomalyDetectorProps.builder()
         .alias("alias")
         .configuration(AnomalyDetectorConfigurationProperty.builder()
                 .randomCutForest(RandomCutForestConfigurationProperty.builder()
                         .query("query")
                         // the properties below are optional
                         .ignoreNearExpectedFromAbove(IgnoreNearExpectedProperty.builder()
                                 .amount(123)
                                 .ratio(123)
                                 .build())
                         .ignoreNearExpectedFromBelow(IgnoreNearExpectedProperty.builder()
                                 .amount(123)
                                 .ratio(123)
                                 .build())
                         .sampleSize(123)
                         .shingleSize(123)
                         .build())
                 .build())
         .workspace("workspace")
         // the properties below are optional
         .evaluationIntervalInSeconds(123)
         .labels(List.of(LabelProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .missingDataAction(MissingDataActionProperty.builder()
                 .markAsAnomaly(false)
                 .skip(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-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()
String	getAlias()	The user-friendly name of the anomaly detector.
Object	getConfiguration()	The algorithm configuration of the anomaly detector.
default Number	getEvaluationIntervalInSeconds()	The frequency, in seconds, at which the anomaly detector evaluates metrics.
default Object	getLabels()	The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.
default Object	getMissingDataAction()	The action taken when data is missing during evaluation.
default List<CfnTag>	getTags()	The tags applied to the anomaly detector.
String	getWorkspace()	An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlias

@Stability(Stable)
@NotNull
String getAlias()

The user-friendly name of the anomaly detector.

See Also:

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

getConfiguration

@Stability(Stable)
@NotNull
Object getConfiguration()

The algorithm configuration of the anomaly detector.

Returns union: either IResolvable or CfnAnomalyDetector.AnomalyDetectorConfigurationProperty

See Also:

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

getWorkspace

@Stability(Stable)
@NotNull
String getWorkspace()

An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.

See Also:

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

getEvaluationIntervalInSeconds

@Stability(Stable)
@Nullable
default Number getEvaluationIntervalInSeconds()

The frequency, in seconds, at which the anomaly detector evaluates metrics.

Default: - 60

See Also:

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

getLabels

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

The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.

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

See Also:

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

getMissingDataAction

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

The action taken when data is missing during evaluation.

Returns union: either IResolvable or CfnAnomalyDetector.MissingDataActionProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags applied to the anomaly detector.

See Also:

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

builder

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

Returns:

a CfnAnomalyDetectorProps.Builder of CfnAnomalyDetectorProps