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

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

Overview

Note:

When making an API call, you may pass MetricDataQuery data as a hash:

{
  id: "XmlStringMaxLen255", # required
  expression: "XmlStringMaxLen1023",
  metric_stat: {
    metric: { # required
      namespace: "MetricNamespace", # required
      metric_name: "MetricName", # required
      dimensions: [
        {
          name: "MetricDimensionName", # required
          value: "MetricDimensionValue", # required
        },
      ],
    },
    stat: "XmlStringMetricStat", # required
    unit: "MetricUnit",
  },
  label: "XmlStringMetricLabel",
  return_data: false,
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#expressionString

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)


5643
5644
5645
5646
5647
5648
5649
5650
5651
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5643

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

#idString

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)


5643
5644
5645
5646
5647
5648
5649
5650
5651
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5643

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

#labelString

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)


5643
5644
5645
5646
5647
5648
5649
5650
5651
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5643

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

#metric_statTypes::MetricStat

Information about the metric data to return.

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

Returns:



5643
5644
5645
5646
5647
5648
5649
5650
5651
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5643

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

#return_dataBoolean

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)


5643
5644
5645
5646
5647
5648
5649
5650
5651
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5643

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