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

Inherits:

Struct

• Object
• Struct
• Aws::AutoScaling::Types::CustomizedMetricSpecification

Includes:

Structure

Defined in:

lib/aws-sdk-autoscaling/types.rb

Overview

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 property 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].

<note markdown=“1”> 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*.

</note>

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html [2]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html [3]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dimensions ⇒ Array<Types::MetricDimension>

  The dimensions of the metric.

• #metric_name ⇒ String

  The name of the metric.

• #metrics ⇒ Array<Types::TargetTrackingMetricDataQuery>

  The metrics to include in the target tracking scaling policy, as a metric data query.

• #namespace ⇒ String

  The namespace of the metric.

• #period ⇒ Integer

  The period of the metric in seconds.

• #statistic ⇒ String

  The statistic of the metric.

• #unit ⇒ String

  The unit of the metric.

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:

• (Array<Types::MetricDimension>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1886

class CustomizedMetricSpecification < Struct.new(
  :metric_name,
  :namespace,
  :dimensions,
  :statistic,
  :unit,
  :period,
  :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 is 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)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1886

class CustomizedMetricSpecification < Struct.new(
  :metric_name,
  :namespace,
  :dimensions,
  :statistic,
  :unit,
  :period,
  :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:

• (Array<Types::TargetTrackingMetricDataQuery>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1886

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

#namespace ⇒ String

The namespace of the metric.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1886

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

#period ⇒ Integer

The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see [Create a target tracking policy using high-resolution metrics for faster response].

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1886

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

#statistic ⇒ String

The statistic of the metric.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1886

class CustomizedMetricSpecification < Struct.new(
  :metric_name,
  :namespace,
  :dimensions,
  :statistic,
  :unit,
  :period,
  :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)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1886

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