CfnAnomalyDetectorProps

class aws_cdk.aws_aps.CfnAnomalyDetectorProps(*, alias, configuration, workspace, evaluation_interval_in_seconds=None, labels=None, missing_data_action=None, tags=None)

Bases: object

Properties for defining a CfnAnomalyDetector.

Parameters:

alias (str) – The user-friendly name of the anomaly detector.
configuration (Union[IResolvable, AnomalyDetectorConfigurationProperty, Dict[str, Any]]) – The algorithm configuration of the anomaly detector.
workspace (str) – An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.
evaluation_interval_in_seconds (Union[int, float, None]) – The frequency, in seconds, at which the anomaly detector evaluates metrics. Default: - 60
labels (Union[IResolvable, Sequence[Union[IResolvable, LabelProperty, Dict[str, Any]]], None]) – The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.
missing_data_action (Union[IResolvable, MissingDataActionProperty, Dict[str, Any], None]) – The action taken when data is missing during evaluation.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags applied to the anomaly detector.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_aps as aps

cfn_anomaly_detector_props = aps.CfnAnomalyDetectorProps(
    alias="alias",
    configuration=aps.CfnAnomalyDetector.AnomalyDetectorConfigurationProperty(
        random_cut_forest=aps.CfnAnomalyDetector.RandomCutForestConfigurationProperty(
            query="query",

            # the properties below are optional
            ignore_near_expected_from_above=aps.CfnAnomalyDetector.IgnoreNearExpectedProperty(
                amount=123,
                ratio=123
            ),
            ignore_near_expected_from_below=aps.CfnAnomalyDetector.IgnoreNearExpectedProperty(
                amount=123,
                ratio=123
            ),
            sample_size=123,
            shingle_size=123
        )
    ),
    workspace="workspace",

    # the properties below are optional
    evaluation_interval_in_seconds=123,
    labels=[aps.CfnAnomalyDetector.LabelProperty(
        key="key",
        value="value"
    )],
    missing_data_action=aps.CfnAnomalyDetector.MissingDataActionProperty(
        mark_as_anomaly=False,
        skip=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

alias

The user-friendly name of the anomaly detector.

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

configuration

The algorithm configuration of the anomaly detector.

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

evaluation_interval_in_seconds

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

Default:

60

See:

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

labels

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

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

missing_data_action

The action taken when data is missing during evaluation.

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

tags

The tags applied to the anomaly detector.

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

workspace

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-anomalydetector.html#cfn-aps-anomalydetector-workspace