Class: Aws::AutoScaling::Types::CustomizedMetricSpecification

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass CustomizedMetricSpecification data as a 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 Amazon EC2 Auto Scaling.

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.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts.

Each individual service provides information about the metrics, namespace, and dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dimensionsArray<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:



1916
1917
1918
1919
1920
1921
1922
1923
1924
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1916

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

#metric_nameString

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

Returns:

  • (String)


1916
1917
1918
1919
1920
1921
1922
1923
1924
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1916

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

#namespaceString

The namespace of the metric.

Returns:

  • (String)


1916
1917
1918
1919
1920
1921
1922
1923
1924
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1916

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

#statisticString

The statistic of the metric.

Returns:

  • (String)


1916
1917
1918
1919
1920
1921
1922
1923
1924
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1916

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

#unitString

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.

Returns:

  • (String)


1916
1917
1918
1919
1920
1921
1922
1923
1924
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1916

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