class Amazonite::CloudWatch::AnomalyDetector

Overview

An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You can use the model to display a band of expected, normal values when the metric is graphed.

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.

Included Modules

Defined in:

cloudwatch/anomaly_detector.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(anomaly_detector_id : String | Nil = nil, namespace : String | Nil = nil, metric_name : String | Nil = nil, dimensions : Array(Dimension) | Nil = nil, stat : String | Nil = nil, configuration : AnomalyDetectorConfiguration | Nil = nil, state_value : AnomalyDetectorStateValue | Nil = nil, metric_characteristics : MetricCharacteristics | Nil = nil, single_metric_anomaly_detector : SingleMetricAnomalyDetector | Nil = nil, metric_math_anomaly_detector : MetricMathAnomalyDetector | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def anomaly_detector_id : String | Nil #

The unique identifier of the anomaly detector.

The identifier does not restrict access to a specific anomaly detector in an IAM policy. Permissions for anomaly detector operations apply to all anomaly detectors in the account.


[View source]
def anomaly_detector_id=(anomaly_detector_id : String | Nil) #

The unique identifier of the anomaly detector.

The identifier does not restrict access to a specific anomaly detector in an IAM policy. Permissions for anomaly detector operations apply to all anomaly detectors in the account.


[View source]
def configuration : AnomalyDetectorConfiguration | Nil #

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.


[View source]
def configuration=(configuration : AnomalyDetectorConfiguration | Nil) #

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.


[View source]
def dimensions : Array(Dimension) | Nil #

The metric dimensions associated with the anomaly detection model.


[View source]
def dimensions=(dimensions : Array(Dimension) | Nil) #

The metric dimensions associated with the anomaly detection model.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def metric_characteristics : MetricCharacteristics | Nil #

This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.


[View source]
def metric_characteristics=(metric_characteristics : MetricCharacteristics | Nil) #

This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.


[View source]
def metric_math_anomaly_detector : MetricMathAnomalyDetector | Nil #

The CloudWatch metric math expression for this anomaly detector.


[View source]
def metric_math_anomaly_detector=(metric_math_anomaly_detector : MetricMathAnomalyDetector | Nil) #

The CloudWatch metric math expression for this anomaly detector.


[View source]
def metric_name : String | Nil #

The name of the metric associated with the anomaly detection model.


[View source]
def metric_name=(metric_name : String | Nil) #

The name of the metric associated with the anomaly detection model.


[View source]
def namespace : String | Nil #

The namespace of the metric associated with the anomaly detection model.


[View source]
def namespace=(namespace : String | Nil) #

The namespace of the metric associated with the anomaly detection model.


[View source]
def single_metric_anomaly_detector : SingleMetricAnomalyDetector | Nil #

The CloudWatch metric and statistic for this anomaly detector.


[View source]
def single_metric_anomaly_detector=(single_metric_anomaly_detector : SingleMetricAnomalyDetector | Nil) #

The CloudWatch metric and statistic for this anomaly detector.


[View source]
def stat : String | Nil #

The statistic associated with the anomaly detection model.


[View source]
def stat=(stat : String | Nil) #

The statistic associated with the anomaly detection model.


[View source]
def state_value : AnomalyDetectorStateValue | Nil #

The current status of the anomaly detector's training.


[View source]
def state_value=(state_value : AnomalyDetectorStateValue | Nil) #

The current status of the anomaly detector's training.


[View source]
def validate! : Nil #

[View source]