Class: AWSCDK::LookoutMetrics::CfnAnomalyDetector::MetricSetProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lookout_metrics/cfn_anomaly_detector.rb

Overview

Contains information about a dataset.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metric_list:, metric_set_name:, metric_source:, dimension_list: nil, metric_set_description: nil, metric_set_frequency: nil, offset: nil, timestamp_column: nil, timezone: nil) ⇒ MetricSetProperty

Returns a new instance of MetricSetProperty.

Parameters:



905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 905

def initialize(metric_list:, metric_set_name:, metric_source:, dimension_list: nil, metric_set_description: nil, metric_set_frequency: nil, offset: nil, timestamp_column: nil, timezone: nil)
  @metric_list = metric_list
  Jsii::Type.check_type(@metric_list, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbG9va291dG1ldHJpY3MuQ2ZuQW5vbWFseURldGVjdG9yLk1ldHJpY1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "metricList")
  @metric_set_name = metric_set_name
  Jsii::Type.check_type(@metric_set_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricSetName")
  @metric_source = metric_source.is_a?(Hash) ? ::AWSCDK::LookoutMetrics::CfnAnomalyDetector::MetricSourceProperty.new(**metric_source.transform_keys(&:to_sym)) : metric_source
  Jsii::Type.check_type(@metric_source, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sb29rb3V0bWV0cmljcy5DZm5Bbm9tYWx5RGV0ZWN0b3IuTWV0cmljU291cmNlUHJvcGVydHkifV19fQ==")), "metricSource")
  @dimension_list = dimension_list
  Jsii::Type.check_type(@dimension_list, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dimensionList") unless @dimension_list.nil?
  @metric_set_description = metric_set_description
  Jsii::Type.check_type(@metric_set_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricSetDescription") unless @metric_set_description.nil?
  @metric_set_frequency = metric_set_frequency
  Jsii::Type.check_type(@metric_set_frequency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricSetFrequency") unless @metric_set_frequency.nil?
  @offset = offset
  Jsii::Type.check_type(@offset, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "offset") unless @offset.nil?
  @timestamp_column = timestamp_column.is_a?(Hash) ? ::AWSCDK::LookoutMetrics::CfnAnomalyDetector::TimestampColumnProperty.new(**timestamp_column.transform_keys(&:to_sym)) : timestamp_column
  Jsii::Type.check_type(@timestamp_column, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sb29rb3V0bWV0cmljcy5DZm5Bbm9tYWx5RGV0ZWN0b3IuVGltZXN0YW1wQ29sdW1uUHJvcGVydHkifV19fQ==")), "timestampColumn") unless @timestamp_column.nil?
  @timezone = timezone
  Jsii::Type.check_type(@timezone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timezone") unless @timezone.nil?
end

Instance Attribute Details

#dimension_list ⇒ Array<String>? (readonly)

A list of the fields you want to treat as dimensions.

Returns:

  • (Array<String>, nil)

See Also:



945
946
947
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 945

def dimension_list
  @dimension_list
end

#metric_list ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::LookoutMetrics::CfnAnomalyDetector::MetricProperty> (readonly)

A list of metrics that the dataset will contain.

Returns:

See Also:



930
931
932
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 930

def metric_list
  @metric_list
end

#metric_set_description ⇒ String? (readonly)

A description of the dataset you are creating.

Returns:

  • (String, nil)

See Also:



950
951
952
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 950

def metric_set_description
  @metric_set_description
end

#metric_set_frequency ⇒ String? (readonly)

The frequency with which the source data will be analyzed for anomalies.

Returns:

  • (String, nil)

See Also:



955
956
957
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 955

def metric_set_frequency
  @metric_set_frequency
end

#metric_set_name ⇒ String (readonly)

The name of the dataset.

Returns:

  • (String)

See Also:



935
936
937
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 935

def metric_set_name
  @metric_set_name
end

#metric_source ⇒ AWSCDK::IResolvable, AWSCDK::LookoutMetrics::CfnAnomalyDetector::MetricSourceProperty (readonly)

Contains information about how the source data should be interpreted.

Returns:

See Also:



940
941
942
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 940

def metric_source
  @metric_source
end

#offset ⇒ Numeric? (readonly)

After an interval ends, the amount of seconds that the detector waits before importing data.

Offset is only supported for S3, Redshift, Athena and datasources.

Returns:

  • (Numeric, nil)

See Also:



962
963
964
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 962

def offset
  @offset
end

#timestamp_column ⇒ AWSCDK::IResolvable, ... (readonly)

Contains information about the column used for tracking time in your source data.

Returns:

See Also:



967
968
969
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 967

def timestamp_column
  @timestamp_column
end

#timezone ⇒ String? (readonly)

The time zone in which your source data was recorded.

Returns:

  • (String, nil)

See Also:



972
973
974
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 972

def timezone
  @timezone
end

Class Method Details

.jsii_properties ⇒ Object 



974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 974

def self.jsii_properties
  {
    :metric_list => "metricList",
    :metric_set_name => "metricSetName",
    :metric_source => "metricSource",
    :dimension_list => "dimensionList",
    :metric_set_description => "metricSetDescription",
    :metric_set_frequency => "metricSetFrequency",
    :offset => "offset",
    :timestamp_column => "timestampColumn",
    :timezone => "timezone",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 988

def to_jsii
  result = {}
  result.merge!({
    "metricList" => @metric_list,
    "metricSetName" => @metric_set_name,
    "metricSource" => @metric_source,
    "dimensionList" => @dimension_list,
    "metricSetDescription" => @metric_set_description,
    "metricSetFrequency" => @metric_set_frequency,
    "offset" => @offset,
    "timestampColumn" => @timestamp_column,
    "timezone" => @timezone,
  })
  result.compact
end