Class: Aws::CloudWatch::Types::AnomalyDetectorConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#adaptation_speed ⇒ String

The speed at which the anomaly detection model adapts to sustained changes in the metric's baseline. Faster adaptation lets the model track shifting workloads sooner, but increases the chance that the model treats a real, lasting change as normal.

Valid values:

  • FAST - The model adapts quickly to sustained changes in the baseline.

  • NORMAL - The model adapts at a moderate pace. This is the default value.

  • SLOW - The model adapts slowly, reducing the risk of treating a real change as normal.

Returns:

  • (String) 

379
380
381
382
383
384
385
386
 
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 379

class AnomalyDetectorConfiguration < Struct.new(
  :excluded_time_ranges,
  :metric_timezone,
  :adaptation_speed,
  :outlier_filtering_strength)
  SENSITIVE = []
  include Aws::Structure
end

#excluded_time_ranges ⇒ Array<Types::Range>

An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates the model.

Returns:


379
380
381
382
383
384
385
386
 
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 379

class AnomalyDetectorConfiguration < Struct.new(
  :excluded_time_ranges,
  :metric_timezone,
  :adaptation_speed,
  :outlier_filtering_strength)
  SENSITIVE = []
  include Aws::Structure
end

#metric_timezone ⇒ String

The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database.

Returns:

  • (String) 

379
380
381
382
383
384
385
386
 
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 379

class AnomalyDetectorConfiguration < Struct.new(
  :excluded_time_ranges,
  :metric_timezone,
  :adaptation_speed,
  :outlier_filtering_strength)
  SENSITIVE = []
  include Aws::Structure
end

#outlier_filtering_strength ⇒ String

The aggressiveness with which CloudWatch filters outliers from the metric data that the anomaly detection model uses. Stronger filtering excludes more extreme values, which can produce a tighter band of expected values but may also suppress legitimate spikes.

Valid values:

  • MINIMAL - Excludes only the most extreme outliers.

  • MODERATE - Excludes a moderate range of outliers. This is the default value.

  • STRICT - Excludes a wider range of outliers, which can suppress legitimate spikes.

Returns:

  • (String) 

379
380
381
382
383
384
385
386
 
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 379

class AnomalyDetectorConfiguration < Struct.new(
  :excluded_time_ranges,
  :metric_timezone,
  :adaptation_speed,
  :outlier_filtering_strength)
  SENSITIVE = []
  include Aws::Structure
end