Class: Aws::AutoScaling::Types::MetricStat
- Inherits:
-
Struct
- Object
- Struct
- Aws::AutoScaling::Types::MetricStat
- Defined in:
- gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb
Overview
When making an API call, you may pass MetricStat data as a hash:
{
metric: { # required
namespace: "MetricNamespace", # required
metric_name: "MetricName", # required
dimensions: [
{
name: "MetricDimensionName", # required
value: "MetricDimensionValue", # required
},
],
},
stat: "XmlStringMetricStat", # required
unit: "MetricUnit",
}
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 in the Amazon CloudWatch User Guide.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#metric ⇒ Types::Metric
The CloudWatch metric to return, including the metric name, namespace, and dimensions.
-
#stat ⇒ String
The statistic to return.
-
#unit ⇒ String
The unit to use for the returned data points.
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.
5719 5720 5721 5722 5723 5724 5725 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5719 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 in the Amazon CloudWatch User Guide.
The most commonly used metrics for predictive scaling are Average
and Sum
.
5719 5720 5721 5722 5723 5724 5725 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5719 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.
5719 5720 5721 5722 5723 5724 5725 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5719 class MetricStat < Struct.new( :metric, :stat, :unit) SENSITIVE = [] include Aws::Structure end |