Class: Aws::AutoScaling::Types::MetricStat

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

Overview

This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.

For more information about the CloudWatch terminology below, see

Amazon CloudWatch concepts][1

in the *Amazon CloudWatch User Guide*.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#metric ⇒ Types::Metric

The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric] object that is returned by a call to [ListMetrics].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html [2]: docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html

Returns:



5020
5021
5022
5023
5024
5025
5026
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 5020

class MetricStat < Struct.new(
  :metric,
  :stat,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#stat ⇒ String

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in

Statistics][1

in the *Amazon CloudWatch User Guide*.

The most commonly used metrics for predictive scaling are ‘Average` and `Sum`.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic

Returns:

  • (String) 


5020
5021
5022
5023
5024
5025
5026
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 5020

class MetricStat < Struct.new(
  :metric,
  :stat,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum] data type in the *Amazon CloudWatch API Reference*.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html

Returns:

  • (String) 


5020
5021
5022
5023
5024
5025
5026
 
# File 'lib/aws-sdk-autoscaling/types.rb', line 5020

class MetricStat < Struct.new(
  :metric,
  :stat,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end