Class: Aws::ApplicationAutoScaling::Types::TargetTrackingMetricDataQuery

Inherits:

Struct

• Object
• Struct
• Aws::ApplicationAutoScaling::Types::TargetTrackingMetricDataQuery

Includes:

Structure

Defined in:

lib/aws-sdk-applicationautoscaling/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 [Create a target tracking scaling policy for Application Auto Scaling using metric math] in the *Application Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #expression ⇒ String

  The math expression to perform on the returned data, if this object is performing a math expression.

• #id ⇒ String

  A short name that identifies the object’s results in the response.

• #label ⇒ String

  A human-readable label for this metric or expression.

• #metric_stat ⇒ Types::TargetTrackingMetricStat

  Information about the metric data to return.

• #return_data ⇒ Boolean

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

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 ‘TargetTrackingMetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both.

Returns:

• (String)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 3934

class TargetTrackingMetricDataQuery < Struct.new(
  :expression,
  :id,
  :label,
  :metric_stat,
  :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)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 3934

class TargetTrackingMetricDataQuery < Struct.new(
  :expression,
  :id,
  :label,
  :metric_stat,
  :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)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 3934

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

#metric_stat ⇒ Types::TargetTrackingMetricStat

Information about the metric data to return.

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

Returns:

• (Types::TargetTrackingMetricStat)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 3934

class TargetTrackingMetricDataQuery < Struct.new(
  :expression,
  :id,
  :label,
  :metric_stat,
  :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)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 3934

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