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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/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.

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:



1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-autoscaling/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_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)


1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-autoscaling/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

#metricsArray<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.



1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-autoscaling/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

#namespaceString

The namespace of the metric.

Returns:

  • (String)


1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-autoscaling/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

#periodInteger

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.

Returns:

  • (Integer)


1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-autoscaling/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

#statisticString

The statistic of the metric.

Returns:

  • (String)


1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-autoscaling/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

#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)


1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-autoscaling/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