Class: Aws::ApplicationAutoScaling::Types::CustomizedMetricSpecification

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

Overview

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.

For information about the available metrics for a service, see [Amazon Web Services services that publish CloudWatch metrics] in the *Amazon CloudWatch User Guide*.

To create your customized 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, and increase when capacity decreases.

For more information about the CloudWatch terminology below, see

Amazon CloudWatch concepts][3

in the *Amazon CloudWatch User Guide*.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html [2]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html [3]: 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 scaling policy.

Returns:



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 121

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

#metric_name ⇒ String

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metric] object that’s 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:

  • (String) 


121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 121

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

#metrics ⇒ Array<Types::TargetTrackingMetricDataQuery>

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Returns:



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 121

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

#namespace ⇒ String

The namespace of the metric.

Returns:

  • (String) 


121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 121

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

#statistic ⇒ String

The statistic of the metric.

Returns:

  • (String) 


121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 121

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

#unit ⇒ String

The unit of the metric. 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) 


121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 121

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