Package software.amazon.awscdk.services.aps

Interface CfnAnomalyDetector.RandomCutForestConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnomalyDetector.RandomCutForestConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnAnomalyDetector

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

Configuration for the Random Cut Forest algorithm used for anomaly detection in time-series data.

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.*;
 RandomCutForestConfigurationProperty randomCutForestConfigurationProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnomalyDetector.RandomCutForestConfigurationProperty.Builder	builder()
default Object	getIgnoreNearExpectedFromAbove()	Configuration for ignoring values that are near expected values from above during anomaly detection.
default Object	getIgnoreNearExpectedFromBelow()	Configuration for ignoring values that are near expected values from below during anomaly detection.
String	getQuery()	The Prometheus query used to retrieve the time-series data for anomaly detection.
default Number	getSampleSize()	The number of data points sampled from the input stream for the Random Cut Forest algorithm.
default Number	getShingleSize()	The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getQuery

@Stability(Stable)
@NotNull
String getQuery()

The Prometheus query used to retrieve the time-series data for anomaly detection.

Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website.

Supported PromQL aggregation operators : avg , count , group , max , min , quantile , stddev , stdvar , and sum .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html#cfn-aps-anomalydetector-randomcutforestconfiguration-query

getIgnoreNearExpectedFromAbove

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

Configuration for ignoring values that are near expected values from above during anomaly detection.

Returns union: either IResolvable or CfnAnomalyDetector.IgnoreNearExpectedProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html#cfn-aps-anomalydetector-randomcutforestconfiguration-ignorenearexpectedfromabove

getIgnoreNearExpectedFromBelow

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

Configuration for ignoring values that are near expected values from below during anomaly detection.

Returns union: either IResolvable or CfnAnomalyDetector.IgnoreNearExpectedProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html#cfn-aps-anomalydetector-randomcutforestconfiguration-ignorenearexpectedfrombelow

getSampleSize

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

The number of data points sampled from the input stream for the Random Cut Forest algorithm.

The default number is 256 consecutive data points.

Default: - 256

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html#cfn-aps-anomalydetector-randomcutforestconfiguration-samplesize

getShingleSize

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

The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm.

The default number is 8 consecutive data points.

Default: - 8

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html#cfn-aps-anomalydetector-randomcutforestconfiguration-shinglesize

builder

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

Returns:

a CfnAnomalyDetector.RandomCutForestConfigurationProperty.Builder of CfnAnomalyDetector.RandomCutForestConfigurationProperty