Class: Aws::AutoScalingPlans::Types::CustomizedLoadMetricSpecification

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

Overview

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.

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.

If you publish your own metrics, you can aggregate the data points at a given interval and then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up all the metric data points that occurred within each hour to match the granularity period that is used in the forecast (60 minutes).

For information about terminology, available metrics, or how to publish new metrics, see [Amazon CloudWatch Concepts] in the *Amazon CloudWatch User Guide*.

After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see [View Scaling Information for a Resource] in the *AWS Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html [2]: docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:



161
162
163
164
165
166
167
168
169
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 161

class CustomizedLoadMetricSpecification < Struct.new(
  :metric_name,
  :namespace,
  :dimensions,
  :statistic,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The name of the metric.

Returns:

  • (String) 


161
162
163
164
165
166
167
168
169
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 161

class CustomizedLoadMetricSpecification < Struct.new(
  :metric_name,
  :namespace,
  :dimensions,
  :statistic,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace of the metric.

Returns:

  • (String) 


161
162
163
164
165
166
167
168
169
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 161

class CustomizedLoadMetricSpecification < Struct.new(
  :metric_name,
  :namespace,
  :dimensions,
  :statistic,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#statistic ⇒ String

The statistic of the metric. The only valid value is ‘Sum`.

Returns:

  • (String) 


161
162
163
164
165
166
167
168
169
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 161

class CustomizedLoadMetricSpecification < Struct.new(
  :metric_name,
  :namespace,
  :dimensions,
  :statistic,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

The unit of the metric.

Returns:

  • (String) 


161
162
163
164
165
166
167
168
169
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 161

class CustomizedLoadMetricSpecification < Struct.new(
  :metric_name,
  :namespace,
  :dimensions,
  :statistic,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end