You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::AutoScalingPlans::Types::CustomizedLoadMetricSpecification
 Inherits:

Struct
 Object
 Struct
 Aws::AutoScalingPlans::Types::CustomizedLoadMetricSpecification
 Defined in:
 (unknown)
Overview
When passing CustomizedLoadMetricSpecification as input to an Aws::Client method, you can use a vanilla Hash:
{
metric_name: "MetricName", # required
namespace: "MetricNamespace", # required
dimensions: [
{
name: "MetricDimensionName", # required
value: "MetricDimensionValue", # required
},
],
statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
unit: "MetricUnit",
}
Represents a CloudWatch metric of your choosing that can be used for predictive scaling.
For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum
and Average
statistics that CloudWatch computes from metric data. Statistics are calculations used to aggregate data over specified time periods.
When you choose a load metric, make sure that the required Sum
and Average
statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum
statistic must represent the total load on the resource, and the Average
statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum
statistic represents the total request count processed by the group, then the Average
statistic for the specified metric must represent the average request count processed by each instance of the group.
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.
Returned by:
Instance Attribute Summary collapse

#dimensions ⇒ Array<Types::MetricDimension>
The dimensions of the metric.

#metric_name ⇒ String
The name of the metric.

#namespace ⇒ String
The namespace of the metric.

#statistic ⇒ String
The statistic of the metric.

#unit ⇒ String
The unit of the metric.
Instance Attribute Details
#dimensions ⇒ Array<Types::MetricDimension>
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.
#metric_name ⇒ String
The name of the metric.
#namespace ⇒ String
The namespace of the metric.
#statistic ⇒ String
The statistic of the metric. Currently, the value must always be Sum
.
Possible values:
 Average
 Minimum
 Maximum
 SampleCount
 Sum
#unit ⇒ String
The unit of the metric.