interface RandomCutForestConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.APS.CfnAnomalyDetector.RandomCutForestConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsaps#CfnAnomalyDetector_RandomCutForestConfigurationProperty`
Java	`software.amazon.awscdk.services.aps.CfnAnomalyDetector.RandomCutForestConfigurationProperty`
Python	`aws_cdk.aws_aps.CfnAnomalyDetector.RandomCutForestConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_aps` » `CfnAnomalyDetector` » `RandomCutForestConfigurationProperty`

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 { aws_aps as aps } from 'aws-cdk-lib';
const randomCutForestConfigurationProperty: aps.CfnAnomalyDetector.RandomCutForestConfigurationProperty = {
  query: 'query',

  // the properties below are optional
  ignoreNearExpectedFromAbove: {
    amount: 123,
    ratio: 123,
  },
  ignoreNearExpectedFromBelow: {
    amount: 123,
    ratio: 123,
  },
  sampleSize: 123,
  shingleSize: 123,
};

Properties

Name	Type	Description
query	`string`	The Prometheus query used to retrieve the time-series data for anomaly detection.
ignoreNearExpectedFromAbove?	`IResolvable` `\|` `IgnoreNearExpectedProperty`	Configuration for ignoring values that are near expected values from above during anomaly detection.
ignoreNearExpectedFromBelow?	`IResolvable` `\|` `IgnoreNearExpectedProperty`	Configuration for ignoring values that are near expected values from below during anomaly detection.
sampleSize?	`number`	The number of data points sampled from the input stream for the Random Cut Forest algorithm.
shingleSize?	`number`	The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm.

query

Type: string

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 .

ignoreNearExpectedFromAbove?

Type: IResolvable | IgnoreNearExpectedProperty (optional)

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

ignoreNearExpectedFromBelow?

Type: IResolvable | IgnoreNearExpectedProperty (optional)

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

sampleSize?

Type: number (optional, default: 256)

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

The default number is 256 consecutive data points.

shingleSize?

Type: number (optional, default: 8)

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.

AWS CDK

2.231.0