Class: AWSCDK::CloudWatch::CfnAnomalyDetector::MetricCharacteristicsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::CloudWatch::CfnAnomalyDetector::MetricCharacteristicsProperty

Defined in:

cloud_watch/cfn_anomaly_detector.rb

Overview

This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.

See Also:

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

Instance Attribute Summary

• #periodic_spikes ⇒ Boolean, ... readonly

  Set this parameter to true if values for this metric consistently include spikes that should not be considered to be anomalies.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(periodic_spikes: nil) ⇒ MetricCharacteristicsProperty constructor

  A new instance of MetricCharacteristicsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(periodic_spikes: nil) ⇒ MetricCharacteristicsProperty

Returns a new instance of MetricCharacteristicsProperty.

Parameters:

• periodic_spikes (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  Set this parameter to true if values for this metric consistently include spikes that should not be considered to be anomalies.

# File 'cloud_watch/cfn_anomaly_detector.rb', line 697

def initialize(periodic_spikes: nil)
  @periodic_spikes = periodic_spikes
  Jsii::Type.check_type(@periodic_spikes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "periodicSpikes") unless @periodic_spikes.nil?
end

Instance Attribute Details

#periodic_spikes ⇒ Boolean, ... (readonly)

Set this parameter to true if values for this metric consistently include spikes that should not be considered to be anomalies.

With this set to true, CloudWatch will expect to see spikes that occurred consistently during the model training period, and won't flag future similar spikes as anomalies.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metriccharacteristics.html#cfn-cloudwatch-anomalydetector-metriccharacteristics-periodicspikes

# File 'cloud_watch/cfn_anomaly_detector.rb', line 708

def periodic_spikes
  @periodic_spikes
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cloud_watch/cfn_anomaly_detector.rb', line 710

def self.jsii_properties
  {
    :periodic_spikes => "periodicSpikes",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cloud_watch/cfn_anomaly_detector.rb', line 716

def to_jsii
  result = {}
  result.merge!({
    "periodicSpikes" => @periodic_spikes,
  })
  result.compact
end