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

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

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

Overview

Note:

When making an API call, you may pass CustomizedScalingMetricSpecification 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 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 more information about CloudWatch, see Amazon CloudWatch Concepts.

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

Returns:



309
310
311
312
313
314
315
316
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 309

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

#metric_nameString

The name of the metric.

Returns:

  • (String)


309
310
311
312
313
314
315
316
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 309

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

#namespaceString

The namespace of the metric.

Returns:

  • (String)


309
310
311
312
313
314
315
316
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 309

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

#statisticString

The statistic of the metric.

Returns:

  • (String)


309
310
311
312
313
314
315
316
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 309

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

#unitString

The unit of the metric.

Returns:

  • (String)


309
310
311
312
313
314
315
316
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 309

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