Class: Aws::AutoScaling::Types::TargetTrackingMetricStat

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

Overview

This structure defines the CloudWatch metric to return, along with the statistic and unit.

For more information about the CloudWatch terminology below, see

Amazon CloudWatch concepts][1

in the *Amazon CloudWatch User Guide*.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#metricTypes::Metric

The metric to use.

Returns:



7808
7809
7810
7811
7812
7813
7814
7815
# File 'lib/aws-sdk-autoscaling/types.rb', line 7808

class TargetTrackingMetricStat < Struct.new(
  :metric,
  :stat,
  :unit,
  :period)
  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].

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

Returns:

  • (Integer)


7808
7809
7810
7811
7812
7813
7814
7815
# File 'lib/aws-sdk-autoscaling/types.rb', line 7808

class TargetTrackingMetricStat < Struct.new(
  :metric,
  :stat,
  :unit,
  :period)
  SENSITIVE = []
  include Aws::Structure
end

#statString

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in

Statistics][1

in the *Amazon CloudWatch User Guide*.

The most commonly used metric for scaling is ‘Average`.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic

Returns:

  • (String)


7808
7809
7810
7811
7812
7813
7814
7815
# File 'lib/aws-sdk-autoscaling/types.rb', line 7808

class TargetTrackingMetricStat < Struct.new(
  :metric,
  :stat,
  :unit,
  :period)
  SENSITIVE = []
  include Aws::Structure
end

#unitString

The unit to use for the returned data points. 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)


7808
7809
7810
7811
7812
7813
7814
7815
# File 'lib/aws-sdk-autoscaling/types.rb', line 7808

class TargetTrackingMetricStat < Struct.new(
  :metric,
  :stat,
  :unit,
  :period)
  SENSITIVE = []
  include Aws::Structure
end