You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CustomizedMetricSpecification 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 for a target tracking scaling policy to use with Application Auto Scaling.

For information about the available metrics for a service, see AWS 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 CloudWatch, see Amazon CloudWatch Concepts.

Returned by:

See Also:

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:

#metric_name ⇒ String

The name of the metric.

Returns:

  • (String) —

    The name of the metric.

#namespace ⇒ String

The namespace of the metric.

Returns:

  • (String) —

    The namespace of the metric.

#statistic ⇒ String

The statistic of the metric.

Possible values:

  • Average
  • Minimum
  • Maximum
  • SampleCount
  • Sum

Returns:

  • (String) —

    The statistic of the metric.

#unit ⇒ String

The unit of the metric.

Returns:

  • (String) —

    The unit of the metric.