Class: Aws::AutoScaling::Types::MetricDataQuery

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-autoscaling/types.rb

Overview

The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.

For more information and examples, see [Advanced predictive scaling policy configurations using custom metrics] in the *Amazon EC2 Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#expression ⇒ String

The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the ‘Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions.

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

Returns:

  • (String) 


5041
5042
5043
5044
5045
5046
5047
5048
5049
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 5041

class MetricDataQuery < Struct.new(
  :id,
  :expression,
  :metric_stat,
  :label,
  :return_data)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

A short name that identifies the object’s results in the response. This name must be unique among all ‘MetricDataQuery` objects specified for a single scaling policy. 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 underscores. The first character must be a lowercase letter.

Returns:

  • (String) 


5041
5042
5043
5044
5045
5046
5047
5048
5049
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 5041

class MetricDataQuery < Struct.new(
  :id,
  :expression,
  :metric_stat,
  :label,
  :return_data)
  SENSITIVE = []
  include Aws::Structure
end

#label ⇒ String

A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.

Returns:

  • (String) 


5041
5042
5043
5044
5045
5046
5047
5048
5049
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 5041

class MetricDataQuery < Struct.new(
  :id,
  :expression,
  :metric_stat,
  :label,
  :return_data)
  SENSITIVE = []
  include Aws::Structure
end

#metric_stat ⇒ Types::MetricStat

Information about the metric data to return.

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

Returns:



5041
5042
5043
5044
5045
5046
5047
5048
5049
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 5041

class MetricDataQuery < Struct.new(
  :id,
  :expression,
  :metric_stat,
  :label,
  :return_data)
  SENSITIVE = []
  include Aws::Structure
end

#return_data ⇒ Boolean

Indicates whether to return the timestamps and raw data values of this metric.

If you use any math expressions, specify ‘true` for this value for only the final math expression that the metric specification is based on. You must specify `false` for `ReturnData` for all the other metrics and expressions used in the metric specification.

If you are only retrieving metrics and not performing any math expressions, do not specify anything for ‘ReturnData`. This sets it to its default (`true`).

Returns:

  • (Boolean) 


5041
5042
5043
5044
5045
5046
5047
5048
5049
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 5041

class MetricDataQuery < Struct.new(
  :id,
  :expression,
  :metric_stat,
  :label,
  :return_data)
  SENSITIVE = []
  include Aws::Structure
end