Class: Aws::AutoScalingPlans::Types::CustomizedScalingMetricSpecification

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 dynamic scaling as part of a target tracking scaling policy.

To create your customized scaling metric specification:

  • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see [Publish Custom Metrics] in the *Amazon CloudWatch User Guide*.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

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

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

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 scaling metric specification.

Returns:



222
223
224
225
226
227
228
229
230
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 222

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

#metric_name ⇒ String

The name of the metric.

Returns:

  • (String) 


222
223
224
225
226
227
228
229
230
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 222

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

#namespace ⇒ String

The namespace of the metric.

Returns:

  • (String) 


222
223
224
225
226
227
228
229
230
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 222

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

#statistic ⇒ String

The statistic of the metric.

Returns:

  • (String) 


222
223
224
225
226
227
228
229
230
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 222

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

#unit ⇒ String

The unit of the metric.

Returns:

  • (String) 


222
223
224
225
226
227
228
229
230
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 222

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