Class: AWSCDK::CloudWatch::CfnAnomalyDetector::MetricDataQueryProperty

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

Overview

This structure is used in both GetMetricData and PutMetricAlarm .

The supported use of this structure is different for those two operations.

When used in GetMetricData , it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData call can include up to 500 MetricDataQuery structures.

When used in PutMetricAlarm , it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have true as the value for ReturnData . The result of this expression is the value the alarm watches.

Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, account_id: nil, expression: nil, label: nil, metric_stat: nil, period: nil, return_data: nil) ⇒ MetricDataQueryProperty

Returns a new instance of MetricDataQueryProperty.

Parameters:

  • id (String) —

    A short name used to tie this object to the results in the response.

  • account_id (String, nil) (defaults to: nil) —

    The ID of the account where the metrics are located.

  • expression (String, nil) (defaults to: nil) —

    This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data.

  • label (String, nil) (defaults to: nil) —

    A human-readable label for this metric or expression.

  • metric_stat (AWSCDK::IResolvable, AWSCDK::CloudWatch::CfnAnomalyDetector::MetricStatProperty, nil) (defaults to: nil) —

    The metric to be returned, along with statistics, period, and units.

  • period (Numeric, nil) (defaults to: nil) —

    The granularity, in seconds, of the returned data points.

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

    When used in GetMetricData , this option indicates whether to return the timestamps and raw data values of this metric.



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 
# File 'cloud_watch/cfn_anomaly_detector.rb', line 748

def initialize(id:, account_id: nil, expression: nil, label: nil, metric_stat: nil, period: nil, return_data: nil)
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  @account_id = 
  Jsii::Type.check_type(@account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accountId") unless @account_id.nil?
  @expression = expression
  Jsii::Type.check_type(@expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "expression") unless @expression.nil?
  @label = label
  Jsii::Type.check_type(@label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "label") unless @label.nil?
  @metric_stat = metric_stat.is_a?(Hash) ? ::AWSCDK::CloudWatch::CfnAnomalyDetector::MetricStatProperty.new(**metric_stat.transform_keys(&:to_sym)) : metric_stat
  Jsii::Type.check_type(@metric_stat, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZHdhdGNoLkNmbkFub21hbHlEZXRlY3Rvci5NZXRyaWNTdGF0UHJvcGVydHkifV19fQ==")), "metricStat") unless @metric_stat.nil?
  @period = period
  Jsii::Type.check_type(@period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "period") unless @period.nil?
  @return_data = return_data
  Jsii::Type.check_type(@return_data, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "returnData") unless @return_data.nil?
end

Instance Attribute Details

#account_id ⇒ String? (readonly)

The ID of the account where the metrics are located.

If you are performing a GetMetricData operation in a monitoring account, use this to specify which account to retrieve this metric from.

If you are performing a PutMetricAlarm operation, use this to specify which account contains the metric that the alarm is watching.

Returns:

  • (String, nil)

See Also:



780
781
782
 
# File 'cloud_watch/cfn_anomaly_detector.rb', line 780

def 
  @account_id
end

#expression ⇒ String? (readonly)

This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data.

For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .

A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .

Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

Returns:

  • (String, nil)

See Also:



791
792
793
 
# File 'cloud_watch/cfn_anomaly_detector.rb', line 791

def expression
  @expression
end

#id ⇒ String (readonly)

A short name used to tie this object to the results in the response.

This name must be unique within a single call to GetMetricData . If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

Returns:

  • (String)

See Also:



771
772
773
 
# File 'cloud_watch/cfn_anomaly_detector.rb', line 771

def id
  @id
end

#label ⇒ String? (readonly)

A human-readable label for this metric or expression.

This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels .

Returns:

  • (String, nil)

See Also:



800
801
802
 
# File 'cloud_watch/cfn_anomaly_detector.rb', line 800

def label
  @label
end

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

The metric to be returned, along with statistics, period, and units.

Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

Returns:

See Also:



809
810
811
 
# File 'cloud_watch/cfn_anomaly_detector.rb', line 809

def metric_stat
  @metric_stat
end

#period ⇒ Numeric? (readonly)

The granularity, in seconds, of the returned data points.

For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second .

Returns:

  • (Numeric, nil)

See Also:



816
817
818
 
# File 'cloud_watch/cfn_anomaly_detector.rb', line 816

def period
  @period
end

#return_data ⇒ Boolean, ... (readonly)

When used in GetMetricData , this option indicates whether to return the timestamps and raw data values of this metric.

If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify false . If you omit this, the default of true is used.

When used in PutMetricAlarm , specify true for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

Returns:

See Also:



825
826
827
 
# File 'cloud_watch/cfn_anomaly_detector.rb', line 825

def return_data
  @return_data
end

Class Method Details

.jsii_properties ⇒ Object 



827
828
829
830
831
832
833
834
835
836
837
 
# File 'cloud_watch/cfn_anomaly_detector.rb', line 827

def self.jsii_properties
  {
    :id => "id",
    :account_id => "accountId",
    :expression => "expression",
    :label => "label",
    :metric_stat => "metricStat",
    :period => "period",
    :return_data => "returnData",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'cloud_watch/cfn_anomaly_detector.rb', line 839

def to_jsii
  result = {}
  result.merge!({
    "id" => @id,
    "accountId" => @account_id,
    "expression" => @expression,
    "label" => @label,
    "metricStat" => @metric_stat,
    "period" => @period,
    "returnData" => @return_data,
  })
  result.compact
end